Metadata
base64 encoded application name and email, as in base64("app_name:email"). This value can also be passed in the X-HDX-HAPI-APP-IDENTIFIER header. See the encoded_app_identifier endpoint.
Filter the response by the dataset ID (dataset_hdx_id), which is a unique and fixed identifier of a Dataset on HDX. A URL in the pattern of https://data.humdata.org/dataset/[dataset_hdx_id] will load the dataset page on HDX.
Filter the response by the URL-safe name (dataset_hdx_stub) of the dataset as displayed on HDX. This name is unique but can change. A URL in the pattern of https://data.humdata.org/dataset/[dataset_hdx_stub] will load the dataset page on HDX.
Filter the response by the title of the dataset as it appears in the HDX interface. This name is not unique and can change.
Filter the response by the URL-safe name of the provider (organization) of the dataset on HDX. A URL in the pattern of https://data.humdata.org/organization/[hdx_provider_stub] will load the provider's page on HDX.
Filter the response by the display name of the provider (organization) of the dataset on HDX.
jsonPossible values: Maximum number of records to return. The system will not return more than 10,000 records.
10000Example: 100Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.
0Successful Response
Bad Request
Validation Error
Internal Server Error
GET /api/v2/metadata/dataset?app_identifier=text HTTP/1.1
Host: hapi.humdata.org
Accept: */*
{
"data": [
{
"dataset_hdx_id": "text",
"dataset_hdx_stub": "text",
"dataset_hdx_title": "text",
"hdx_provider_stub": "text",
"hdx_provider_name": "text",
"hdx_link": "https://example.com",
"hdx_api_link": "https://example.com",
"provider_hdx_link": "https://example.com",
"provider_hdx_api_link": "https://example.com"
}
]
}base64 encoded application name and email, as in base64("app_name:email"). This value can also be passed in the X-HDX-HAPI-APP-IDENTIFIER header. See the encoded_app_identifier endpoint.
Filter the response by the resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id] will load the resource page on HDX.
Filter the response by the format of the resource on HDX. These are typically file formats (i.e. CSV, XLSX), but can also include APIs and web apps.
Minimum date that datasets was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00
Maximum date that datasets was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00
Filter the response by whether or not the resource contains HXL tags.
Filter the response by the dataset ID (dataset_hdx_id), which is a unique and fixed identifier of a dataset on HDX. A URL in the pattern of https://data.humdata.org/dataset/[dataset_hdx_id] will load the dataset page on HDX. See the dataset endpoint for details.
Filter the response by the URL-safe name (dataset_hdx_stub) of the dataset as displayed on HDX. This name is unique but can change. A URL in the pattern of https://data.humdata.org/dataset/[dataset_hdx_stub] will load the dataset page on HDX. See the dataset endpoint for details.
Filter the response by the title of the dataset as it appears in the HDX interface. This name is not unique and can change. See the dataset endpoint for details.
Filter the response by the URL-safe name of the provider (organization) of the dataset on HDX. A URL in the pattern of https://data.humdata.org/organization/[dataset_hdx_provider_stub] will load the provider's page on HDX.
Filter the response by the display name of the provider (organization) of the dataset on HDX.
jsonPossible values: Maximum number of records to return. The system will not return more than 10,000 records.
10000Example: 100Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.
0Successful Response
Bad Request
Validation Error
Internal Server Error
GET /api/v2/metadata/resource?app_identifier=text HTTP/1.1
Host: hapi.humdata.org
Accept: */*
{
"data": [
{
"resource_hdx_id": "text",
"dataset_hdx_id": "text",
"name": "text",
"format": "text",
"update_date": "2026-01-01T00:00:00.000Z",
"is_hxl": true,
"download_url": "https://example.com",
"hapi_updated_date": "2026-01-01T00:00:00.000Z",
"dataset_hdx_stub": "text",
"dataset_hdx_title": "text",
"dataset_hdx_provider_stub": "text",
"dataset_hdx_provider_name": "text",
"hdx_link": "https://example.com",
"hdx_api_link": "https://example.com",
"dataset_hdx_link": "https://example.com",
"dataset_hdx_api_link": "https://example.com",
"provider_hdx_link": "https://example.com",
"provider_hdx_api_link": "https://example.com"
}
]
}base64 encoded application name and email, as in base64("app_name:email"). This value can also be passed in the X-HDX-HAPI-APP-IDENTIFIER header. See the encoded_app_identifier endpoint.
Filter the response by a location (typically a country) reference number.
Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes.
Filter the response by a location (typically a country). The location names are based on the "short name" from the UN M49 Standard.
Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.
Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.
Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00
Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59
jsonPossible values: Maximum number of records to return. The system will not return more than 10,000 records.
10000Example: 100Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.
0Successful Response
Bad Request
Validation Error
Internal Server Error
GET /api/v2/metadata/location?app_identifier=text HTTP/1.1
Host: hapi.humdata.org
Accept: */*
{
"data": [
{
"id": 1,
"code": "text",
"name": "text",
"has_hrp": true,
"in_gho": true,
"from_cods": true,
"reference_period_start": "2026-01-01T00:00:00.000Z",
"reference_period_end": "2026-01-01T00:00:00.000Z"
}
]
}base64 encoded application name and email, as in base64("app_name:email"). This value can also be passed in the X-HDX-HAPI-APP-IDENTIFIER header. See the encoded_app_identifier endpoint.
Filter the response by a location (typically a country), using the unique identifier (id) from the location table associated with each entry.
Filter the response by a location (typically a country) reference number.
Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets.
Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source.
Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.
Filter the response by a location (typically a country). The location names are based on the "short name" from the UN M49 Standard. See the location endpoint for details.
Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00
Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59
jsonPossible values: Maximum number of records to return. The system will not return more than 10,000 records.
10000Example: 100Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.
0Successful Response
Bad Request
Validation Error
Internal Server Error
GET /api/v2/metadata/admin1?app_identifier=text HTTP/1.1
Host: hapi.humdata.org
Accept: */*
{
"data": [
{
"id": 1,
"location_ref": 1,
"code": "text",
"name": "text",
"from_cods": true,
"reference_period_start": "2026-01-01T00:00:00.000Z",
"reference_period_end": "2026-01-01T00:00:00.000Z",
"location_code": "text",
"location_name": "text"
}
]
}base64 encoded application name and email, as in base64("app_name:email"). This value can also be passed in the X-HDX-HAPI-APP-IDENTIFIER header. See the encoded_app_identifier endpoint.
Filter the response by a location (typically a country), using the unique identifier (id) from the location table associated with each entry.
Filter the response by a location (typically a country) reference number.
Filter the response by a location (typically a country) reference number.
Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets.
Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source.
Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details.
Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details.
Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.
Filter the response by a location (typically a country). The location names are based on the "short name" from the UN M49 Standard. See the location endpoint for details.
Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00
Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59
jsonPossible values: Maximum number of records to return. The system will not return more than 10,000 records.
10000Example: 100Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.
0Successful Response
Bad Request
Validation Error
Internal Server Error
GET /api/v2/metadata/admin2?app_identifier=text HTTP/1.1
Host: hapi.humdata.org
Accept: */*
{
"data": [
{
"id": 1,
"admin1_ref": 1,
"code": "text",
"name": "text",
"from_cods": true,
"reference_period_start": "2026-01-01T00:00:00.000Z",
"reference_period_end": "2026-01-01T00:00:00.000Z",
"admin1_code": "text",
"admin1_name": "text",
"location_code": "text",
"location_name": "text",
"location_ref": 1
}
]
}base64 encoded application name and email, as in base64("app_name:email"). This value can also be passed in the X-HDX-HAPI-APP-IDENTIFIER header. See the encoded_app_identifier endpoint.
Filter the response by the currency code.
jsonPossible values: Maximum number of records to return. The system will not return more than 10,000 records.
10000Example: 100Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.
0Successful Response
Bad Request
Validation Error
Internal Server Error
GET /api/v2/metadata/currency?app_identifier=text HTTP/1.1
Host: hapi.humdata.org
Accept: */*
{
"data": [
{
"code": "text",
"name": "text"
}
]
}base64 encoded application name and email, as in base64("app_name:email"). This value can also be passed in the X-HDX-HAPI-APP-IDENTIFIER header. See the encoded_app_identifier endpoint.
Filter the response by the standard acronym used to represent the organization. When data is brought into the HDX HAPI database, an attempt is made to standardize the acronyms.
Filter the response by the standard name used to represent the organization. When data is brought into the HDX HAPI database, an attempt is made to standardize the acronyms.
Filter the response by the organization type code.
Filter the response by the organization type description. See the org type endpoint for details.
jsonPossible values: Maximum number of records to return. The system will not return more than 10,000 records.
10000Example: 100Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.
0Successful Response
Bad Request
Validation Error
Internal Server Error
GET /api/v2/metadata/org?app_identifier=text HTTP/1.1
Host: hapi.humdata.org
Accept: */*
{
"data": [
{
"acronym": "text",
"name": "text",
"org_type_code": "text",
"org_type_description": "text"
}
]
}base64 encoded application name and email, as in base64("app_name:email"). This value can also be passed in the X-HDX-HAPI-APP-IDENTIFIER header. See the encoded_app_identifier endpoint.
Filter the response by the organization type code.
Filter the response by the organization type description.
jsonPossible values: Maximum number of records to return. The system will not return more than 10,000 records.
10000Example: 100Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.
0Successful Response
Bad Request
Validation Error
Internal Server Error
GET /api/v2/metadata/org-type?app_identifier=text HTTP/1.1
Host: hapi.humdata.org
Accept: */*
{
"data": [
{
"code": "text",
"description": "text"
}
]
}base64 encoded application name and email, as in base64("app_name:email"). This value can also be passed in the X-HDX-HAPI-APP-IDENTIFIER header. See the encoded_app_identifier endpoint.
Filter the response by the sector code.
Filter the response by the sector name.
jsonPossible values: Maximum number of records to return. The system will not return more than 10,000 records.
10000Example: 100Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.
0Successful Response
Bad Request
Validation Error
Internal Server Error
GET /api/v2/metadata/sector?app_identifier=text HTTP/1.1
Host: hapi.humdata.org
Accept: */*
{
"data": [
{
"code": "text",
"name": "text"
}
]
}base64 encoded application name and email, as in base64("app_name:email"). This value can also be passed in the X-HDX-HAPI-APP-IDENTIFIER header. See the encoded_app_identifier endpoint.
Filter the response by the unique code identifying the commodity.
Filter the response by the food group that the commodity belongs to, available values are described here.
Filter the response by the name of the commodity.
jsonPossible values: Maximum number of records to return. The system will not return more than 10,000 records.
10000Example: 100Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.
0Successful Response
Bad Request
Validation Error
Internal Server Error
GET /api/v2/metadata/wfp-commodity?app_identifier=text HTTP/1.1
Host: hapi.humdata.org
Accept: */*
{
"data": [
{
"code": "text",
"category": "cereals and tubers",
"name": "text"
}
]
}base64 encoded application name and email, as in base64("app_name:email"). This value can also be passed in the X-HDX-HAPI-APP-IDENTIFIER header. See the encoded_app_identifier endpoint.
Filter the response by the unique code identifying the market.
Filter the response by the name of the market.
Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.
Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.
Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.
Filter the response by a location (typically a country). The location names are based on the "short name" from the UN M49 Standard. See the location endpoint for details.
Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details.
Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details.
Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details.
Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details.
Filter the response by admin level.
jsonPossible values: Maximum number of records to return. The system will not return more than 10,000 records.
10000Example: 100Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.
0Successful Response
Bad Request
Validation Error
Internal Server Error
GET /api/v2/metadata/wfp-market?app_identifier=text HTTP/1.1
Host: hapi.humdata.org
Accept: */*
{
"data": [
{
"location_code": "text",
"location_name": "text",
"admin1_code": "text",
"admin1_name": "text",
"admin2_code": "text",
"admin2_name": "text",
"admin_level": 1,
"code": "text",
"name": "text",
"lat": 1,
"lon": 1
}
]
}base64 encoded application name and email, as in base64("app_name:email"). This value can also be passed in the X-HDX-HAPI-APP-IDENTIFIER header. See the encoded_app_identifier endpoint.
Filter the response by a data category
Filter the response by a data subcategory
Minimum date that datasets was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00
Maximum date that datasets was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00
jsonPossible values: Maximum number of records to return. The system will not return more than 10,000 records.
10000Example: 100Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.
0Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.
Filter the response by a location (typically a country). The location names are based on the "short name" from the UN M49 Standard. See the location endpoint for details.
Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details.
Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details.
Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details.
Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details.
Filter the response by admin level.
Successful Response
Bad Request
Validation Error
Internal Server Error
GET /api/v2/metadata/data-availability?app_identifier=text HTTP/1.1
Host: hapi.humdata.org
Accept: */*
{
"data": [
{
"location_code": "text",
"location_name": "text",
"admin1_code": "text",
"admin1_name": "text",
"admin2_code": "text",
"admin2_name": "text",
"admin_level": 1,
"category": "text",
"subcategory": "text",
"hapi_updated_date": "2026-01-01T00:00:00.000Z"
}
]
}Last updated
Was this helpful?