このページの本文へ移動
データポータル ログイン

メタデータ取得APIに関するご案内

e-Govデータポータルでは、データポータルで提供するオープンデータに関するメタデータを取得でき、どなたでも自由に利用できるAPIを提供しています。

留意事項

・データ更新を行うAPIの利用はできません。

・レスポンスを行う際の文字コードは、UTF-8とします。

・レスポンスに含まれる日時の書式は、ISO 8601(YYYY-MM-DDTHH:MM:SS.ffffff)とします。

・タイムゾーンは、協定世界時(UTC)としています。日本標準時(JST)で使用する際は、変換してご利用下さい。

メタデータAPI一覧

データセット一覧の取得(package_list)

データセット一覧(リソースを含む)の取得(current_package_list_with_resources)

グループ一覧の取得(group_list)

組織一覧の取得(organization_list)

ライセンス一覧の取得(license_list)

タグ一覧の取得(tag_list)

データセット詳細の取得(package_show)

リソース詳細の取得(resource_show)

グループ詳細の取得(group_show)

組織詳細の取得(organization_show)

グループのデータセット一覧の取得(group_package_show)

タグ詳細の取得(tag_show)

データセット検索(package_search)

リソース検索(resource_search)

タグ検索(tag_search)

データセット更新履歴の取得(package_activity_list)

グループ更新履歴の取得(group_activity_list)

組織更新履歴の取得(organization_activity_list)

最近更新されたデータセット履歴の取得(recently_changed_packages_activity_list)


データセット一覧の取得(package_list)

API名

GET package_list

API概要

データセットの名前のリストを返します。

エンドポイント

https://data.e-gov.go.jp/data/api/action/package_list 新しいウィンドウで開く

主要なパラメータ

名前 データ型 必須 説明
limit 数値 - 取得する最大のデータセット件数を指定する
offset 数値 - 「limit」の値で複数ページに分割されたデータセット一覧から、返却対象とするオフセット番号を指定する

実行例

データセット名を10件取得する。

https://data.e-gov.go.jp/data/api/action/package_list?limit=10 新しいウィンドウで開く

レスポンス

主要なレスポンス項目

名前 データ型 説明
help 文字列 APIに関する説明が含まれるURLパス
success 真偽値 リクエストの実行結果
result 文字列配列 データセットIDの一覧

データセット一覧(リソースを含む)の取得(current_package_list_with_resources)

API名

GET current_package_list_with_resources

API概要

データセットとそのリソースのリストを返します。
リストは、最近変更されたものから順にソートされます。

エンドポイント

https://data.e-gov.go.jp/data/api/action/current_package_list_with_resources 新しいウィンドウで開く

主要なパラメータ

名前 データ型 必須 説明
limit  数値 - 取得する最大のデータセット件数を指定する
offset  数値 - 「limit」の値で複数ページに分割されたデータセット一覧から、返却対象とするオフセット番号を指定する

実行例

データセット一覧(リソースを含む)を2件取得する。

https://data.e-gov.go.jp/data/api/action/current_package_list_with_resources?limit=2 新しいウィンドウで開く

レスポンス