for users, publishers and sysadmins


The API is provided by CKAN and extensions.

The CKAN API docs are extensive:

All the action functions return help text detailing parameters etc.

Below are some tips relating to


If you want to process lots or all the dataset metadata, rather than making tens of thousands of requests, please just download our daily dump in JSON or CSV format: Datasets JSON Datasets CSV

A list of datasets:

Details of a dataset:


Search on the API is very similar to the search page. Guidance for Finding Data also applies to this API.

The parameters to package_search are passed through to SOLR, so consult the SOLR docs for more info.

Free text - the q parameter works like the search box and looks for the specified works in title, description etc.. By default, the best matches are returned first. It uses stemming, so ‘fish’ also returns results containing ‘fishes’, ‘fishing’ etc.


By field - use the fq parameter to filter on particular fields. Returns exact matches. It uses roughly the same syntax as in the URL of the web search.

e.g. Publisher:

Further examples are at: Finding Data.

NB Remember to escape these URLs. Most browsers will escape these automatically when you click on these example links, but python clients etc. will mostly need them URL encoded (spaces to %20 etc). And on the command-line remember to quote the whole URL e.g. use single quotes:

curl '""'

Organization hierarchy uses CKAN organizations to store what is shown as “publisher”s on the front-end.

A list of the organizations:

Details of one organization:

You can also get the whole organization tree:

And the tree below a particular top-level organization: