Service
Use the official read-only e-Gov Data Portal CKAN API to search datasets, inspect dataset and resource metadata, build organization and category selectors, and review recently modified datasets.
99.76%30-day uptimeAvg response494ms
Selecting a row opens the reference for that API.
| Method | API | Path | Summary |
|---|---|---|---|
| POST | /v1/japan-open-data/categories | Lists all e-Gov data categories (CKAN groups) with optional dataset counts so their category_id tokens can be passed to search-datasets. Use when the user wants to filter datasets by topic category or browse categories. Do NOT use to list publishing organizations — use japan-open-data:organizations instead. The complete category list is returned in one response without pagination. Returns items (category_id, title, description, dataset_count) and summary. | |
| POST | /v1/japan-open-data/dataset | Gets one dataset and a bounded page of its publisher resource metadata (name, format, MIME type, URL, timestamps) using a dataset_id returned by search-datasets or recent-datasets. Use when the user has already selected a dataset and needs its resources or publisher download URLs. Do NOT use to find datasets — use japan-open-data:search-datasets instead. The resource page is controlled by resource_limit (1-50) and resource_offset; resource files are not downloaded by APIFuse. Timestamps are explicit UTC instants. Returns items (one dataset detail with resources, resources_returned_count, resources_has_more, and next_resource_offset) and summary. | |
| POST | /v1/japan-open-data/organizations | Lists e-Gov publishing organizations with optional dataset counts so their organization_id tokens can be passed to search-datasets. Use when the user wants to filter datasets by publisher or browse publishers. Do NOT use to list data categories (CKAN groups) — use japan-open-data:categories instead; do NOT use to search datasets themselves — use japan-open-data:search-datasets instead. Pages with a cursor: pass summary.cursor from the previous response back as cursor, unchanged; limit is 1-100 per page and the whole registry is well under one page. Returns items (organization_id, title, description, dataset_count) and summary. | |
| POST | /v1/japan-open-data/recent-datasets | Lists recently modified e-Gov datasets in the portal's newest-modified-first order with resource counts and UTC ISO 8601 timestamps. Use when the user asks what datasets were added or updated recently without a specific keyword. Do NOT use for keyword or filtered search — use japan-open-data:search-datasets instead; do NOT use to get a dataset's resources — use japan-open-data:dataset instead. Pages with a cursor: pass summary.cursor from the previous response back as cursor, unchanged; limit is 1-50 per page. Returns items (dataset summaries with dataset_id and resource_count) and summary. |
Issue a sandbox key and make your first reservation.
APIFuse holds the partner credentials. You hold one managed key.
Receive events such as reservation confirmations and delivery updates.
Service outages and gateway errors normalise into one error model.
| POST | /v1/japan-open-data/search-datasets | Searches e-Gov Data Portal datasets by a required full-text query with optional organization_id, category_id, and resource-format (formats) filters. Use when the user names a topic or keyword to look for. Do NOT use to browse what changed recently — use japan-open-data:recent-datasets instead; do NOT use to discover organization or category tokens — use japan-open-data:organizations or japan-open-data:categories instead. Pages with a cursor: pass summary.cursor from the previous response back as cursor, unchanged, along with the identical query and filters; limit is 1-50 per page; dataset timestamps are explicit UTC instants. Returns items (dataset summaries with dataset_id, organization, categories, tags, and resource_count) and summary (returned_count, total_count for the whole result set, has_more, cursor). |
