Metadata endpoints
A guide to accessing and cataloguing HDX data through the metadata endpoints.
Last updated
Was this helpful?
A guide to accessing and cataloguing HDX data through the metadata endpoints.
The HDX metadata endpoints provide programmatic access to metadata on HDX. They allow users to search, filter, and retrieve detailed information about organizations and data on the platform. This enables users to discover data and data contributors to programmatically automate data management.
The HDX Metadata endpoints are powered by the CKAN API and provide two main functions:
package_search: Search and filter datasets with advanced query capabilities
package_show: Retrieve detailed metadata for a specific dataset
This documentation is designed for analysts and technical audiences who want to discover datasets, build automated workflows, or integrate HDX data into external systems.
There are two main Metadata Endpoints that can be queried, each accessed via their own endpoint.
Searching Catalogue (package_search)
Dataset schema (package_show)
HDX is built on CKAN, an open source data management platform. Additional CKAN endpoints exist beyond those listed above, but these are the most relevant for working with HDX. For more detailed information, please see the CKAN documentation for APIs.
We are always adding new features and additional datasets into the HDX API endpoints. 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 hdx@un.org.
Last updated
Was this helpful?
Was this helpful?