CKAN Data API

Access resource data via a web API with powerful query support. Further information in the main CKAN Data API and DataStore documentation.

Endpoints »

The Data API can be accessed via the following actions of the CKAN action API.

Create https://data.e-gov.go.jp/data/en/api/3/action/datastore_create
Update / Insert https://data.e-gov.go.jp/data/en/api/3/action/datastore_upsert
Query https://data.e-gov.go.jp/data/en/api/3/action/datastore_search
Query (via SQL) https://data.e-gov.go.jp/data/en/api/3/action/datastore_search_sql

OData https://data.e-gov.go.jp/data/en/datastore/odata3.0/82ca625b-efee-410a-a8e0-20b5d1215d14
Querying »
Query example (first 5 results)

https://data.e-gov.go.jp/data/en/api/3/action/datastore_search?resource_id=82ca625b-efee-410a-a8e0-20b5d1215d14&limit=5

Query example (results containing 'jones')

https://data.e-gov.go.jp/data/en/api/3/action/datastore_search?resource_id=82ca625b-efee-410a-a8e0-20b5d1215d14&q=jones

Query example (via SQL statement)

https://data.e-gov.go.jp/data/en/api/3/action/datastore_search_sql?sql=SELECT * from "82ca625b-efee-410a-a8e0-20b5d1215d14" WHERE "title" LIKE 'jones'

OData example (first 5 results, skip 1)

https://data.e-gov.go.jp/data/en/datastore/odata3.0/82ca625b-efee-410a-a8e0-20b5d1215d14?$top=5&$skip=1

OData example (first 5 results, return as OData JSON)

https://data.e-gov.go.jp/data/en/datastore/odata3.0/82ca625b-efee-410a-a8e0-20b5d1215d14?$top=5&$format=json

Example: Javascript »

A simple ajax (JSONP) request to the data API using jQuery.

var data = {
  resource_id: '82ca625b-efee-410a-a8e0-20b5d1215d14', // the resource id
  limit: 5, // get 5 results
  q: 'jones' // query for 'jones'
};
$.ajax({
  url: 'https://data.e-gov.go.jp/data/en/api/3/action/datastore_search',
  data: data,
  dataType: 'jsonp',
  success: function(data) {
    alert('Total results found: ' + data.result.total)
  }
});
              
Example: Python »
import json
import urllib.request
url = 'https://data.e-gov.go.jp/data/en/api/3/action/datastore_search?resource_id=82ca625b-efee-410a-a8e0-20b5d1215d14&limit=5&q=title:jones'  
fileobj = urllib.request.urlopen(url)
response_dict = json.loads(fileobj.read())
print(response_dict)