開発者向け情報API

dataeyeで提供しているAPI(API:Application Programming Interface)に関する情報

1.はじめに

オープンデータポータル「dataeye」は、データ連携用にCKANを用意しています。APIを使用したJSON形式で、組織、グループ、データセット、リソース、タグの各メタデータ取得が可能です。CKAN-APIガイド(英文)はこちらです。

2.API一覧

No. API メソッド 説明 引数 必須/オプション デフォルト値 戻り値のタイプ パラメータ説明
1 api/action/package_list GET データセット一覧を取得する。 - - - - -
2 api/action/current_package_list_with_resources GET データセット一覧(リソースを含む)を取得する。 limit オプション - int 取得する最大のデータセット件数を指定する。
page オプション 0 int 「limit」の値で複数ページに分割されたデータセット一覧から、返却対象とするページの番号を指定する。
3. api/action/group_list GET グループ一覧を取得する。 order_by オプション name string nameでソートする場合は「name」、データセット数でソートする場合は「packages」を指定する。
groups オプション - list of strings 取得するグループの名称を指定する。
all_fields オプション false boolean すべてメタデータ項目を取得する場合は「true」、 「name」のみを取得する場合は「false」を指定する。
4. api/action/organization_list GET 組織一覧を取得する。 order_by オプション name string nameでソートする場合は「name」、データセット数でソートする場合は「packages」を指定する。
organizations オプション - list of strings 取得する組織の名称を指定する。
all_fields オプション false boolean すべてメタデータ項目を取得する場合は「true」、 「name」のみを取得する場合は「false」を指定する。
5. api/action/license_list GET ライセンス一覧を取得する。 - - - - -
6. api/action/tag_list GET タグ一覧を取得する。 query オプション - string 取得するタグに含まれる文字列を指定する。
all_fields オプション false boolean すべてメタデータ項目を取得する場合は「true」、 「name」のみを取得する場合は「false」を指定する。
7. api/action/package_show GET データセットの詳細を取得する。 id 必須 - string 取得するデータセットの「id」または、「name」を指定する。
8. api/action/resource_show GET リソースの詳細を取得する。 id 必須 - string 取得するリソースの「id」を指定する。
9. api/action/group_show GET グループの詳細を取得する。 id 必須 - string 取得するグループの「id」を指定する。
10. api/action/organization_show GET 組織の詳細を取得する。 id 必須 - string 取得する組織の「id」または、「name」を指定する。
11. api/action/group_package_show GET グループのデータセット一覧を取得する。 id 必須 - string 取得するグループの「id」または、「name」を指定する。
limit オプション - int 取得する最大のデータセット数を指定する。
12. api/action/tag_show GET タグの詳細を取得する。 id 必須 - string 取得するタグの「id」または、「name」を指定する。
13. api/action/package_search GET データセットを検索する。 q オプション *:* string データセットの検索クエリを指定する。
fq オプション - string 検索フィルターを指定する。
sort オプション relevance asc, metadata_modified desc string データセット一覧のソート順を指定する。注:フィールド名称とソート順(「asc」または「desc」)を半角スペース区切リで設定し、複数のソート順を設定する場合はパラメータをカンマ区切りで与えること。
rows オプション 10 int 取得するデータセット数を指定する。
start オプション 0 int 複数ページに分割されたデータセット一覧を表示する場合、表示を開始するページ番号を指定する。
facet オプション true string ファセットを有効化する場合は「true」、無効化する場合は「false」を指定する。
facet.mincount オプション - int ファセットが含むデータセットの最小数を指定する。この値よりもファセットが含むデータセット数が少ない場合は、そのファセットは表示されない。
facet.limit オプション 50 int ファセットの最大取得数を指定する。0より小さい値を指定した場合は全て取得される。
facet.field オプション - list of strings ファセットを生成する対象のフィールド名を指定する。指定しなかった場合、ファセットは空値で返却される。
14. api/action/resource_search GET リソースを検索する。 query 必須 - string or list of strings of the form “{field}:{term1}” リソースの検索クエリを指定する。
order_by オプション - string リソース一覧のソート順を指定する。
limit オプション - int 取得する最大のリソース件数を指定する。
offset オプション 0 int 取得するオフセットの番号を指定する。
15. api/action/tag_search GET 指定した文字列が含まれたタグを検索する。 query 必須 - string or list of strings 検索する文字列を指定する。
limit オプション - int 取得する最大のタグ数を指定する。
offset オプション - int 取得するオフセットの番号を指定する。
16. api/action/package_activity_list GET データセット更新履歴を取得する。 id 必須 - string 取得するデータセットの「id」または、「name」を指定する。
limit オプション 31 int 取得する最大のアクティビティ数を指定する。
offset オプション 0 int 取得するオフセットの番号を指定する。
17. api/action/group_activity_list - グループ更新履歴を取得する。 id 必須 - string 取得するグループの「id」または、「name」を指定する。
limit オプション 31 int 取得する最大のアクティビティ数を指定する。
offset オプション 0 int 取得するオフセットの番号を指定する。
18. api/action/organization_activity_list - 組織更新履歴を取得する。 id 必須 - string 取得する組織の「id」または、「name」を指定する。
19. api/action/recently_changed_packages_activity_list - 最近更新されたデータセット履歴を取得する。 limit オプション 31 int 取得する最大のアクティビティ数を指定する。
offset オプション 0 int 取得するオフセットの番号を指定する。

※補足説明
APIの戻り値は全てJSON形式です。GET系のリクエストについてのみ、JSONPにも対応しています。HTTPステータスコードは基本的に「200 OK」です。API自体の成功可否は、successフィールド(真偽値)で判断されます。戻り値のhelpフィールドにAPIの設定値が常に書き込まれます。APIの成功時は、resultフィールドに結果の戻り値が入ります(フォーマットの詳細はREST API依存)。失敗時は、errorフィールドにその詳細が入ります。

3.APIを利用したデータの取得例

※APIを実行する際に、先頭に「https://ckan-hiroshima-opendata.dataeye.jp/」を追加してください。

①組織に関するメタデータの取得:

登録されている組織一覧
https://ckan-hiroshima-opendata.dataeye.jp/api/action/organization_list

②グループに関するメタデータの取得:

登録されているグループ一覧
https://ckan-hiroshima-opendata.dataeye.jp/api/action/group_list

③タグに関するメタデータの取得:

タグの一覧
https://ckan-hiroshima-opendata.dataeye.jp/api/action/tag_list

指定したタグ「統計」を含むデータセット名の一覧(10件取得指定)
https://ckan-hiroshima-opendata.dataeye.jp/api/action/package_search?q=*:*&facet.limit=10&facet.field=["title_string"]&fq=tags:統計&rows=0

キーワード「統計」を含むタグの検索
https://ckan-hiroshima-opendata.dataeye.jp/api/action/tag_search?query=統計

④データセットやリソースに関するメタデータの取得:

キーワード「統計」を含むデータセットの検索(10件取得指定)
https://ckan-hiroshima-opendata.dataeye.jp/api/action/package_search?q=統計&rows=10

⑤ファイルの取得:

指定したデータセットやリソースに含まれるファイルを取得
"api/action/package_show"と"api/action/resource_show" のレスポンスにリソースの情報が含まれており、urlという項目がファイルのダウンロードリンクとなっています。このダウンロードリンクはdataeyeからのファイルダウンロードリンクとなっており、ファイルを取得することができます。