> For the complete documentation index, see [llms.txt](https://docs.humdata.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.humdata.org/build/hdx-apis/hapi/api-reference.md). # API reference ## 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**. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.humdata.org/build/hdx-apis/hapi/api-reference.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.