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 /api/action/datastore_create
Update / Insert /api/action/datastore_upsert
Query /api/action/datastore_search
Query (via SQL) /api/action/datastore_search_sql
Querying »
Query example (first 5 results)

/api/action/datastore_search?resource_id=970c9267-5b4e-424b-9092-91bc919d4c8b&limit=5

Query example (results containing 'jones')

/api/action/datastore_search?resource_id=970c9267-5b4e-424b-9092-91bc919d4c8b&q=jones

Query example (via SQL statement)

/api/action/datastore_search_sql?sql=SELECT * from "970c9267-5b4e-424b-9092-91bc919d4c8b" WHERE title LIKE 'jones'

Example: Javascript »

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

  var data = {
    resource_id: '970c9267-5b4e-424b-9092-91bc919d4c8b', // the resource id
    limit: 5, // get 5 results
    q: 'jones' // query for 'jones'
  };
  $.ajax({
    url: '/api/action/datastore_search',
    data: data,
    dataType: 'jsonp',
    success: function(data) {
      alert('Total results found: ' + data.result.total)
    }
  });
Example: Python » 
import urllib
url = '/api/action/datastore_search?limit=5&q=title:jones'
fileobj = urllib.urlopen(url)
print fileobj.read()