jpksj-api

国土数値情報のウェブサイトを機械判読するための静的ファイル API

概要: このAPIは、国土交通省の国土数値情報（JPKSJ）データセットにアクセスするためのJSON形式のAPIを提供します。 データセット一覧の取得から、個別のデータセット詳細、バージョン別の詳細情報まで、段階的にアクセスできます。

⚠️ 実験的サービスに関する重要な注意事項

このAPIは実験的なサービスです。データの正確性は保証されておらず、予告なく仕様が変更される可能性があります。 本番環境のアプリケーションで使用する場合は、十分な検証とテストを行い、適切なエラーハンドリングを実装してください。 重要なシステムでは、公式の国土数値情報ダウンロードサービスから直接データを取得することを強く推奨します。

API エンドポイント

データセット一覧

GET /datasets.json

利用可能な全データセットの一覧を取得します。

実際のデータを見る

レスポンス例:

[
  {
    "name": "人間に表示するための名前",
    "description": "内容",
    "id": "N03",
    "source_url": "https://nlftp.mlit.go.jp/ksj/gml/datalist/KsjTmplt-N03-2025.html"
  }
]

データセット詳細

GET /datasets/{id}.json

指定したデータセットの詳細情報とバージョン一覧を取得します。

サンプルデータを見る: N03 (行政区域) A03 (三大都市圏) A09 (都市地域)

パラメータ:

レスポンス例:

{
  "name": "人間に表示するための名前",
  "description": "内容",
  "id": "N03",
  "versions": [
    {
      "id": "2025",
      "start_year": 2025,
      "end_year": 2025
    }
  ]
}

データセットバージョン詳細

GET /datasets/{id}/{version_id}.json

指定したデータセットの特定バージョンの詳細情報、属性、ファイル一覧を取得します。

サンプルデータを見る: N03/2025 A03/2003 A09/2011

パラメータ:

レスポンス例:

{
  "name": "人間に表示するための名前",
  "description": "内容",
  "id": "N03",
  "id_with_version": "N03-2025",
  "start_year": 2025,
  "end_year": 2025,
  "variants": [
    {
      "variant_name": "human-readable name or label",
      "variant_identifier": "name or label for machine identification",
      "shapefile_hint": "xyz.shp",
      "attributes": [
        {
          "readable_name": "都道府県名",
          "attribute_name": "N03_001",
          "description": "当該区域を含む都道府県名称",
          "type": "CharacterString",
          "type_ref_url": "..."
        }
      ]
    }
  ],
  "files": [
    {
      "area": "全国",
      "bytes": 1000,
      "year": 2025,
      "file_url": "https://example.com/data/N03-2025.zip"
    }
  ]
}

使用方法

  1. データセット一覧の取得: /datasets.json から利用可能なデータセットを確認
  2. データセット詳細の取得: /datasets/{id}.json でバージョン情報を確認
  3. 詳細情報の取得: /datasets/{id}/{version_id}.json で属性やファイル情報を取得

関連リンク

こちらのAPIは KotobaMedia 株式会社によって作成されたものです。お問い合わせはこちらでお願いします。