Testing: DataStore API

A guide to accessing, filtering, and integrating HDX tabular data through the Datastore API.

Note: This material is for alpha testing of a new HDX API endpoint built on CKAN's DataStore. It is not yet official documentation.

Introduction

The HDX DataStore API provides programmatic access to a number of tabular datasets hosted on HDX. It supports features like customizable queries and dataset joins to enable seamless integration into external tools and systems. By allowing real-time querying of tabular data, HDX DataStore API makes it easier for developers, analysts, and humanitarian responders to automatically integrate HDX data into their workflows.

The HDX DataStore API is powered by the CKAN DataStore extension.

The following documentation is intended for analysts and technical audiences to configure the API, troubleshoot, integrate with tools, and learn from working examples.

Building a HDX DataStore API Query

With your API token and the resource_id (see HDX Core Concepts section for more information), you have the key components needed to configure an HDX DataStore API query. The diagram below shows how these elements fit together; the different endpoints are explained in the following sections.

This diagram shows the basic elements of an HDX DataStore API query.

Feedback and Support

We are always adding new features and additional datasets into the HDX DataStore API. If you would like to request either a new feature or think a critical dataset is missing, please let us know!

Report bugs and request features by emailing [e-mail].