埼玉県オープンデータポータルサイト
埼玉県
オープンデータポータルサイト
埼玉県オープンデータポータルサイト
埼玉県
オープンデータポータルサイト
オープンデータポータル「dataeye」は、データ連携用にCKAN互換のAPIを用意しています。APIを使用したJSON形式で、自治体、分野、データセット、リソース、タグの各メタデータ取得が可能です。
※APIの利用に関してセキュリティ対策の関係で、サイトへのアクセス制限がかかる場合がございます。
アクセス制限があった際は以下の「本サイトに関する問い合わせ」からお問い合わせください。
https://opendata.pref.saitama.lg.jp/ideabox
| No. | API | メソッド | 説明 | 引数 | 必須／オプション | デフォルト値 | 戻り値のタイプ | パラメータ説明 |
|---|---|---|---|---|---|---|---|---|
| 1. | ckan_api/package_list | GET | データセット一覧を取得する。 | limit | オプション | 100 | int | 取得する最大の件数を指定する。 |
| offset | オプション | 0 | int | 取得するオフセットの番号を指定する。 | ||||
| 2. | ckan_api/group_list | GET | 分野一覧を取得する。 | - | - | - | - | - |
| 3. | ckan_api/organization_list | GET | 自治体一覧を取得する。 | - | - | - | - | - |
| 4. | ckan_api/license_list | GET | ライセンス一覧を取得する。 | - | - | - | - | - |
| 5. | ckan_api/tag_list | GET | タグ一覧を取得する。 | - | - | - | - | - |
| 6. | ckan_api/package_show | GET | データセットの詳細を取得する。 | id | 必須 | - | string | 取得するデータセットの「id」を指定する。 |
| 7. | ckan_api/resource_show | GET | リソースの詳細を取得する。 | id | 必須 | - | string | 取得するリソースの「id」を指定する。 |
| 8. | ckan_api/group_show | GET | 分野の詳細を取得する。 | id | 必須 | - | string | 取得する分野の「id」を指定する。 |
| 9. | ckan_api/organization_show | GET | 自治体の詳細を取得する。 | id | 必須 | - | string | 取得する自治体の「id」を指定する。 |
| 10. | ckan_api/package_search | GET | データセットを検索する。 | q | オプション | string | データセットの検索キーワードを指定する。 | |
| sort | オプション | name asc, metadata_modified desc | string | データセット一覧のソート順を指定する。注：フィールド名称とソート順（「asc」または「desc」）を半角スペース区切リで設定し、複数のソート順を設定する場合はパラメータをカンマ区切りで与えること。 | ||||
| rows | オプション | 100 | int | 取得するデータセット数を指定する。 | ||||
| start | オプション | 0 | int | 複数ページに分割されたデータセット一覧を表示する場合、表示を開始するページ番号を指定する。 | ||||
| facet.field | オプション | string | リストアップする対象の項目を指定する。複数の指定も可能。 例) ["title","metadata_created"] ※取得可能キーは以下。 title(またはtitle_string), metadata_created, metadata_modified |
|||||
| facet.limit | オプション | 10 | int | 項目のリストアップ機能の取得件数を指定する。 | ||||
| 11. | ckan_api/resource_search | GET | リソースを検索する。 | query | 必須 | - | string | リソースの検索キーワードを指定する。 |
| order_by | オプション | name asc | string | リソース一覧のソート順を指定する。 | ||||
| limit | オプション | - | int | 取得する最大のリソース件数を指定する。 | ||||
| offset | オプション | 0 | int | 取得するオフセットの番号を指定する。 | ||||
| 12. | ckan_api/tag_search | GET | 指定した文字列が含まれたタグを検索する。 | query | 必須 | - | string | 検索する文字列を指定する。 |
| limit | オプション | - | int | 取得する最大の件数を指定する。 | ||||
| offset | オプション | 0 | int | 取得するオフセットの番号を指定する。 | ||||
| 13. | ckan_api/current_package_list_with_resources | GET | 直近に更新されたデータセット一覧を取得する。 | limit | オプション | 100 | int | 取得する最大の件数を指定する。 |
| offset | オプション | 0 | int | 取得するオフセットの番号を指定する。 |
※補足説明
APIの戻り値は全てJSON形式です。HTTPステータスコードは基本的に「200 OK」です。API自体の成功可否は、successフィールド(真偽値)で判断されます。戻り値のhelpフィールドにAPIの設定値が常に書き込まれます。APIの成功時は、resultフィールドに結果の戻り値が入ります(フォーマットの詳細はREST API依存)。失敗時は、errorフィールドにその詳細が入ります。
※APIを実行する際に、先頭に「https://opendata.pref.saitama.lg.jp/」を追加してください。
登録されている自治体一覧
https://opendata.pref.saitama.lg.jp/ckan_api/organization_list
登録されている分野一覧
https://opendata.pref.saitama.lg.jp/ckan_api/group_list
タグの一覧
https://opendata.pref.saitama.lg.jp/ckan_api/tag_list
指定したタグ「統計」を含むデータセット名の一覧（10件取得指定）
https://opendata.pref.saitama.lg.jp/ckan_api/package_search?q=統計&&rows=10
キーワード「統計」を含むタグの検索
https://opendata.pref.saitama.lg.jp/ckan_api/tag_search?query=統計
キーワード「統計」を含むデータセットの検索（10件取得指定）
https://opendata.pref.saitama.lg.jp/ckan_api/package_search?q=統計&rows=10
指定したデータセットやリソースに含まれるファイルを取得
"ckan_api/package_show"と"ckan_api/resource_show" のレスポンスにリソースの情報が含まれており、urlという項目がファイルのダウンロードリンクとなっています。このダウンロードリンクはdataeyeからのファイルダウンロードリンクとなっており、ファイルを取得することができます。