API 一覧

Okinawa Open Data PlatformではデータカタログサイトのプラットフォームとしてCKANベースで構築されたBODIKを利用しています。

CKAN APIを利用してデータセットのメタデータへWeb API経由でアクセス可能です。
https://docs.ckan.org/en/latest/api/index.html

CKANでは時刻はすべてUTC(協定世界時)で登録されています。
Web APIで取得した日時もUTCです。日本で利用する場合はJST(+9:00)に変換してご利用ください。
WebサイトではJSTで表示するようにしていますので、Webサイトの表示とAPIで取得した日時が異なりますのでご注意ください。

 

BODIK APIエンドポイント
https://data.bodik.jp/api/3/action

GET /package_search パラメータを指定してデータセット一覧を取得
キーワードまたは自治体コードを指定してデータセット一覧を取得します。

※CKANでは１つのデータセットに複数のリソース（ファイル）が登録できるようになっています。
例）https://data.bodik.jp/dataset/402036_0000200_00031/
データセットを検索する場合は「package_search」、リソースを検索する場合は「resource_search」を利用します。

リクエストボディ

q ( String )
organization:402036
q ( String )
キーワード
rows ( Integer )
取得するデータセット数を指定する。
sort ( String )
データセット一覧のソート順を指定する。 フィールド名称とソート順（「asc」または「desc」）を半角スペース区切リで設定。 半角スペースは「%20」にURLエンコードを行う。

レスポンスの例

{
    help : "https://data.bodik.jp/api/3/action/help_show?name=package_search",
    success : true,
    result : {
        count : 26,
        sort : "score desc, metadata_modified desc",
        facets : {},
        results : […],
        search_facets : {},
    }
}
GET /package_list データセット一覧を取得します。
全てのデータセット一覧を取得します。

レスポンスの例

{
    help : "https://data.bodik.jp/ap…p_show?name=package_list",
    success : true,
    result : [
        "050008_", "050008_bousai_001", "050008_bousai_002"... 
    ]
}
GET /organization_list 自治体の一覧を取得します。
自治体の一覧を取得します

レスポンスの例

{
    "help": "https://data.bodik.jp/api/3/action/help_show?name=organization_list", 
    "success": true, 
    "result": [
        "402257", "452092", "406252",...
    ]
}