Welcome to the new home of the HDX FAQ
For the complete documentation index, see llms.txt. This page is also available as Markdown.

API reference

Full parameter and response reference for HAPI.

API reference

This reference is generated directly from HAPI. It lists every endpoint, its parameters, and the fields it returns, grouped by theme in the pages below.

Every request needs an app identifier, passed as the app_identifier parameter or the X-HDX-HAPI-APP-IDENTIFIER header. You can also try any endpoint live in the interactive sandbox at hapi.humdata.org/docs.

Browse by theme

  • Generate App Identifier: Create the identifier every request needs

  • Affected People: Humanitarian needs, refugees and persons of concern, IDPs, returnees

  • Coordination & Context: Conflict events, funding, national risk, operational presence

  • Food Security, Nutrition & Poverty: Food prices, food security phases, poverty rate

  • Geography & Infrastructure: Baseline population

  • Climate: Rainfall and related indicators

  • Metadata: Supporting reference tables: admin levels, sectors, organizations, currencies, resources

  • Util: Service and utility endpoints

  • Models: The data schemas shared across endpoints

To generate a client or import HAPI into your own tools, use Download OpenAPI spec.

Last updated

Was this helpful?