${datastore_root_url}/datastore_search_sql?sql=SELECT * from "${resource_id}" WHERE title LIKE 'jones'

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

${datastore_root_url}/datastore_search?resource_id=${resource_id}&limit=5

Query example (results containing 'jones')

${datastore_root_url}/datastore_search?resource_id=${resource_id}&q=jones

Query example (via SQL statement)

${sql_example_url()}

Example: Javascript »

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

  var data = {
    resource_id: '${resource_id}', // the resource id
    limit: 5, // get 5 results
    q: 'jones' // query for 'jones'
  };
  $.ajax({
    url: '${datastore_root_url}/datastore_search',
    data: data,
    dataType: 'jsonp',
    success: function(data) {
      alert('Total results found: ' + data.result.total)
    }
  });
Example: Pyhton »
import urllib
url = '${datastore_root_url}/datastore_search?limit=5&q=title:jones'
fileobj = urllib.urlopen(url)
print fileobj.read()