本サイト(BODIK ODCS)は、地方自治体のオープンガバメントデータを提供するプラットフォームです。
BODIK ODCSの概要はこちらを参照下さい。
Web APIについて
BODIK ODCSではデータカタログサイトのプラットフォームとしてCKANを利用しています。
CKAN API
CKAN APIを利用してデータセットのメタデータへWeb API経由でアクセス可能です。
http://docs.ckan.org/en/latest/api/index.html
BODIK ODCSのCKAN Site URLはhttps://data.bodik.jp/となります。
上記CKAN APIのマニュアルでは、demo.ckan.orgの部分をdata.bodik.jpに置き換えてご利用ください。
DataStore API
CSVやXLSといった表形式のデータについては、ファイルの中身にアクセス可能になっています。
https://docs.ckan.org/en/2.9/maintaining/datastore.html#the-datastore-api
CKAN APIの使用例
データセット一覧を取得します。
http://data.bodik.jp/api/3/action/package_list
自治体の一覧を取得します。
http://data.bodik.jp/api/3/action/organization_list
久留米市のデータセット一覧を取得します。
http://data.bodik.jp/api/3/action/package_search?q=organization:402036
「環境」というキーワード検索に引っかかるデータセットの一覧(デフォルトでは10件)を取得します。
http://data.bodik.jp/api/3/action/package_search?q=環境
※CKANでは1つのデータセットに複数のリソース(ファイル)が登録できるようになっています。
例)https://data.bodik.jp/dataset/402036_0000200_00031/
データセットを検索する場合は「package_search」、リソースを検索する場合は「resource_search」を利用します。
「AED」というキーワード検索に引っかかるリソース(ファイル)の一覧を取得します。
https://data.bodik.jp/api/3/action/resource_search?query=name:AED
リソース「久留米市立学校一覧」(CSVファイル)の最初の5行を取得します。
http://data.bodik.jp/api/action/datastore_search?resource_id=d29c1d2b-8f47-4f00-94ba-88ee6010438d&limit=5
Web APIで取得した日時について
CKANでは時刻はすべてUTC(協定世界時)で登録されています。
Web APIで取得した日時もUTCです。日本で利用する場合はJST(+9:00)に変換してご利用ください。
WebサイトではJSTで表示するようにしていますので、Webサイトの表示とAPIで取得した日時が異なりますのでご注意ください。