マニュアル

レジストリカタログの操作方法について、説明します。
なお、本マニュアル記載の画面項目や画面イメージについてはマニュアル向けの事例であり、今後変更される可能性があります。


本サービスの利用規約については、メニューの「利用規約」からご参照ください。
本サービスに関するお問い合わせは、メニューの「お問い合わせ」から行ってください。

目次

1 検索とデータダウンロードの方法

2 データカタログサイトで提供しているAPIに関する情報


1 検索とデータダウンロードの方法

レジストリカタログでは、CKANを使用して、データセットを公開しています。

CKAN
https://ckan.org/

データセットは以下の方法で検索できます。


ファセット検索を行う
①データセット一覧画面の左メニューから、以下の内容でファセット検索が行えます。
都道府県 : 北海道、青森県などの都道府県 データセット種別 : データの種別
ファセット検索
②都道府県でファセット検索を行います。
【検索例】都道府県「北海道」をクリック
ファセット検索 デジタル庁

③ファセット検索が行われ、都道府県「北海道」のデータセットのみ表示されます。

ファセット検索結果 デジタル庁
④別の条件でさらにファセット検索を行うことができます。
データセット種別でファセット検索を行います。
【検索例】データセット種別「町字マスター(市区町村)」をクリック
ファセット検索 法律・制度

⑤ファセット検索が行われ、都道府県「北海道」かつデータセット種別「町字マスター(市区町村)」のデータセットのみ表示されます。
さらに別の条件でもファセット検索可能です。また、キーワード検索と合わせて使用することもできます。

ファセット検索結果 法律・制度

キーワード検索を行う

①キーワード検索欄に検索したいキーワードを入力します。

キーワード検索

②キーワードを入力して、「」ボタンをクリックすると、データセットのメタデータ(タイトル、説明、タグ等)にキーワードが含まれるデータセットを検索して表示します。
【検索例】キーワードに「町字マスター」を入力して検索

キーワード検索 公共施設

③キーワードをスペース区切りで入力すると、いずれのキーワードも含まれているデータセットを検索します。(AND検索)
【検索例】キーワードに「町字マスター 東京都」を入力して検索すると「町字マスター」と「東京都」のいずれも含まれているデータセットを検索します。

キーワード検索 公共施設 東京都

データをダウンロードする

データは以下の方法でダウンロードできます。

①データセット一覧画面からデータをダウンロードしたいデータセットをクリックします。

データセット一覧

②データセットのメタデータが表示されます。「データとリソース」欄にダウンロード可能なデータが一覧表示されます。

データセット詳細

③ダウンロードしたいデータの「ダウンロード」ボタンをクリックするとファイルがダウンロードされます。

データダウンロード

④データのタイトル部分をクリックすると、リソース詳細画面に遷移します。リソース詳細画面からURLのリンクまたは、ダウンロードボタンをクリックすることでダウンロードすることもできます。

リソース詳細

⑤リソースのデータ定義等の情報は「リソース定義」から確認することができます。

リソース詳細

⑥「メタデータ詳細」は、メタデータの詳細をXML形式でダウンロードすることができます。

メタデータ詳細

2 データカタログサイトで提供しているAPIに関する情報

レジストリカタログでは、ITシステムの開発者等が、本サービスで提供するメタデータを二次利用し、ITシステムを開発するために必要なAPI情報を提供しています。
※API: Application Programming Interface


レジストリカタログでは、CKAN APIを使用して、データセット、リソース、都道府県、グループ等のメタデータの情報を取得することができます。

CKAN API guide
https://docs.ckan.org/en/2.9/api/

留意点

  • 実行にあたっては、CKAN API guideに記載の 「http://demo.ckan.org/」 の部分を、レジストリカタログのURL 「https://catalog.registries.digital.go.jp/」 に置き換えてください。
  • データの更新を行うAPIについては使用できません。
  • APIで取得する日付項目はUTC(協定世界時)となっています。JST(日本標準時)で使用する場合は、変換してご利用ください。

API名
GETpackage_search

エンドポイント
https://catalog.registries.digital.go.jp/api/3/action/package_search

主要なパラメタ
名前 データ型 説明
q

(任意項目)

string 検索キーワード
sort

(任意項目)

string 検索結果の表示順
metadata_modified desc : 最終更新日の降順
title_string asc : データセット名の昇順
title_string desc : データセット名の降順
rows

(任意項目)

int 検索結果の取得数
デフォルト: 10
上限:1000
start

(任意項目)

int 検索結果の取得位置
デフォルト: 0
実行例 キーワード「住居表示-住居マスター(全国)」で検索する。 https://catalog.registries.digital.go.jp/api/3/action/package_search?q=住居表示-住居マスター(全国) レスポンス

{ "help": "https://catalog.registries.digital.go.jp/rc/api/3/action/help_show?name=package_search", "success": true, "result": { "count": 1, "facets": {}, "results": [ { "author": "", "author_email": "", "creator_user_id": "6f4f0e1c-1927-4930-9b05-80874ec6ed28", "id": "94b1b1ae-d9cd-4f2e-993e-a84e4a1dc604", "isopen": true, "license_id": "cc-by", "license_title": "Creative Commons Attribution", "license_url": "https://creativecommons.org/licenses/by/4.0/deed.ja", "maintainer": "", "maintainer_email": "", "metadata_created": "2023-01-23T05:02:24.768943", "metadata_modified": "2024-03-15T05:20:04.299019", "name": "ba000003", "notes": "アドレス(住所・所在地)・ベース・レジストリの住居表示-住居マスターデータセットです。", "num_resources": 3, "num_tags": 3, "organization": { "id": "bdeb89d5-d1f9-4f49-a7e3-b1255ea41c4a", "name": "o-100000", "title": "全国", "type": "organization", "description": "", "image_url": "", "created": "2024-11-20T08:14:46.893927", "is_organization": true, "approval_status": "approved", "state": "active" }, "owner_org": "bdeb89d5-d1f9-4f49-a7e3-b1255ea41c4a", "private": false, "state": "active", "title": "全国 住居表示-住居マスター データセット", "type": "dataset", "url": "", "version": "", "extras": [ { "key": "管理ID", "value": "BA000003" }, { "key": "対象地域", "value": "日本" }, { "key": "対象期間", "value": "" }, { "key": "提供者", "value": "デジタル庁" }, { "key": "連絡先情報", "value": "デジタル庁" }, { "key": "データセット種別", "value": "住居表示-住居マスター(全国)" }, { "key": "備考", "value": "ベース・レジストリで削除となった情報は含みません。" } ], "groups": [ { "description": "", "display_name": "土地・地図", "id": "8d08786c-d63a-476c-9fec-2cc2747e4d66", "image_display_url": "", "name": "g-000001", "title": "土地・地図" } ], "resources": [ { "cache_last_updated": null, "cache_url": null, "created": "2023-01-23T05:02:24.774760", "description": "アドレス(住所・所在地)・ベース・レジストリの住居表示-住居マスターデータセットです。", "format": "CSV(UTF-8)", "hash": "", "id": "380beab1-492b-4536-a6a5-6584e5377817", "last_modified": "2024-03-15T05:20:04", "metadata_modified": "2024-03-15T05:20:04.313025", "mimetype": "application/zip", "mimetype_inner": null, "name": "住居表示-住居マスター(全国)", "package_id": "94b1b1ae-d9cd-4f2e-993e-a84e4a1dc604", "position": 0, "resource_type": null, "size": null, "state": "active", "url": "https://catalog.registries.digital.go.jp/rsc/address/mt_rsdtdsp_rsdt_all.csv.zip", "url_type": null }, { "cache_last_updated": null, "cache_url": null, "created": "2023-01-23T05:02:24.774764", "description": "ベース・レジストリ(アドレス)のリソース定義です。(外部サイトが開きます)", "format": "", "hash": "", "id": "49e931a4-010b-4efd-a11f-c86a9b2836cd", "last_modified": "2023-01-27T00:00:00", "metadata_modified": "2023-01-23T05:02:24.750090", "mimetype": null, "mimetype_inner": null, "name": "リソース定義", "package_id": "94b1b1ae-d9cd-4f2e-993e-a84e4a1dc604", "position": 1, "resource_type": null, "size": null, "state": "active", "url": "https://www.digital.go.jp/policies/base_registry_address/", "url_type": null }, { "cache_last_updated": null, "cache_url": null, "created": "2023-01-23T05:02:24.774766", "description": "メタデータをXML形式でダウンロードします。", "format": "XML", "hash": "", "id": "58d153cb-6dca-4b9d-9f7e-825932a5a0b1", "last_modified": "2023-01-27T00:00:00", "metadata_modified": "2023-01-23T05:02:24.750220", "mimetype": "application/xml", "mimetype_inner": null, "name": "メタデータ(詳細)", "package_id": "94b1b1ae-d9cd-4f2e-993e-a84e4a1dc604", "position": 2, "resource_type": null, "size": null, "state": "active", "url": "https://catalog.registries.digital.go.jp/rc/dataset/ba000003.xml", "url_type": null } ], "tags": [ { "display_name": "住所情報", "id": "df96c436-5487-410a-bc38-608732c58c86", "name": "住所情報", "state": "active", "vocabulary_id": null }, { "display_name": "市区町村", "id": "781a7fb6-df17-409b-ac10-15ae7b184f79", "name": "市区町村", "state": "active", "vocabulary_id": null }, { "display_name": "都道府県", "id": "155414cb-424d-4f28-96d9-12ee95d97402", "name": "都道府県", "state": "active", "vocabulary_id": null } ], "relationships_as_subject": [], "relationships_as_object": [] } ], "sort": "score desc, metadata_modified desc", "search_facets": {} } }

主要なレスポンス項目
名前 データ型 説明
count int データセット件数
results

list of dataset dictionaries データセット一覧
name

string データセットID
title

string データセットタイトル
notes

string 説明
tags

list of tag dictionaries タグ
license_title

string ライセンス
extras

list of dataset extra dictionaries データセットの拡張メタデータ
organization

organization dictionaries 都道府県
groups

list of group dictionaries グループ
resources

list of resource dictionaries リソース
name : リソース名
url : リソースURL
description : 説目
format : フォーマット
mimetype : メディアタイプ
created : 作成日
last_modified : 最終更新日
metadata_created

iso date string 作成日
metadata_modified

iso date string 最終更新日

データセットID一覧を取得する(package_list)

API名
GETpackage_list

エンドポイント
https://catalog.registries.digital.go.jp/api/3/action/package_list

主要なパラメタ
名前 データ型 説明
limit

(任意項目)

int 検索結果の取得数
offset

(任意項目)

int 検索結果の取得位置
デフォルト: 0
実行例 データセットIDを10件取得する。 https://catalog.registries.digital.go.jp/api/3/action/package_list?limit=10 レスポンス

{ "help": "https://catalog.registries.digital.go.jp/rc/api/3/action/help_show?name=package_list", "success": true, "result": [ "ba000001", "ba000002", "ba000003", "ba000004", "ba000005", "ba000006", "ba-o1-000000_g2-000001", "ba-o1-000000_g2-000002", "ba-o1-000000_g2-000003", "ba-o1-000000_g2-000009" ] }

主要なレスポンス項目
名前 データ型 説明
results

list of dataset id データセットID一覧

データセットのメタデータを取得する(package_show)

API名
GETpackage_show

エンドポイント
https://catalog.registries.digital.go.jp/api/3/action/package_show

主要なパラメタ
名前 データ型 説明
id

(必須項目)

string データセットID
include_tracking

(任意項目)

bool データセットのアクセス数、ダウンロード数を出力する
デフォルト: false
実行例 「全アドレスデータ」データセットのメタデータを取得する。 https://catalog.registries.digital.go.jp/api/3/action/package_show?id=ba000001 レスポンス

{ "help": "https://catalog.registries.digital.go.jp/rc/api/3/action/help_show?name=package_show", "success": true, "result": { "author": "", "author_email": "", "creator_user_id": "6f4f0e1c-1927-4930-9b05-80874ec6ed28", "id": "276792c3-f15e-437e-b29b-60f116242d6b", "isopen": true, "license_id": "cc-by", "license_title": "Creative Commons Attribution", "license_url": "https://creativecommons.org/licenses/by/4.0/deed.ja", "maintainer": "", "maintainer_email": "", "metadata_created": "2023-01-23T05:02:23.756669", "metadata_modified": "2024-08-14T20:02:44.804671", "name": "ba000001", "notes": "アドレス(住所・所在地)・ベース・レジストリの全マスターデータをまとめたデータセットです。\r\n\r\n地番マスター、地番マスター位置参照拡張のデータセットについて、本データセットには含まれませんので、それぞれのデータセットから個別にダウンロードしてください。", "num_resources": 3, "num_tags": 3, "organization": { "id": "bdeb89d5-d1f9-4f49-a7e3-b1255ea41c4a", "name": "o-100000", "title": "全国", "type": "organization", "description": "", "image_url": "", "created": "2024-11-20T08:14:46.893927", "is_organization": true, "approval_status": "approved", "state": "active" }, "owner_org": "bdeb89d5-d1f9-4f49-a7e3-b1255ea41c4a", "private": false, "state": "active", "title": "全アドレスデータ", "type": "dataset", "url": "", "version": "", "extras": [ { "key": "管理ID", "value": "BA000001" }, { "key": "対象地域", "value": "日本" }, { "key": "対象期間", "value": "" }, { "key": "提供者", "value": "デジタル庁" }, { "key": "連絡先情報", "value": "デジタル庁" }, { "key": "データセット種別", "value": "全アドレスデータ" }, { "key": "備考", "value": "ベース・レジストリで削除となった情報は含みません。" } ], "groups": [ { "description": "", "display_name": "土地・地図", "id": "8d08786c-d63a-476c-9fec-2cc2747e4d66", "image_display_url": "", "name": "g-000001", "title": "土地・地図" } ], "resources": [ { "cache_last_updated": null, "cache_url": null, "created": "2023-01-23T05:02:23.802012", "description": "アドレス(住所・所在地)・ベース・レジストリの全マスターデータをまとめたデータセットです。", "format": "CSV(UTF-8)", "hash": "", "id": "b535cd16-b477-4e5d-81c8-1eb116c97b2f", "last_modified": "2024-08-14T20:02:44", "metadata_modified": "2024-08-14T20:02:44.817516", "mimetype": "application/zip", "mimetype_inner": null, "name": "全アドレスデータ", "package_id": "276792c3-f15e-437e-b29b-60f116242d6b", "position": 0, "resource_type": null, "size": null, "state": "active", "url": "https://catalog.registries.digital.go.jp/rsc/address/address_all.csv.zip", "url_type": null }, { "cache_last_updated": null, "cache_url": null, "created": "2023-01-23T05:02:23.802016", "description": "ベース・レジストリ(アドレス)のリソース定義です。(外部サイトが開きます)", "format": "", "hash": "", "id": "3c9df1c2-aa07-45ff-8190-0121bb73937f", "last_modified": "2023-01-27T00:00:00", "metadata_modified": "2023-01-23T05:02:23.737644", "mimetype": null, "mimetype_inner": null, "name": "リソース定義", "package_id": "276792c3-f15e-437e-b29b-60f116242d6b", "position": 1, "resource_type": null, "size": null, "state": "active", "url": "https://www.digital.go.jp/policies/base_registry_address/", "url_type": null }, { "cache_last_updated": null, "cache_url": null, "created": "2023-01-23T05:02:23.802018", "description": "メタデータをXML形式でダウンロードします。", "format": "XML", "hash": "", "id": "5891f977-1971-4ccf-aeee-4aab6ac630dd", "last_modified": "2023-01-27T00:00:00", "metadata_modified": "2023-01-23T05:02:23.737774", "mimetype": "application/xml", "mimetype_inner": null, "name": "メタデータ(詳細)", "package_id": "276792c3-f15e-437e-b29b-60f116242d6b", "position": 2, "resource_type": null, "size": null, "state": "active", "url": "https://catalog.registries.digital.go.jp/rc/dataset/ba000001.xml", "url_type": null } ], "tags": [ { "display_name": "住所情報", "id": "df96c436-5487-410a-bc38-608732c58c86", "name": "住所情報", "state": "active", "vocabulary_id": null }, { "display_name": "市区町村", "id": "781a7fb6-df17-409b-ac10-15ae7b184f79", "name": "市区町村", "state": "active", "vocabulary_id": null }, { "display_name": "都道府県", "id": "155414cb-424d-4f28-96d9-12ee95d97402", "name": "都道府県", "state": "active", "vocabulary_id": null } ], "relationships_as_subject": [], "relationships_as_object": [] } }

主要なレスポンス項目
名前 データ型 説明
name

string データセットID
title

string データセットタイトル
notes

string 説明
tags

list of tag dictionaries タグ
license_title

string ライセンス
extras

list of dataset extra dictionaries データセットの拡張メタデータ
organization

organization dictionaries 都道府県
groups

list of group dictionaries グループ
resources

list of resource dictionaries リソース
name : リソース名
url : リソースURL
description : 説目
format : フォーマット
mimetype : メディアタイプ
created : 作成日
last_modified : 最終更新日
tracking_summary : リソースダウンロード数(include_tracking=trueを指定した場合のみ表示)
metadata_created

iso date string 作成日
metadata_modified

iso date string 最終更新日
tracking_summary

int データセットアクセス数
(include_tracking=trueを指定した場合のみ表示)

最近更新されたデータセットのメタデータ一覧を取得する(current_package_list_with_resources)

API名
GETcurrent_package_list_with_resources

エンドポイント
https://catalog.registries.digital.go.jp/api/3/action/current_package_list_with_resources

主要なパラメタ
名前 データ型 説明
limit

(任意項目)

int 検索結果の取得数
offset

(任意項目)

int 検索結果の取得位置
デフォルト: 0
実行例 最近更新されたデータセットのメタデータを3件取得する。 https://catalog.registries.digital.go.jp/api/3/action/current_package_list_with_resources?limit=3 レスポンス

{ "help": "https://catalog.registries.digital.go.jp/rc/api/3/action/help_show?name=current_package_list_with_resources", "success": true, "result": [ { "author": null, "author_email": null, "creator_user_id": "6f4f0e1c-1927-4930-9b05-80874ec6ed28", "id": "31d79627-e2ac-432e-9067-2308da5543f5", "isopen": true, "license_id": "cc-by", "license_title": "Creative Commons Attribution", "license_url": "https://creativecommons.org/licenses/by/4.0/deed.ja", "maintainer": null, "maintainer_email": null, "metadata_created": "2024-03-12T08:07:22.869399", "metadata_modified": "2024-08-13T05:44:10.186084", "name": "ba-o1-060003_g2-000009", "notes": "アドレス(住所・所在地)・ベース・レジストリの町字マスター(フルセット)データセットです。", "num_resources": 3, "num_tags": 3, "organization": { "id": "6e7cca21-ccf0-47f6-872b-dc90c5ca48c9", "name": "o-100006", "title": "山形県", "type": "organization", "description": "", "image_url": "", "created": "2024-11-20T09:24:06.725994", "is_organization": true, "approval_status": "approved", "state": "active" }, "owner_org": "6e7cca21-ccf0-47f6-872b-dc90c5ca48c9", "private": false, "state": "active", "title": "山形県 町字マスター(フルセット) データセット", "type": "dataset", "url": null, "version": null, "extras": [ { "key": "管理ID", "value": "BA-o1-060003_g2-000009" }, { "key": "対象地域", "value": "山形県" }, { "key": "対象期間", "value": "" }, { "key": "提供者", "value": "デジタル庁" }, { "key": "連絡先情報", "value": "base-registries-address@digital.go.jp" }, { "key": "データセット種別", "value": "町字マスター(フルセット)(都道府県)" }, { "key": "備考", "value": "ベース・レジストリで削除となった情報は含みません。" } ], "groups": [ { "description": "", "display_name": "土地・地図", "id": "8d08786c-d63a-476c-9fec-2cc2747e4d66", "image_display_url": "", "name": "g-000001", "title": "土地・地図" } ], "resources": [ { "cache_last_updated": null, "cache_url": null, "created": "2024-08-13T05:44:10.351780", "description": "アドレス(住所・所在地)・ベース・レジストリの町字マスター(フルセット)データセットです。", "format": "CSV(UTF-8)", "hash": "", "id": "cb2f8d07-1791-478d-99c1-35dca6a77184", "last_modified": "2024-08-13T05:44:04", "metadata_modified": "2024-08-13T05:44:10.226074", "mimetype": "application/zip", "mimetype_inner": null, "name": "山形県 町字マスター(フルセット) データセット", "package_id": "31d79627-e2ac-432e-9067-2308da5543f5", "position": 0, "resource_type": null, "size": null, "state": "active", "url": "https://catalog.registries.digital.go.jp/rsc/address/mt_town_fullset_pref06.csv.zip", "url_type": null }, { "cache_last_updated": null, "cache_url": null, "created": "2024-08-13T05:44:10.351786", "description": "ベース・レジストリ(アドレス)のリソース定義です。(外部サイトが開きます)", "format": "", "hash": "", "id": "5eced04a-884c-40bd-90bd-3f7089f69c63", "last_modified": "2023-01-27T00:00:00", "metadata_modified": "2024-08-13T05:44:10.226273", "mimetype": null, "mimetype_inner": null, "name": "リソース定義", "package_id": "31d79627-e2ac-432e-9067-2308da5543f5", "position": 1, "resource_type": null, "size": null, "state": "active", "url": "https://www.digital.go.jp/policies/base_registry_address/", "url_type": null }, { "cache_last_updated": null, "cache_url": null, "created": "2024-08-13T05:44:10.351787", "description": "メタデータをXML形式でダウンロードします。", "format": "XML", "hash": "", "id": "f8091894-2299-42f1-9704-49506b9a14b3", "last_modified": "2023-01-27T00:00:00", "metadata_modified": "2024-08-13T05:44:10.226421", "mimetype": "application/xml", "mimetype_inner": null, "name": "メタデータ(詳細)", "package_id": "31d79627-e2ac-432e-9067-2308da5543f5", "position": 2, "resource_type": null, "size": null, "state": "active", "url": "https://catalog.registries.digital.go.jp/rc/dataset/ba-o1-060003_g2-000009.xml", "url_type": null } ], "tags": [ { "display_name": "住所情報", "id": "df96c436-5487-410a-bc38-608732c58c86", "name": "住所情報", "state": "active", "vocabulary_id": null }, { "display_name": "市区町村", "id": "781a7fb6-df17-409b-ac10-15ae7b184f79", "name": "市区町村", "state": "active", "vocabulary_id": null }, { "display_name": "都道府県", "id": "155414cb-424d-4f28-96d9-12ee95d97402", "name": "都道府県", "state": "active", "vocabulary_id": null } ], "relationships_as_subject": [], "relationships_as_object": [] }, { "author": null, "author_email": null, "creator_user_id": "6f4f0e1c-1927-4930-9b05-80874ec6ed28", "id": "d2cf5756-6291-4e56-83f3-86cb0e1f7900", "isopen": true, "license_id": "cc-by", "license_title": "Creative Commons Attribution", "license_url": "https://creativecommons.org/licenses/by/4.0/deed.ja", "maintainer": null, "maintainer_email": null, "metadata_created": "2024-03-12T08:05:50.855546", "metadata_modified": "2024-08-13T05:44:05.067884", "name": "ba-o1-050008_g2-000009", "notes": "アドレス(住所・所在地)・ベース・レジストリの町字マスター(フルセット)データセットです。", "num_resources": 3, "num_tags": 3, "organization": { "id": "2b374653-28a3-4842-9649-0c5a577c8bff", "name": "o-100005", "title": "秋田県", "type": "organization", "description": "", "image_url": "", "created": "2024-11-20T09:24:06.568175", "is_organization": true, "approval_status": "approved", "state": "active" }, "owner_org": "2b374653-28a3-4842-9649-0c5a577c8bff", "private": false, "state": "active", "title": "秋田県 町字マスター(フルセット) データセット", "type": "dataset", "url": null, "version": null, "extras": [ { "key": "管理ID", "value": "BA-o1-050008_g2-000009" }, { "key": "対象地域", "value": "秋田県" }, { "key": "対象期間", "value": "" }, { "key": "提供者", "value": "デジタル庁" }, { "key": "連絡先情報", "value": "base-registries-address@digital.go.jp" }, { "key": "データセット種別", "value": "町字マスター(フルセット)(都道府県)" }, { "key": "備考", "value": "ベース・レジストリで削除となった情報は含みません。" } ], "groups": [ { "description": "", "display_name": "土地・地図", "id": "8d08786c-d63a-476c-9fec-2cc2747e4d66", "image_display_url": "", "name": "g-000001", "title": "土地・地図" } ], "resources": [ { "cache_last_updated": null, "cache_url": null, "created": "2024-08-13T05:44:05.258090", "description": "アドレス(住所・所在地)・ベース・レジストリの町字マスター(フルセット)データセットです。", "format": "CSV(UTF-8)", "hash": "", "id": "1aa2dbee-1385-432d-8239-683cc6a646a6", "last_modified": "2024-08-13T05:43:58", "metadata_modified": "2024-08-13T05:44:05.110413", "mimetype": "application/zip", "mimetype_inner": null, "name": "秋田県 町字マスター(フルセット) データセット", "package_id": "d2cf5756-6291-4e56-83f3-86cb0e1f7900", "position": 0, "resource_type": null, "size": null, "state": "active", "url": "https://catalog.registries.digital.go.jp/rsc/address/mt_town_fullset_pref05.csv.zip", "url_type": null }, { "cache_last_updated": null, "cache_url": null, "created": "2024-08-13T05:44:05.258095", "description": "ベース・レジストリ(アドレス)のリソース定義です。(外部サイトが開きます)", "format": "", "hash": "", "id": "01bcc17e-2e6c-45bc-99fd-f7692a600679", "last_modified": "2023-01-27T00:00:00", "metadata_modified": "2024-08-13T05:44:05.110822", "mimetype": null, "mimetype_inner": null, "name": "リソース定義", "package_id": "d2cf5756-6291-4e56-83f3-86cb0e1f7900", "position": 1, "resource_type": null, "size": null, "state": "active", "url": "https://www.digital.go.jp/policies/base_registry_address/", "url_type": null }, { "cache_last_updated": null, "cache_url": null, "created": "2024-08-13T05:44:05.258097", "description": "メタデータをXML形式でダウンロードします。", "format": "XML", "hash": "", "id": "d8fbc1e5-75b9-4c3e-b60a-3db0a872c304", "last_modified": "2023-01-27T00:00:00", "metadata_modified": "2024-08-13T05:44:05.111048", "mimetype": "application/xml", "mimetype_inner": null, "name": "メタデータ(詳細)", "package_id": "d2cf5756-6291-4e56-83f3-86cb0e1f7900", "position": 2, "resource_type": null, "size": null, "state": "active", "url": "https://catalog.registries.digital.go.jp/rc/dataset/ba-o1-050008_g2-000009.xml", "url_type": null } ], "tags": [ { "display_name": "住所情報", "id": "df96c436-5487-410a-bc38-608732c58c86", "name": "住所情報", "state": "active", "vocabulary_id": null }, { "display_name": "市区町村", "id": "781a7fb6-df17-409b-ac10-15ae7b184f79", "name": "市区町村", "state": "active", "vocabulary_id": null }, { "display_name": "都道府県", "id": "155414cb-424d-4f28-96d9-12ee95d97402", "name": "都道府県", "state": "active", "vocabulary_id": null } ], "relationships_as_subject": [], "relationships_as_object": [] }, { "author": null, "author_email": null, "creator_user_id": "6f4f0e1c-1927-4930-9b05-80874ec6ed28", "id": "7e0c3d6d-17f4-4e8c-a48b-514946780d1c", "isopen": true, "license_id": "cc-by", "license_title": "Creative Commons Attribution", "license_url": "https://creativecommons.org/licenses/by/4.0/deed.ja", "maintainer": null, "maintainer_email": null, "metadata_created": "2024-03-12T08:03:03.571424", "metadata_modified": "2024-08-13T05:43:52.827757", "name": "ba-o1-030007_g2-000009", "notes": "アドレス(住所・所在地)・ベース・レジストリの町字マスター(フルセット)データセットです。", "num_resources": 3, "num_tags": 3, "organization": { "id": "ea85c849-884b-4024-897e-df141b76885e", "name": "o-100003", "title": "岩手県", "type": "organization", "description": "", "image_url": "", "created": "2024-11-20T08:17:34.385764", "is_organization": true, "approval_status": "approved", "state": "active" }, "owner_org": "ea85c849-884b-4024-897e-df141b76885e", "private": false, "state": "active", "title": "岩手県 町字マスター(フルセット) データセット", "type": "dataset", "url": null, "version": null, "extras": [ { "key": "管理ID", "value": "BA-o1-030007_g2-000009" }, { "key": "対象地域", "value": "岩手県" }, { "key": "対象期間", "value": "" }, { "key": "提供者", "value": "デジタル庁" }, { "key": "連絡先情報", "value": "base-registries-address@digital.go.jp" }, { "key": "データセット種別", "value": "町字マスター(フルセット)(都道府県)" }, { "key": "備考", "value": "ベース・レジストリで削除となった情報は含みません。" } ], "groups": [ { "description": "", "display_name": "土地・地図", "id": "8d08786c-d63a-476c-9fec-2cc2747e4d66", "image_display_url": "", "name": "g-000001", "title": "土地・地図" } ], "resources": [ { "cache_last_updated": null, "cache_url": null, "created": "2024-08-13T05:43:53.007924", "description": "アドレス(住所・所在地)・ベース・レジストリの町字マスター(フルセット)データセットです。", "format": "CSV(UTF-8)", "hash": "", "id": "0c4a8020-e354-4067-89df-824816dcdeaf", "last_modified": "2024-08-13T05:43:46", "metadata_modified": "2024-08-13T05:43:52.883747", "mimetype": "application/zip", "mimetype_inner": null, "name": "岩手県 町字マスター(フルセット) データセット", "package_id": "7e0c3d6d-17f4-4e8c-a48b-514946780d1c", "position": 0, "resource_type": null, "size": null, "state": "active", "url": "https://catalog.registries.digital.go.jp/rsc/address/mt_town_fullset_pref03.csv.zip", "url_type": null }, { "cache_last_updated": null, "cache_url": null, "created": "2024-08-13T05:43:53.007929", "description": "ベース・レジストリ(アドレス)のリソース定義です。(外部サイトが開きます)", "format": "", "hash": "", "id": "0f89ca4f-ec4c-4fd6-bcc2-2e2074f18df9", "last_modified": "2023-01-27T00:00:00", "metadata_modified": "2024-08-13T05:43:52.889167", "mimetype": null, "mimetype_inner": null, "name": "リソース定義", "package_id": "7e0c3d6d-17f4-4e8c-a48b-514946780d1c", "position": 1, "resource_type": null, "size": null, "state": "active", "url": "https://www.digital.go.jp/policies/base_registry_address/", "url_type": null }, { "cache_last_updated": null, "cache_url": null, "created": "2024-08-13T05:43:53.007931", "description": "メタデータをXML形式でダウンロードします。", "format": "XML", "hash": "", "id": "cf5d4aab-8e77-48ae-b46f-9d395faa7854", "last_modified": "2023-01-27T00:00:00", "metadata_modified": "2024-08-13T05:43:52.894593", "mimetype": "application/xml", "mimetype_inner": null, "name": "メタデータ(詳細)", "package_id": "7e0c3d6d-17f4-4e8c-a48b-514946780d1c", "position": 2, "resource_type": null, "size": null, "state": "active", "url": "https://catalog.registries.digital.go.jp/rc/dataset/ba-o1-030007_g2-000009.xml", "url_type": null } ], "tags": [ { "display_name": "住所情報", "id": "df96c436-5487-410a-bc38-608732c58c86", "name": "住所情報", "state": "active", "vocabulary_id": null }, { "display_name": "市区町村", "id": "781a7fb6-df17-409b-ac10-15ae7b184f79", "name": "市区町村", "state": "active", "vocabulary_id": null }, { "display_name": "都道府県", "id": "155414cb-424d-4f28-96d9-12ee95d97402", "name": "都道府県", "state": "active", "vocabulary_id": null } ], "relationships_as_subject": [], "relationships_as_object": [] } ] }

主要なレスポンス項目
名前 データ型 説明
result

list of dataset dictionaries データセット一覧
name

string データセットID
title

string データセットタイトル
notes

string 説明
tags

list of tag dictionaries タグ
license_title

string ライセンス
extras

list of dataset extra dictionaries データセットの拡張メタデータ
organization

organization dictionaries 都道府県
groups

list of group dictionaries グループ
resources

list of resource dictionaries リソース
name : リソース名
url : リソースURL
description : 説目
format : フォーマット
mimetype : メディアタイプ
created : 作成日
last_modified : 最終更新日
metadata_created

iso date string 作成日
metadata_modified

iso date string 最終更新日

都道府県ID一覧を取得する(organization_list)

API名
GETorganization_list

エンドポイント
https://catalog.registries.digital.go.jp/api/3/action/organization_list

主要なパラメタ
名前 データ型 説明
sort

(任意項目)

string 検索結果の表示順
name asc : 都道府県IDの昇順
name desc : 都道府県IDの降順
title asc : 都道府県名の昇順
title desc : 都道府県名の降順
package_count asc : 都道府県内データセット数の昇順
package_count desc : 都道府県内データセット数の降順
limit

(任意項目)

int 検索結果の取得数
offset

(任意項目)

int 検索結果の取得位置
デフォルト: 0
実行例 都道府県IDを都道府県IDの昇順で取得する。 https://catalog.registries.digital.go.jp/api/3/action/organization_list?sort=name asc レスポンス

{ "help": "https://catalog.registries.digital.go.jp/rc/api/3/action/help_show?name=organization_list", "success": true, "result": [ "o-100000", "o-100001", "o-100002", "o-100003", "o-100004", "o-100005", "o-100006", "o-100007", "o-100008", "o-100009", "o-100010", "o-100011", "o-100012", "o-100013", "o-100014", "o-100015", "o-100016", "o-100017", "o-100018", "o-100019", "o-100020", "o-100021", "o-100022", "o-100023", "o-100024", "o-100025", "o-100026", "o-100027", "o-100028", "o-100029", "o-100030", "o-100031", "o-100032", "o-100033", "o-100034", "o-100035", "o-100036", "o-100037", "o-100038", "o-100039", "o-100040", "o-100041", "o-100042", "o-100043", "o-100044", "o-100045", "o-100046", "o-100047" ] }

主要なレスポンス項目
名前 データ型 説明
result

list of organization id 都道府県ID一覧

都道府県のメタデータを取得する(organization_show)

API名
GETorganization_show

エンドポイント
https://catalog.registries.digital.go.jp/api/3/action/organization_show

主要なパラメタ
名前 データ型 説明
id

(必須項目)

string 都道府県ID
include_datasets

(任意項目)

bool 都道府県内データセットのメタデータを含める
実行例 都道府県「東京都」のメタデータを取得する。 https://catalog.registries.digital.go.jp/api/3/action/organization_show?id=o-100013 レスポンス

{ help: "https://catalog.registries.digital.go.jp/rc/api/3/action/help_show?name=organization_show", "success": true, "result": { "approval_status": "approved", "created": "2024-11-20T01:30:15.809270", "description": "", "display_name": "東京都", "id": "7f5bf4f7-44a5-46ee-b5d1-34d6dbe7b0ac", "image_display_url": "", "image_url": "", "is_organization": true, "name": "o-100013", "num_followers": 0, "package_count": 8, "state": "active", "title": "東京都", "type": "organization", "extras": [], "tags": [], "groups": [] } }

主要なレスポンス項目
名前 データ型 説明
name

string 都道府県ID
title, display_name

string 都道府県名
description

string 説明
created

iso date string 作成日
package_count

int 都道府県内のデータセット数
packages

list of dataset dictionaries 都道府県内データセットのメタデータ
(include_datasets=trueを指定した場合のみ表示)

タグ一覧を取得する(tag_list)

API名
GETtag_list

エンドポイント
https://catalog.registries.digital.go.jp/api/3/action/tag_list

主要なパラメタ
名前 データ型 説明
query

(任意項目)

string 検索キーワード
実行例 タグの一覧を取得する。 https://catalog.registries.digital.go.jp/api/3/action/tag_list レスポンス

{ "help": "https://catalog.registries.digital.go.jp/rc/api/3/action/help_show?name=tag_list", "success": true, "result": [ "住所情報", "市区町村", "都道府県" ] }

主要なレスポンス項目
名前 データ型 説明
result

list of tag タグ一覧

タグのメタデータを取得する(tag_show)

API名
GETtag_show

エンドポイント
https://catalog.registries.digital.go.jp/api/3/action/tag_show

主要なパラメタ
名前 データ型 説明
id

(必須項目)

string タグ名
include_datasets

(任意項目)

bool タグが設定されたデータセットのメタデータを含める
実行例 タグ「住所情報」のメタデータを取得する。 https://catalog.registries.digital.go.jp/api/3/action/tag_show?id=住所情報 レスポンス

{ "help": "https://catalog.registries.digital.go.jp/rc/api/3/action/help_show?name=tag_show", "success": true, "result": { "id": "df96c436-5487-410a-bc38-608732c58c86", "name": "住所情報", "vocabulary_id": null, "display_name": "住所情報" } }

主要なレスポンス項目
名前 データ型 説明
name, display_name

string タグ名
packages

list of dataset dictionaries タグが設定されたデータセットのメタデータ
(include_datasets=trueを指定した場合のみ表示)