メタデータ取得APIに関するご案内
e-Govデータポータルでは、データポータルで提供するオープンデータに関するメタデータを取得でき、どなたでも自由に利用できるAPIを提供しています。
留意事項
・APIのインタフェース仕様は、CKAN標準のものと同様です。( CKAN API Guide )
・データ更新を行うAPIの利用はできません。
・レスポンスを行う際の文字コードは、UTF-8とします。
・レスポンスに含まれる日時の書式は、ISO 8601(YYYY-MM-DDTHH:MM:SS.ffffff)とします。
・タイムゾーンは、協定世界時(UTC)としています。日本標準時(JST)で使用する際は、変換してご利用下さい。
メタデータAPI一覧
データセット一覧(リソースを含む)の取得(current_package_list_with_resources)
グループのデータセット一覧の取得(group_package_show)
データセット更新履歴の取得(package_activity_list)
グループ更新履歴の取得(group_activity_list)
組織更新履歴の取得(organization_activity_list)
最近更新されたデータセット履歴の取得(recently_changed_packages_activity_list)
データセット一覧の取得(package_list)
API名
GET package_listAPI概要
データセットの名前のリストを返します。
エンドポイント
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_resourcesAPI概要
データセットとそのリソースのリストを返します。
リストは、最近変更されたものから順にソートされます。
エンドポイント
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レスポンス
主要なレスポンス項目
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストの実行結果 |
result | 辞書配列 | データセット情報(※一部の項目を抜粋) |
name | 文字列 | データセットID |
title | 文字列 | データセットタイトル |
notes | 文字列 | データセット説明 |
tags | 辞書配列 | タグ情報(※一部の項目を抜粋) |
id | 文字列 | タグID |
name | 文字列 | タグ名 |
extras | 辞書配列 | データセットの拡張メタデータ |
organization | 辞書 | 組織情報(※一部の項目を抜粋) |
name | 文字列 | 組織名(URL名) |
title | 文字列 | 組織名 |
description | 文字列 | 組織説明 |
created | 日付 | 組織作成日 |
groups | 辞書配列 | グループ情報(※一部の項目を抜粋) |
name | 文字列 | グループID |
title | 文字列 | グループ名 |
description | 文字列 | 説明 |
metadata_created | 日付 | データセット作成日 |
metadata_modified | 日付 | データセット最終更新日 |
resources | 辞書配列 | リソース情報(※一部の項目を抜粋) |
name | 文字列 | リソース名 |
url | 文字列 | リソースURL |
description | 文字列 | リソース説明 |
format | 文字列 | リソースフォーマット |
mimetype | 文字列 | メディアタイプ |
created | 日付 | リソース作成日 |
last_modified | 日付 | リソース最終更新日 |
グループ一覧の取得(group_list)
API名
GET group_listAPI概要
グループの名前のリストを返します。
エンドポイント
https://data.e-gov.go.jp/data/api/action/group_list主要なパラメータ
名前 | データ型 | 必須 | 説明 |
---|---|---|---|
sort | 文字列 | - | 結果の並び替え方法を指定する デフォルト値は"title asc" 指定可能なキーは、"name"、"package_count"、"title" |
limit | 数値 | - | 一度に取得するグループの数を指定する |
offset | 数値 | - | 取得を開始する位置を指定する |
groups | 文字列配列 | - | 取得するグループの名称を指定する |
all_fields | 真偽値 | - | すべてメタデータ項目を取得する場合は「true」、 「name」のみを取得する場合は「false」を指定する |
include_dataset_count | 真偽値 | - | データセット数情報を結果に含めるか指定する ※all_fieldsが有効である必要がある |
include_extras | 真偽値 | - | グループのextrasフィールドを結果に含めるか指定する ※all_fieldsが有効である必要がある |
include_tags | 真偽値 | - | グループタグを結果に含めるか指定する ※all_fieldsが有効である必要がある |
include_groups | 真偽値 | - | グループが属するグループを結果に含めるか指定する ※all_fieldsが有効である必要がある |
include_users | 真偽値 | - | グループユーザーを結果に含めるか指定する ※all_fieldsが有効である必要がある |
実行例
グループIDを5件取得する。
https://data.e-gov.go.jp/data/api/action/group_list?limit=5レスポンス
主要なレスポンス項目(all_fieldsがtrueの場合)
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストの実行結果 |
result | 辞書配列 | グループ情報(※一部の項目を抜粋) |
name | 文字列 | グループID |
title | 文字列 | グループ名 |
description | 文字列 | 説明 |
主要なレスポンス項目(all_fieldsがfalseの場合)
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストの実行結果 |
result | 文字列配列 | グループ名の一覧 |
組織一覧の取得(organization_list)
API名
GET organization_listAPI概要
組織名のリストを返します。
エンドポイント
https://data.e-gov.go.jp/data/api/action/organization_list主要なパラメータ
名前 | データ型 | 必須 | 説明 |
---|---|---|---|
sort | 文字列 | - | 結果の並び替え方法を指定する デフォルト値は"title asc" 指定可能なキーは、"name"、"package_count"、"title" |
limit | 数値 | - | 一度に取得する組織の数を指定する |
offset | 数値 | - | 取得を開始する位置を指定する |
organizations | 文字列配列 | - | 取得する組織の名称を指定する |
all_fields | 真偽値 | - | すべてメタデータ項目を取得する場合は「true」、 「name」のみを取得する場合は「false」を指定する |
include_dataset_count | 真偽値 | - | データセット数情報を結果に含めるか指定する ※all_fieldsが有効である必要がある |
include_extras | 真偽値 | - | 組織のextrasフィールドを結果に含めるか指定する ※all_fieldsが有効である必要がある |
include_tags | 真偽値 | - | 組織タグを結果に含めるか指定する ※all_fieldsが有効である必要がある |
include_groups | 真偽値 | - | 組織が属する組織を結果に含めるか指定する ※all_fieldsが有効である必要がある |
include_users | 真偽値 | - | 組織ユーザーを結果に含めるか指定する ※all_fieldsが有効である必要がある |
実行例
登録されている組織の一覧(各組織のメタ情報も取得)
https://data.e-gov.go.jp/data/api/action/organization_list?all_fields=trueレスポンス
主要なレスポンス項目(all_fieldsがtrueの場合)
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストの実行結果 |
result | 文字列配列 | 組織情報(※一部の項目を抜粋) |
name | 文字列 | 組織名(URL名) |
title | 文字列 | 組織名 |
description | 文字列 | 組織説明 |
created | 日付 | 組織作成日 |
主要なレスポンス項目(all_fieldsがfalseの場合)
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストの実行結果 |
result | 文字列配列 | 組織名の一覧 |
ライセンス一覧の取得(license_list)
API名
GET license_listAPI概要
データセットに利用可能なライセンスのリストを返します。
エンドポイント
https://data.e-gov.go.jp/data/api/action/license_list主要なパラメータ
名前 | データ型 | 必須 | 説明 |
---|
実行例
ライセンス一覧の取得
https://data.e-gov.go.jp/data/api/action/license_listレスポンス
主要なレスポンス項目
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストの実行結果 |
result | 辞書配列 | ライセンス情報の辞書配列 |
タグ一覧の取得(tag_list)
API名
GET tag_listAPI概要
タグのリストを返します。
エンドポイント
https://data.e-gov.go.jp/data/api/action/tag_list主要なパラメータ
名前 | データ型 | 必須 | 説明 |
---|---|---|---|
query | 文字列 | - | 取得するタグに含まれる文字列を指定する |
all_fields | 真偽値 | - | すべてメタデータ項目を取得する場合は「true」、 「name」のみを取得する場合は「false」を指定する |
実行例
「統計」を含むタグ名を取得
https://data.e-gov.go.jp/data/api/action/tag_list?query=統計レスポンス
主要なレスポンス項目(all_fieldsがtrueの場合)
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストの実行結果 |
result | 辞書配列 | タグ情報(※一部の項目を抜粋) |
id | 文字列 | タグID |
name | 文字列 | タグ名 |
主要なレスポンス項目(all_fieldsがfalseの場合)
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストの実行結果 |
result | 文字列配列 | タグ名の一覧 |
データセット詳細の取得(package_show)
API名
GET package_showAPI概要
データセットとそのリソースのメタデータを返します。
エンドポイント
https://data.e-gov.go.jp/data/api/action/package_show主要なパラメータ
名前 | データ型 | 必須 | 説明 |
---|---|---|---|
id | 文字列 | 〇 | 取得するデータセットの「id」または、「name」を指定する |
include_tracking | 真偽値 | - | トラッキング情報を結果に含めるか指定する |
実行例
指定したデータセット「高度情報通信ネットワーク社会の形成に関する予算_平成26年度」のメタデータ情報
https://data.e-gov.go.jp/data/api/action/package_show?id=digi_20220315_0001レスポンス
主要なレスポンス項目
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストの実行結果 |
result | 辞書 | データセット情報(※一部の項目を抜粋) |
name | 文字列 | データセットID |
title | 文字列 | データセットタイトル |
notes | 文字列 | データセット説明 |
tags | 辞書配列 | タグ情報(※一部の項目を抜粋) |
id | 文字列 | タグID |
name | 文字列 | タグ名 |
extras | 辞書配列 | データセットの拡張メタデータ |
organization | 辞書 | 組織情報の辞書(※一部の項目を抜粋) |
name | 文字列 | 組織名(URL名) |
title | 文字列 | 組織名 |
description | 文字列 | 組織説明 |
created | 日付 | 組織作成日 |
groups | 辞書配列 | グループ情報(※一部の項目を抜粋) |
name | 文字列 | グループID |
title | 文字列 | グループ名 |
description | 文字列 | 説明 |
metadata_created | 日付 | データセット作成日 |
metadata_modified | 日付 | データセット最終更新日 |
resources | 辞書配列 | リソース情報(※一部の項目を抜粋) |
name | 文字列 | リソース名 |
url | 文字列 | リソースURL |
description | 文字列 | リソース説明 |
format | 文字列 | リソースフォーマット |
mimetype | 文字列 | メディアタイプ |
created | 日付 | リソース作成日 |
last_modified | 日付 | リソース最終更新日 |
リソース詳細の取得(resource_show)
API名
GET resource_showAPI概要
リソースのメタデータを返します。
エンドポイント
https://data.e-gov.go.jp/data/api/action/resource_show主要なパラメータ
名前 | データ型 | 必須 | 説明 |
---|---|---|---|
id | 文字列 | 〇 | 取得するリソースの「id」を指定する |
include_tracking | 真偽値 | - | トラッキング情報を結果に含めるか指定する |
実行例
指定したリソース「令和3年版消費者白書__HTML形式(本文)」のメタ情報をトラッキング情報を含めて取得
https://data.e-gov.go.jp/data/api/action/resource_show?id=e856e6f1-cdd8-4397-9c3b-4c28afa28259&include_tracking=trueレスポンス
主要なレスポンス項目
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストの実行結果 |
result | 辞書 | リソース情報(※一部の項目を抜粋) |
name | 文字列 | リソース名 |
url | 文字列 | リソースURL |
description | 文字列 | リソース説明 |
format | 文字列 | リソースフォーマット |
mimetype | 文字列 | メディアタイプ |
created | 日付 | リソース作成日 |
last_modified | 日付 | リソース最終更新日 |
グループ詳細の取得(group_show)
API名
GET group_showAPI概要
グループの詳細を返します。
エンドポイント
https://data.e-gov.go.jp/data/api/action/group_show主要なパラメータ
名前 | データ型 | 必須 | 説明 |
---|---|---|---|
id | 文字列 | 〇 | 取得するグループの「id」を指定する |
include_datasets | 真偽値 | - | グループのデータセット情報を結果に含めるか指定する |
include_dataset_count | 真偽値 | - | グループのデータセット数情報を結果に含めるか指定する |
include_extras | 真偽値 | - | グループのextrasフィールドを結果に含めるか指定する |
include_users | 真偽値 | - | グループのユーザー情報を結果に含めるか指定する |
include_groups | 真偽値 | - | グループのサブグループを結果に含めるか指定する |
include_tags | 真偽値 | - | グループのタグを結果に含めるか指定する |
include_followers | 真偽値 | - | グループのフォロワー数を結果に含めるか指定する |
実行例
指定したグループ「行財政」の詳細情報
https://data.e-gov.go.jp/data/api/action/group_show?id=gr_1300レスポンス
主要なレスポンス項目
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストの実行結果 |
result | 辞書 | グループ情報(※一部の項目を抜粋) |
name | 文字列 | グループID |
title | 文字列 | グループ名 |
description | 文字列 | 説明 |
組織詳細の取得(organization_show)
API名
GET organization_showAPI概要
組織の詳細を返します。
エンドポイント
https://data.e-gov.go.jp/data/api/action/organization_show主要なパラメータ
名前 | データ型 | 必須 | 説明 |
---|---|---|---|
id | 文字列 | 〇 | 取得する組織の「id」または、「name」を指定する |
include_datasets | 真偽値 | - | 組織のデータセット情報を結果に含めるか指定する |
include_dataset_count | 真偽値 | - | 組織のデータセット数情報を結果に含めるか指定する |
include_extras | 真偽値 | - | 組織のextrasフィールドを結果に含めるか指定する |
include_users | 真偽値 | - | 組織ユーザー情報を結果に含めるか指定する |
include_groups | 真偽値 | - | 組織のサブグループを結果に含めるか指定する |
include_tags | 真偽値 | - | 組織のタグを結果に含めるか指定する |
include_followers | 真偽値 | - | 組織のフォロワー数を結果に含めるか指定する |
実行例
指定した組織「内閣府」の詳細情報
https://data.e-gov.go.jp/data/api/action/organization_show?id=org_0400レスポンス
主要なレスポンス項目
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストの実行結果 |
result | 辞書 | 組織情報(※一部の項目を抜粋) |
name | 文字列 | 組織名(URL名) |
title | 文字列 | 組織名 |
description | 文字列 | 組織説明 |
created | 日付 | 組織作成日 |
グループのデータセット一覧の取得(group_package_show)
API名
GET group_package_showAPI概要
グループのデータセットを返します。
エンドポイント
https://data.e-gov.go.jp/data/api/action/group_package_show主要なパラメータ
名前 | データ型 | 必須 | 説明 |
---|---|---|---|
id | 文字列 | 〇 | 取得するグループの「id」または、「name」を指定する |
limit | 数値 | - | 取得する最大のグループ数を指定する |
実行例
指定したグループ「人口・世帯」のデータセットメタ情報を取得
https://data.e-gov.go.jp/data/api/action/group_package_show?id=gr_0200レスポンス
主要なレスポンス項目
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストの実行結果 |
result | 辞書配列 | データセット情報(※一部の項目を抜粋) |
name | 文字列 | データセットID |
title | 文字列 | データセットタイトル |
notes | 文字列 | データセット説明 |
tags | 辞書配列 | タグ情報(※一部の項目を抜粋) |
id | 文字列 | タグID |
name | 文字列 | タグ名 |
extras | 辞書配列 | データセットの拡張メタデータ |
organization | 辞書 | 組織情報(※一部の項目を抜粋) |
name | 文字列 | 組織名(URL名) |
title | 文字列 | 組織名 |
description | 文字列 | 組織説明 |
created | 日付 | 組織作成日 |
groups | 辞書配列 | グループ情報(※一部の項目を抜粋) |
name | 文字列 | グループID |
title | 文字列 | グループ名 |
description | 文字列 | 説明 |
metadata_created | 日付 | データセット作成日 |
metadata_modified | 日付 | データセット最終更新日 |
resources | 辞書配列 | リソース情報(※一部の項目を抜粋) |
name | 文字列 | リソース名 |
url | 文字列 | リソースURL |
description | 文字列 | リソース説明 |
format | 文字列 | リソースフォーマット |
mimetype | 文字列 | メディアタイプ |
created | 日付 | リソース作成日 |
last_modified | 日付 | リソース最終更新日 |
タグ詳細の取得(tag_show)
API名
GET tag_showAPI概要
タグとそのすべてのデータセットの詳細を返します。
エンドポイント
https://data.e-gov.go.jp/data/api/action/tag_show主要なパラメータ
名前 | データ型 | 必須 | 説明 |
---|---|---|---|
id | 文字列 | 〇 | 取得するタグの「id」または、「name」を指定する |
include_datasets | 真偽値 | - | タグのデータセットを取得する場合は「true」を指定する。 |
実行例
指定したタグ「国家プロジェクト」のメタ情報を取得
https://data.e-gov.go.jp/data/api/action/tag_show?id=国家プロジェクトレスポンス
主要なレスポンス項目
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストの実行結果 |
result | 辞書 | タグ情報(※一部の項目を抜粋) |
id | 文字列 | タグID |
name | 文字列 | タグ名 |
データセット検索(package_search)
API名
GET package_searchAPI概要
指定された検索条件を満たすパッケージを検索します。
エンドポイント
https://data.e-gov.go.jp/data/api/action/package_search主要なパラメータ
名前 | データ型 | 必須 | 説明 |
---|---|---|---|
q | 文字列 | - | データセットの検索クエリを指定する |
fq | 文字列 | - | 検索フィルターを指定する |
fq_list | 文字列配列 | - | 追加で適用するフィルタークエリのリスト |
sort | 文字列 | - | データセット一覧のソート順を指定する ※フィールド名称とソート順(「asc」または「desc」)を半角スペース区切リで設定し、複数のソート順を設定する場合はパラメータをカンマ区切りで与えること |
rows | 数値 | - | 取得するデータセット数を指定する |
start | 数値 | - | 複数ページに分割されたデータセット一覧を表示する場合、表示を開始するページ番号を指定する |
facet | 真偽値 | - | ファセットを有効化する場合は「true」、 無効化する場合は「false」を指定する |
facet.mincount | 数値 | - | ファセットが含むデータセットの最小数を指定する この値よりもファセットが含むデータセット数が少ない場合は、そのファセットは表示されない |
facet.limit | 数値 | - | ファセットの最大取得数を指定する 0より小さい値を指定した場合は全て取得される |
facet.field | 文字列配列 | - | ファセットを生成する対象のフィールド名を指定する 指定しなかった場合、ファセットは空値で返却される |
実行例
検索条件に合うデータセット「平成26年_新規登録、更新情報」が属しているグループ名の一覧
https://data.e-gov.go.jp/data/api/action/package_search?q=*:*&facet.limit=10&facet.field=["groups"]&fq=tags:統計&rows=0レスポンス
主要なレスポンス項目
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストの実行結果 |
result | 辞書 | データセット検索の結果情報 |
リソース検索(resource_search)
API名
GET resource_searchAPI概要
指定された検索条件を満たすリソースを検索します。
エンドポイント
https://data.e-gov.go.jp/data/api/action/resource_search主要なパラメータ
名前 | データ型 | 必須 | 説明 |
---|---|---|---|
query | 文字列 | 〇 | リソースの検索クエリを指定する |
order_by | 文字列 | - | リソース一覧のソート順を指定する |
limit | 数値 | - | 取得する最大のリソース件数を指定する |
offset | 数値 | - | 取得するオフセットの番号を指定する |
実行例
「name」属性にキーワード「統計」を含むリソースの検索(10件取得指定)
https://data.e-gov.go.jp/data/api/action/resource_search?query=name:統計&limit=10レスポンス
主要なレスポンス項目
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストの実行結果 |
result | 辞書配列 | リソース情報(※一部の項目を抜粋) |
name | 文字列 | リソース名 |
url | 文字列 | リソースURL |
description | 文字列 | リソース説明 |
format | 文字列 | リソースフォーマット |
mimetype | 文字列 | メディアタイプ |
created | 日付 | リソース作成日 |
last_modified | 日付 | リソース最終更新日 |
タグ検索(tag_search)
API名
GET tag_searchAPI概要
名前に指定された文字列が含まれるタグのリストを返します。
エンドポイント
https://data.e-gov.go.jp/data/api/action/tag_search主要なパラメータ
名前 | データ型 | 必須 | 説明 |
---|---|---|---|
query | 文字列 | - | 検索する文字列を指定する |
limit | 数値 | - | 取得する最大のタグ数を指定する |
offset | 数値 | - | 取得するオフセットの番号を指定する |
実行例
キーワード「統計」を含むタグの検索
https://data.e-gov.go.jp/data/api/action/tag_search?query=統計レスポンス
主要なレスポンス項目
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストの実行結果 |
result | 辞書配列 | タグ情報(※一部の項目を抜粋) |
id | 文字列 | タグID |
name | 文字列 | タグ名 |
データセット更新履歴の取得(package_activity_list)
API名
GET package_activity_listAPI概要
パッケージのアクティビティストリームを返します (詳細は含まれません)
エンドポイント
https://data.e-gov.go.jp/data/api/action/package_activity_list主要なパラメータ
名前 | データ型 | 必須 | 説明 |
---|---|---|---|
id | 文字列 | 〇 | 取得するデータセットの「id」または、「name」を指定する |
limit | 数値 | - | 取得する最大のアクティビティ数を指定する |
offset | 数値 | - | 取得するオフセットの番号を指定する |
実行例
指定したデータセット「高度情報通信ネットワーク社会の形成に関する予算_平成26年度」の更新履歴
https://data.e-gov.go.jp/data/api/action/package_activity_list?id=digi_20220315_0001レスポンス
主要なレスポンス項目
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストが成功したかどうか |
result | 辞書配列 | データセットの更新履歴一覧 |
グループ更新履歴の取得(group_activity_list)
API名
GET group_activity_listAPI概要
グループのアクティビティ ストリームを返します。
エンドポイント
https://data.e-gov.go.jp/data/api/action/group_activity_list主要なパラメータ
名前 | データ型 | 必須 | 説明 |
---|---|---|---|
id | 文字列 | 〇 | 取得するグループの「id」または、「name」を指定する |
limit | 数値 | - | 取得する最大のアクティビティ数を指定する |
offset | 数値 | - | 取得するオフセットの番号を指定する |
実行例
指定したグループ「行財政」の更新履歴
https://data.e-gov.go.jp/data/api/action/group_activity_list?id=gr_1300レスポンス
主要なレスポンス項目
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストが成功したかどうか |
result | 辞書配列 | グループの更新履歴一覧 |
組織更新履歴の取得(organization_activity_list)
API名
GET organization_activity_listAPI概要
組織のアクティビティ ストリームを返します。
エンドポイント
https://data.e-gov.go.jp/data/api/action/organization_activity_list主要なパラメータ
名前 | データ型 | 必須 | 説明 |
---|---|---|---|
id | 文字列 | 〇 | 取得する組織の「id」または、「name」を指定する |
limit | 数値 | - | 取得する最大のアクティビティ数を指定する |
offset | 数値 | - | 取得するオフセットの番号を指定する |
実行例
指定した組織「内閣府」の更新履歴
https://data.e-gov.go.jp/data/api/action/organization_activity_list?id=org_0400レスポンス
主要なレスポンス項目
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストが成功したかどうか |
result | 辞書配列 | 組織の更新履歴一覧 |
最近更新されたデータセット履歴の取得(recently_changed_packages_activity_list)
API名
GET recently_changed_packages_activity_listAPI概要
最近追加または変更されたすべてのパッケージのアクティビティストリームを返します。
エンドポイント
https://data.e-gov.go.jp/data/api/action/recently_changed_packages_activity_list主要なパラメータ
名前 | データ型 | 必須 | 説明 |
---|---|---|---|
limit | 数値 | - | 取得する最大のアクティビティ数を指定する |
offset | 数値 | - | 取得するオフセットの番号を指定する |
実行例
最近更新されたデータセット更新履歴を2件取得
https://data.e-gov.go.jp/data/api/action/recently_changed_packages_activity_list?limit=2レスポンス
主要なレスポンス項目
名前 | データ型 | 説明 |
---|---|---|
help | 文字列 | APIに関する説明が含まれるURLパス |
success | 真偽値 | リクエストが成功したかどうか |
result | 辞書配列 | データセットの更新履歴一覧 |