HDX HAPI Humanitarian Needs (PIN)
hdx-hapi.coordination.humanitarian_needsRead-onlyIdempotent
Get People-in-Need (PIN) figures broken down by sector, category (age/gender/disability), and population_status (affected/in-need/targeted/reached). Filter by location_code (ISO3), sector_name, population_status, admin1_name, and admin_level. Data: HDX Humanitarian API (hapi.humdata.org), run by UN OCHA Centre for Humanitarian Data, CC BY 4.0, no auth required.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "hdx-hapi.coordination.humanitarian_needs"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum rows to return (1-1000, default 100) | |
| offset | No | Number of rows to skip, for pagination (default 0) | |
| admin1_name | No | 1st-level subnational admin area name to filter results, e.g. "Kayes" | |
| admin_level | No | Admin granularity of returned rows: 0=national, 1=admin1, 2=admin2 | |
| sector_name | No | Humanitarian sector name to filter results, e.g. "Health", "Food Security" | |
| location_code | No | ISO3 country code to filter results, e.g. "MLI", "AFG", "SOM" | |
| location_name | No | Country name to filter results (alternative to location_code), e.g. "Mali" | |
| population_status | No | Population status: AFF=affected, INN=in need, TGT=targeted, REA=reached, all=all statuses |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present only when the call failed. Includes error code, message, request_id, and any provider-specific extras. | |
| result | No | Tool response payload. Shape varies per tool — consult the tool description and inputSchema. May be an object, array, string, or number depending on the upstream provider response. |