Available Data and Resource IDs

How to find DataStore resources

The DataStore API works at the resource level, meaning you query a specific file, not the entire dataset. DataStore API access is currently available for a subset of resources on HDX. We’re working on expanding coverage to include all structured CSV resources.

DataStore Resource ID: HDX UI

Here's how to find resources active on DataStore through the HDX UI:

1. Navigate to the Available Datasets via DataStore API Page: Go to the discovery page that lists the available datasets for API access.

2. Find your dataset: On the actual dataset page, each data resource is listed with a name, file format, and additional indicators (e.g. API access).

3. Access DataStore API endpoint: For the individual resource available within HDX’s DataStore API, you’ll see a link to the relevant API(s) along with the resource ID. This information is essential for querying the resource programmatically.

DataStore Resource ID: HDX CKAN API

Resource ids can also be found in the HDX CKAN API response. See HDX System documentation for finding the resource_id through the HDX CKAN API.

From the response, identify the resource that corresponds to the structured data you're interested in. Sometimes datasets include multiple resources (e.g. data files, documentation). Inspect each item in the resources array and look for one where "datastore_active": true (if present), which indicates DataStore API compatibility. Note the id of that resource since this is your resource_id.