ドキュメント

Nihonbase — Japan Data APIの統合方法を学ぶ

クイックスタート

Nihonbase — Japan Data API を数分で始められます。

1
アカウントを作成

無料アカウントに登録して API キーを取得します。クレジットカードは不要です。

無料で登録 →
2
API キーを取得

ダッシュボードから API キーを発行します。秘密にし、安全に保管してください。

3
最初のリクエストを送る

API キーでリクエストを認証し、データの取得を開始します。

ベース URL

https://api.nihonbase.com/api/v1

OpenAPI 仕様

認証

すべての API リクエストは API キーによる認証が必要です。X-API-Key ヘッダーにキーを含めてください:

APIキーを非公開に保つため、ブラウザのJavaScriptからではなく、サーバーからAPIを呼び出してください。

X-API-Key: YOUR_API_KEY

代わりに Authorization: Bearer YOUR_API_KEY も使えます(YOUR_API_KEY は jda_… のキーであり、セッショントークンではありません)。

レート制限と料金

上限はAPIキーごとではなく、アカウント単位です。日次枠または毎分の制限を超えると HTTP 429 が返されます。

プラン料金リクエスト/日リクエスト/分
Free月額0円10010
Basic月額1,700円5,00060
Business月額4,900円50,000300

GET /health と GET /plans は枠を消費せず、APIキーも不要です。

API エンドポイント

利用できるエンドポイントを確認できます。

地域
GET
/regions

すべての地域を一覧(id, name, slug)。クエリパラメータなし。

都道府県
GET
/prefectures

ページネーション付き一覧。Params: page, limit(既定 50、最大 200)、region(slug、例: kanto)

GET
/prefectures/{id}

都道府県を地域付きで取得

GET
/prefectures/{id}/cities

都道府県内の市区町村。Params: page, limit(最大 200)

市区町村
GET
/cities

ページネーション付き一覧。Params: page, limit(最大 200)、prefecture(id またはローマ字名)

GET
/cities/{id}

市区町村を都道府県・地域付きで取得

祝日
GET
/holidays

ページネーション付き一覧。Params: page, limit(最大 366)、year

GET
/holidays/{year}

指定年の祝日すべて(1955–2027)

和暦
GET
/era?date=YYYY-MM-DD

西暦の日付を和暦に変換(1868–2100)

GET
/era?year=YYYY

西暦の年を和暦に変換(1868–2100)

GET
/era/{year}

西暦年の和暦(1月1日、Asia/Tokyo)

ユーティリティ
GET
/health

ヘルスチェック(API キー不要)

GET
/plans

料金プラン一覧(API キー不要)

コード例

よく使われるプログラミング言語の例です。

curl -X GET "https://api.nihonbase.com/api/v1/prefectures" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Accept: application/json"

レスポンス形式

すべてのレスポンスは、次の一貫した JSON 構造に従います:

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Hokkaido",
      "name_ja": "北海道",
      "name_en": "Hokkaido",
      "slug": "hokkaido",
      "iso_code": "JP-01",
      "region_id": 1,
      "capital": "Sapporo",
      "area_km2": 83424,
      "population": 5224614
    },
    {
      "id": 2,
      "name": "Aomori",
      "name_ja": "青森県",
      "name_en": "Aomori",
      "slug": "aomori",
      "iso_code": "JP-02",
      "region_id": 2,
      "capital": "Aomori",
      "area_km2": 9645,
      "population": 1237984
    }
  ],
  "meta": {
    "page": 1,
    "limit": 50,
    "total": 47
  },
  "error": null
}

和暦変換

GET /era?date=2026-03-01 は西暦の日付(または ?year=YYYY)を和暦に変換します。元号の1年目は label_ja で元年となります。

{
  "success": true,
  "data": {
    "gregorian_year": 2026,
    "reference_date": "2026-03-01",
    "era": {
      "slug": "reiwa",
      "name_en": "Reiwa",
      "name_ja": "令和",
      "year": 8,
      "gannen": false,
      "label_en": "Reiwa 8",
      "label_ja": "令和8年"
    }
  },
  "meta": [],
  "error": null
}

エラー処理

エラー時、API は次の構造のエラーレスポンスを返します:

{
  "success": false,
  "data": null,
  "meta": {},
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "The requested resource was not found."
  }
}

よくあるエラーコード

コードHTTP ステータス説明
API_KEY_REQUIRED401API キーがない、または無効です
RESOURCE_NOT_FOUND404リソースが見つかりません
VALIDATION_ERROR422リクエストパラメータが無効です
INVALID_ERA_INPUT422和暦変換の日付または年が無効です
—429リクエストが多すぎます(日次枠または毎分のレート制限)