index.md

Overview

---

The HDX Humanitarian API (HDX HAPI) is a way to access standardised indicators from multiple sources to automate workflows and visualisations.

HDX HAPI is in beta phase, and we are seeking feedback. To share your thoughts or join our slack channel, send an email to hdx@un.org.

The initial scope of HDX HAPI will be the data included in the HDX Data Grids. Work is ongoing to add more data.

App Identifier

To access HDX HAPI you need to generate an API identifier. This can be done via the the sandbox interface encode_identifier endpoint. Enter your application name and email address and it will return the app identifier. The key must be included as a query string parameter e.g.

https://hapi.humdata.org/api/v1/themes/3w?app_identifier={your app identifier}

The Structure of HDX HAPI

Data Subcategory Endpoints

HDX HAPI is organised around a set of key humanitarian data subcategories like Baseline Population and Conflict Events. Each of these subcategories can be queried via its endpoint.

Current list of data subcategory endpoints in HAPI

Affected People

• Refugees & Persons of Concern
• Humanitarian Needs

Coordination & Context

• Who is Doing What Where - Operational Presence
• Funding
• Conflict Events
• National Risk

Food Security & Nutrition

• Food Security
• Food Prices

Population & Socio-economy

• Baseline Population
• Poverty Rate

Terms Of Use

Use of HDX HAPI is governed by the HDX HAPI Terms of Use.

FAQS

Please refer to the landing page for non-technical FAQs