Humanitarian Data Exchange MCP Server
HDX MCP Server provides access to humanitarian data through the Humanitarian Data Exchange (HDX) API - https://data.humdata.org/hapi. This server offers 33 specialized tools for retrieving humanitarian information including affected populations (refugees, IDPs, returnees), baseline demographics, food security indicators, conflict data, funding information, and operational presence across hundreds of countries and territories. See repository for instructions on getting a free HDX_APP_INDENTIFIER for access.
226
29 Tools
Signed
Built by Docker
Requires Secrets
Add to Docker Desktop
Version 4.43 or later needs to be installed to add the server automatically
Tools
| Name | Description |
|---|---|
affected_people_humanitarian_needs_get | OCHA's Humanitarian Needs data, based on the Joint and Intersectoral Analysis Framework (JIAF), provides information about the number of people in need during a crisis. See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/affected_people/#humanitarian-needs">HDX HAPI documentation</a>, and the <a href="https://www.jiaf.info/">original JIAF source</a> website. **Query Parameters:** - **app_identifier** (Required): 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. - **category**: A category combining gender, age range, disability marker and population group information - **sector_code**: Filter the response by the sector code. - **population_status**: Filter the response by the population status, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#population-status">here.</a> - **population_min**: Filter the response by a lower bound for the population. - **population_max**: Filter the response by a upper bound for the population. - **sector_name**: Filter the response by the sector name. - **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan. - **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>. - **start_date**: 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 - **end_date**: 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 - **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin2_code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin2_name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin_level**: Filter the response by admin level. - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "location_code": "string", "location_name": "string", "admin1_code": "unknown_type", "population": 1, "sector_name": "unknown_type", "admin_level": 1, "resource_hdx_id": "string", "admin2_name": "unknown_type", "reference_period_end": "unknown_type", "sector_code": "string", "category": "string", "admin2_code": "unknown_type", "population_status": "AFF", "reference_period_start": "2024-01-01T12:00:00Z", "admin1_name": "unknown_type" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
affected_people_idps_get | Get idps data šÆ **CRITICAL - Data Coverage Warning**: Data coverage is only determined by the metadata_data_availability_get tool. Just because a country is in the system doesn't mean it has data. ALWAYS verify data availability before making data queries. šÆ **CRITICAL - Administrative Level Efficiency**: Before making aggregate queries (totals, country-wide statistics), ALWAYS check data availability using metadata_data_availability_get for the target country. Use the LOWEST available admin level (0=country, 1=state, 2=district) to avoid downloading excessive granular data. For country totals, use admin level 0 if available, otherwise level 1. Never query admin level 2 for simple aggregations when level 0/1 is sufficient. š **Pagination**: You can page through results using `limit` and `offset` parameters (limit=records per page, offset=starting position). ā ļø **CRITICAL - Never Manually Aggregate Data**: IMPORTANT: Never sum data yourself, only take the data verbatim from the tool. NEVER aggregate totals yourself to answer a question if you do not have the values already aggregated from the tool. Do NOT sum up individual records, calculate country-wide statistics from subnational data, or aggregate across time periods/demographics yourself. If data is not pre-aggregated, inform the user that aggregate data is not available. Always use the most appropriate administrative level that has pre-aggregated data. **Query Parameters:** - **app_identifier** (Required): 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. - **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan. - **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>. - **start_date**: 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 - **end_date**: 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 - **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin2_code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin2_name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin_level**: Filter the response by admin level. - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "location_code": "string", "location_name": "string", "admin1_code": "unknown_type", "operation": "string", "population": 1, "admin_level": 1, "resource_hdx_id": "string", "admin2_name": "unknown_type", "reference_period_end": "unknown_type", "admin2_code": "unknown_type", "assessment_type": "BA", "reference_period_start": "2024-01-01T12:00:00Z", "admin1_name": "unknown_type", "reporting_round": 1 } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
affected_people_refugees_get | UNHCR's Refugee data provides information about displaced people in a crisis. See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/affected_people/#refugees-persons-of-concern">HDX HAPI documentation</a>, and the <a href="https://data.humdata.org/dataset/unhcr-population-data-for-world">original HDX source</a> website. **Query Parameters:** - **app_identifier** (Required): 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. - **population_group**: Filter the response by the population group, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#population-group">here.</a> - **population_min**: Filter the response by a lower bound for the population. - **population_max**: Filter the response by a upper bound for the population. - **gender**: Filter the response by the gender, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#gender">here.</a> - **age_range**: Filter the response by the age range. These are expressed as [start age]-[end age], or [start age]+ for an age range starting at [start age] or above. The end age is assumed to be inclusive, though that is not always explicit in the source data. - **origin_location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **origin_location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **origin_has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan. - **origin_in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>. - **asylum_location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **asylum_location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **asylum_has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan. - **asylum_in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>. - **start_date**: 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 - **end_date**: 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 - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "resource_hdx_id": "string", "population_group": "REF", "gender": "f", "population": 1, "max_age": "unknown_type", "min_age": "unknown_type", "reference_period_end": "unknown_type", "origin_location_code": "string", "age_range": "string", "asylum_location_code": "string", "asylum_location_name": "string", "origin_location_name": "string", "reference_period_start": "2024-01-01T12:00:00Z" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
affected_people_returnees_get | Get returnees data šÆ **CRITICAL - Data Coverage Warning**: Data coverage is only determined by the metadata_data_availability_get tool. Just because a country is in the system doesn't mean it has data. ALWAYS verify data availability before making data queries. šÆ **CRITICAL - Administrative Level Efficiency**: Before making aggregate queries (totals, country-wide statistics), ALWAYS check data availability using metadata_data_availability_get for the target country. Use the LOWEST available admin level (0=country, 1=state, 2=district) to avoid downloading excessive granular data. For country totals, use admin level 0 if available, otherwise level 1. Never query admin level 2 for simple aggregations when level 0/1 is sufficient. š **Pagination**: You can page through results using `limit` and `offset` parameters (limit=records per page, offset=starting position). ā ļø **CRITICAL - Never Manually Aggregate Data**: IMPORTANT: Never sum data yourself, only take the data verbatim from the tool. NEVER aggregate totals yourself to answer a question if you do not have the values already aggregated from the tool. Do NOT sum up individual records, calculate country-wide statistics from subnational data, or aggregate across time periods/demographics yourself. If data is not pre-aggregated, inform the user that aggregate data is not available. Always use the most appropriate administrative level that has pre-aggregated data. **Query Parameters:** - **app_identifier** (Required): 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. - **population_group**: Filter the response by the population group, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#population-group">here.</a> - **gender**: Filter the response by the gender, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#gender">here.</a> - **age_range**: Filter the response by the age range. These are expressed as [start age]-[end age], or [start age]+ for an age range starting at [start age] or above. The end age is assumed to be inclusive, though that is not always explicit in the source data. - **min_age**: The minimum age from `age_range`, set to `null` if `age_range` is "all" and there is no age disaggregation - **max_age**: The maximum age from `age_range`, set to `null` if `age_range` is "all" and there is no age disaggregation, or if there is no upper limit to the age range - **origin_location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **origin_location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **origin_has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan. - **origin_in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>. - **asylum_location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **asylum_location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **asylum_has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan. - **asylum_in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>. - **start_date**: 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 - **end_date**: 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 - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "resource_hdx_id": "string", "population_group": "REF", "gender": "f", "population": 1, "max_age": "unknown_type", "min_age": "unknown_type", "reference_period_end": "unknown_type", "origin_location_code": "string", "age_range": "string", "asylum_location_code": "string", "asylum_location_name": "string", "origin_location_name": "string", "reference_period_start": "2024-01-01T12:00:00Z" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
baseline_population_get | Baseline population data sourced and maintained by UNFPA (UN Population Fund). See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/population_and_socio-economy/#baseline-population">HDX HAPI documentation</a>, and the <a href="https://data.humdata.org/organization/unfpa">UNFPA on HDX</a>. **Query Parameters:** - **app_identifier** (Required): 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. - **gender**: Filter the response by the gender, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#gender">here.</a> - **age_range**: Filter the response by the age range. These are expressed as [start age]-[end age], or [start age]+ for an age range starting at [start age] or above. The end age is assumed to be inclusive, though that is not always explicit in the source data. - **population_min**: Filter the response by a lower bound for the population. - **population_max**: Filter the response by a upper bound for the population. - **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan. - **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>. - **start_date**: 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 - **end_date**: 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 - **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin2_code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin2_name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin_level**: Filter the response by admin level. - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "location_code": "string", "location_name": "string", "admin1_code": "unknown_type", "population": 1, "admin_level": 1, "min_age": "unknown_type", "resource_hdx_id": "string", "admin2_name": "unknown_type", "max_age": "unknown_type", "reference_period_end": "unknown_type", "admin2_code": "unknown_type", "gender": "f", "age_range": "string", "reference_period_start": "unknown_type", "admin1_name": "unknown_type" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
climate_rainfall_get | Rainfall data . See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/ **Query Parameters:** - **app_identifier** (Required): 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. - **aggregation_period**: Filter the response by the aggregation period, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#aggregation-period">here.</a> - **version**: Version rainfall - **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan. - **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>. - **start_date**: 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 - **end_date**: 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 - **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin2_code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin2_name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin_level**: Filter the response by admin level. - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "location_code": "string", "location_name": "string", "admin1_code": "unknown_type", "rainfall": 1.5, "provider_admin1_code": "unknown_type", "rainfall_long_term_average": 1.5, "admin_level": 1, "number_pixels": "unknown_type", "resource_hdx_id": "string", "admin2_name": "unknown_type", "reference_period_end": "unknown_type", "rainfall_anomaly_pct": 1.5, "admin2_code": "unknown_type", "provider_admin2_code": "unknown_type", "aggregation_period": "dekad", "version": "unknown_type", "reference_period_start": "unknown_type", "admin1_name": "unknown_type" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
coordination_conflict_events_get | Armed Conflict Location & Events Data from ACLED. See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/coordination_and_context/#conflict-events">HDX HAPI documentation</a>, and the <a href="https://acleddata.com/">original ACLED source</a> website. **Query Parameters:** - **app_identifier** (Required): 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. - **event_type**: Filter the response by the ACLED event-type categories (non-mutually exclusive), available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#event-type">here.</a> - **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan. - **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>. - **start_date**: 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 - **end_date**: 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 - **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin2_code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin2_name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin_level**: Filter the response by admin level. - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "location_code": "string", "location_name": "string", "admin1_code": "unknown_type", "admin_level": 1, "resource_hdx_id": "string", "admin2_name": "unknown_type", "reference_period_end": "unknown_type", "event_type": "civilian_targeting", "admin2_code": "unknown_type", "fatalities": "unknown_type", "events": "unknown_type", "reference_period_start": "2024-01-01T12:00:00Z", "admin1_name": "unknown_type" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
coordination_funding_get | OCHA's funding data from the Financial Tracking Service provides information on humanitarian aid contributions. See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/coordination_and_context/#funding">HDX HAPI documentation</a>, and the <a href="https://fts.unocha.org/home/2024/donors/view">original FTS source</a> website. **Query Parameters:** - **app_identifier** (Required): 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. - **appeal_code**: Filter the response by a unique code given by FTS to each appeal - **appeal_type**: Filter the respinse by the type of the appeal, such as flash or HRP - **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan. - **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>. - **start_date**: 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 - **end_date**: 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 - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "resource_hdx_id": "string", "appeal_code": "string", "appeal_name": "string", "funding_usd": 1.5, "appeal_type": "unknown_type", "reference_period_end": "unknown_type", "location_code": "string", "location_name": "string", "funding_pct": "unknown_type", "requirements_usd": "unknown_type", "reference_period_start": "2024-01-01T12:00:00Z" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
coordination_national_risk_get | European Commission national risk data from the INFORM-risk framework. See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/coordination_and_context/#national-risk">HDX HAPI documentation</a>, and the <a href="https://drmkc.jrc.ec.europa.eu/inform-index/INFORM-Risk">original INFORM-risk source</a> website. **Query Parameters:** - **app_identifier** (Required): 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. - **risk_class**: Filter the response by the INFORM risk class, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#risk-class">here.</a> - **global_rank_min**: Filter the response by a lower bound for the Global Rank. - **global_rank_max**: Filter the response by an upper bound for the Global Rank. - **overall_risk_min**: Filter the response by a lower bound for the Overall Risk. - **overall_risk_max**: Filter the response by an upper bound for the Overall Risk. - **hazard_exposure_risk_min**: Filter the response by a lower bound for the Hazard Exposure Risk. - **hazard_exposure_risk_max**: Filter the response by an upper bound for the Hazard Exposure Risk. - **vulnerability_risk_min**: Filter the response by a lower bound for the Vulnerability Risk. - **vulnerability_risk_max**: Filter the response by an upper bound for the Vulnerability Risk. - **coping_capacity_risk_min**: Filter the response by a lower bound for the Coping Capacity Risk. - **coping_capacity_risk_max**: Filter the response by a lower bound for the Coping Capacity Risk. - **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan. - **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>. - **start_date**: 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 - **end_date**: 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 - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "risk_class": "1", "global_rank": 1, "overall_risk": 1.5, "resource_hdx_id": "string", "reference_period_end": "unknown_type", "location_code": "string", "location_name": "string", "vulnerability_risk": 1.5, "hazard_exposure_risk": 1.5, "meta_missing_indicators_pct": "unknown_type", "coping_capacity_risk": 1.5, "meta_avg_recentness_years": "unknown_type", "reference_period_start": "unknown_type" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
coordination_operational_presence_get | OCHA's 3W (Who is doing What Where) Operational Presence data provides information about which organizations are working in different locations affected by a crisis. See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/coordination_and_context/#who-is-doing-what-where-operational-presence">HDX HAPI documentation</a>, and the <a href="https://3w.unocha.org/">original OCHA 3W source</a> website. **Query Parameters:** - **app_identifier** (Required): 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. - **sector_code**: Filter the response by sector codes, which describe the humanitarian sector to which the operational presence applies. Use the metadata_sector_get tool to get available sector codes and names. - **sector_name**: Filter the response by sector names, which describe the humanitarian sector to which the operational presence applies. Use the metadata_sector_get tool to get available sector codes and names. - **org_acronym**: Filter the response by the acronym of the organization to which the operational presence applies. Use the metadata_org_get tool to get available organization codes and names. - **org_name**: Filter the response by the name of the organization to which the operational presence applies. Use the metadata_org_get tool to get available organization codes and names. - **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan. - **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>. - **start_date**: 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 - **end_date**: 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 - **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin2_code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin2_name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin_level**: Filter the response by admin level. - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "location_code": "string", "location_name": "string", "admin1_code": "unknown_type", "sector_name": "string", "admin_level": 1, "resource_hdx_id": "string", "admin2_name": "unknown_type", "org_name": "string", "sector_code": "string", "reference_period_end": "unknown_type", "admin2_code": "unknown_type", "org_acronym": "string", "org_type_code": "unknown_type", "org_type_description": "unknown_type", "reference_period_start": "2024-01-01T12:00:00Z", "admin1_name": "unknown_type" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
food_prices_get | The World Food Programme (WFP) food prices data provides information about food prices for a range of commodities at markets across the world. See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/food_security_and_nutrition/#food-prices">HDX HAPI documentation</a>, and the <a href="https://dataviz.vam.wfp.org/economic/prices">original WFP source</a> website. **Query Parameters:** - **app_identifier** (Required): 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. - **market_code**: Filter the response by the unique code identifying the market - **market_name**: Filter the response by the name of the market - **commodity_code**: Filter the response by the unique code identifying the commodity - **commodity_category**: Filter the response by the food group that the commodity belongs to, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#commodity-category">here.</a> - **commodity_name**: Filter the response by the name of the commodity - **price_flag**: Filter the response by the pre-processing characteristics of food prices, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#price-flag">here.</a> - **price_type**: Filter the response by the point in the supply chain at which the price is determined, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#price-type">here.</a> - **price_min**: Filter the response by a lower bound for the price. - **price_max**: Filter the response by a upper bound for the price. - **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan. - **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>. - **start_date**: 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 - **end_date**: 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 - **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin2_code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin2_name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin_level**: Filter the response by admin level. - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "location_code": "string", "location_name": "string", "admin1_code": "unknown_type", "lon": "unknown_type", "admin2_name": "unknown_type", "admin2_code": "unknown_type", "price": 1.5, "commodity_name": "string", "currency_code": "string", "resource_hdx_id": "string", "market_name": "string", "admin_level": 1, "reference_period_end": "unknown_type", "price_flag": "actual", "commodity_category": "cereals and tubers", "market_code": "string", "reference_period_start": "2024-01-01T12:00:00Z", "unit": "string", "commodity_code": "string", "price_type": "Farm Gate", "lat": "unknown_type", "admin1_name": "unknown_type" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
food_security_get | Integrated Food Security Phase Classification from the IPC. See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/food_security_and_nutrition/#food-security">HDX HAPI documentation</a>, and the <a href="https://www.ipcinfo.org/ipcinfo-website/ipc-overview-and-classification-system/ipc-acute-food-insecurity-classification/en/">original IPC source</a> website. **Query Parameters:** - **app_identifier** (Required): 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. - **ipc_phase**: Filter the response by the IPC phase, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#ipc-code">here.</a> - **ipc_type**: Filter the response by the IPC type, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#ipc-type">here.</a> - **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan. - **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>. - **start_date**: 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 - **end_date**: 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 - **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin2_code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin2_name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin_level**: Filter the response by admin level. - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "location_code": "string", "location_name": "string", "admin1_code": "unknown_type", "ipc_type": "string", "admin_level": 1, "resource_hdx_id": "string", "admin2_name": "unknown_type", "reference_period_end": "unknown_type", "admin2_code": "unknown_type", "population_fraction_in_phase": 1.5, "ipc_phase": "string", "population_in_phase": 1, "reference_period_start": "unknown_type", "admin1_name": "unknown_type" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
hdx_get_dataset_info | Get detailed information about a specific HDX dataset. |
hdx_search_locations | Search for locations (countries) in the HDX system. |
hdx_server_info | Get information about the HDX MCP server instance. |
metadata_admin1_get | Not all data are available for all locations. Learn more about the scope of data coverage in HDX HAPI in the <a href="https://hdx-hapi.readthedocs.io/en/latest/">Overview and Getting Started</a> documentation. **Query Parameters:** - **app_identifier** (Required): 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. - **id**: Filter the response by a location (typically a country), using the unique identifier (id) from the location table associated with each entry. - **location_ref**: Filter the response by a location (typically a country) reference number. - **code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. - **name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. - **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **start_date**: 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 - **end_date**: 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 - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "id": 1, "location_ref": 1, "code": "string", "reference_period_end": "unknown_type", "location_code": "string", "name": "string", "location_name": "string", "from_cods": true, "reference_period_start": "2024-01-01T12:00:00Z" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
metadata_admin2_get | Not all data are available for all locations. Learn more about the scope of data coverage in HDX HAPI in the <a href="https://hdx-hapi.readthedocs.io/en/latest/">Overview and Getting Started</a> documentation. **Query Parameters:** - **app_identifier** (Required): 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. - **id**: Filter the response by a location (typically a country), using the unique identifier (id) from the location table associated with each entry. - **admin1_ref**: Filter the response by a location (typically a country) reference number. - **location_ref**: Filter the response by a location (typically a country) reference number. - **code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. - **name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. - **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names. - **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **start_date**: 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 - **end_date**: 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 - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "id": 1, "admin1_ref": 1, "code": "string", "admin1_code": "string", "reference_period_end": "unknown_type", "location_code": "string", "name": "string", "location_name": "string", "location_ref": 1, "from_cods": true, "reference_period_start": "2024-01-01T12:00:00Z", "admin1_name": "string" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
metadata_currency_get | Provide currency information to use in conjunction with the food-prices endpoint **Query Parameters:** - **app_identifier** (Required): 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. - **code**: Filter the response by the currency code. - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "code": "string", "name": "string" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
metadata_data_availability_get | Provide currency information to use in conjunction with the food-prices endpoint **Query Parameters:** - **app_identifier** (Required): 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. - **category**: Filter the response by a data category - **subcategory**: Filter the response by a data subcategory - **hapi_updated_date_min**: Minimum date that datasets was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00 - **hapi_updated_date_max**: Maximum date that datasets was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00 - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. - **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin2_code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin2_name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin_level**: Filter the response by admin level. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "location_code": "string", "location_name": "string", "admin1_code": "unknown_type", "admin_level": 1, "admin2_name": "unknown_type", "category": "string", "admin2_code": "unknown_type", "subcategory": "string", "hapi_updated_date": "unknown_type", "admin1_name": "unknown_type" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
metadata_dataset_get | Get information about the <a href="https://data.humdata.org/dataset">HDX Datasets</a> that are used as data sources for HDX HAPI. Datasets contain one or more resources, which are the sources of the data found in HDX HAPI. **Query Parameters:** - **app_identifier** (Required): 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. - **dataset_hdx_id**: 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. - **dataset_hdx_stub**: 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. - **dataset_hdx_title**: Filter the response by the title of the dataset as it appears in the HDX interface. This name is not unique and can change. - **hdx_provider_stub**: 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. - **hdx_provider_name**: Filter the response by the display name of the provider (organization) of the dataset on HDX. - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "dataset_hdx_id": "string", "dataset_hdx_stub": "string", "dataset_hdx_title": "string", "provider_hdx_api_link": "string", "provider_hdx_link": "string", "hdx_provider_name": "string", "hdx_provider_stub": "string", "hdx_api_link": "string", "hdx_link": "string" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
metadata_location_get | Not all data are available for all locations. Learn more about the scope of data coverage in HDX HAPI in the <a href="https://hdx-hapi.readthedocs.io/en/latest/">Overview and Getting Started</a> documentation. **Query Parameters:** - **app_identifier** (Required): 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. - **id**: Filter the response by a location (typically a country) reference number. - **code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. - **name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. - **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan. - **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>. - **start_date**: 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 - **end_date**: 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 - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "id": 1, "code": "string", "name": "string", "has_hrp": true, "reference_period_end": "unknown_type", "in_gho": true, "from_cods": true, "reference_period_start": "2024-01-01T12:00:00Z" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
metadata_org_get | Get the list of organizations represented in the data available in HDX HAPI š **Pagination**: You can page through results using `limit` and `offset` parameters (limit=records per page, offset=starting position). **Query Parameters:** - **app_identifier** (Required): 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. - **acronym**: 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. - **name**: 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. - **org_type_code**: Filter the response by the organization type code. - **org_type_description**: Filter the response by the organization type description. Use the metadata_org_type_get tool to get available organization type codes and descriptions. - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "acronym": "string", "name": "string", "org_type_code": "unknown_type", "org_type_description": "unknown_type" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
metadata_org_type_get | There is no agreed standard for the classification of organizations. The codes and descriptions used in HDX HAPI are based on <a href="https://data.humdata.org/dataset/organization-types-beta">this dataset</a>. **Query Parameters:** - **app_identifier** (Required): 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. - **code**: Filter the response by the organization type code. - **description**: Filter the response by the organization type description. - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "code": "string", "description": "string" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
metadata_resource_get | Get information about the resources that are used as data sources for HDX HAPI. Datasets contain one or more resources, which are the sources of the data found in HDX HAPI. **Query Parameters:** - **app_identifier** (Required): 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. - **resource_hdx_id**: 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. - **format**: 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. - **update_date_min**: Minimum date that datasets was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00 - **update_date_max**: Maximum date that datasets was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00 - **is_hxl**: Filter the response by whether or not the resource contains <a href="https://hxlstandard.org/">HXL tags</a>. - **dataset_hdx_id**: 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. Use the metadata_dataset_get tool to get available dataset information. - **dataset_hdx_stub**: 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. Use the metadata_dataset_get tool to get available dataset information. - **dataset_hdx_title**: Filter the response by the title of the dataset as it appears in the HDX interface. This name is not unique and can change. Use the metadata_dataset_get tool to get available dataset information. - **dataset_hdx_provider_stub**: 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. - **dataset_hdx_provider_name**: Filter the response by the display name of the provider (organization) of the dataset on HDX. - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "resource_hdx_id": "string", "dataset_hdx_id": "string", "name": "string", "dataset_hdx_provider_name": "string", "dataset_hdx_stub": "string", "is_hxl": true, "dataset_hdx_api_link": "string", "provider_hdx_link": "string", "provider_hdx_api_link": "string", "dataset_hdx_provider_stub": "string", "format": "string", "hdx_api_link": "string", "dataset_hdx_link": "string", "hapi_updated_date": "2024-01-01T12:00:00Z", "dataset_hdx_title": "string", "hdx_link": "string", "download_url": "string", "update_date": "2024-01-01T12:00:00Z" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
metadata_sector_get | There are a variety of standards for the naming of humanitarian sectors. The codes and descriptions used in HDX HAPI are based on <a href="https://data.humdata.org/organization/54255d0b-c6b1-4517-9722-17321f6634ab">this dataset</a>. **Query Parameters:** - **app_identifier** (Required): 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. - **code**: Filter the response by the sector code. - **name**: Filter the response by the sector name. - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "code": "string", "name": "string" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
metadata_wfp_commodity_get | Provide commodity information to use in conjunction with the food-prices endpoint **Query Parameters:** - **app_identifier** (Required): 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. - **code**: Filter the response by the unique code identifying the commodity. - **category**: Filter the response by the food group that the commodity belongs to, available values are described <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/enums/#commodity-category">here.</a> - **name**: Filter the response by the name of the commodity. - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "code": "string", "category": "cereals and tubers", "name": "string" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
metadata_wfp_market_get | Provide physical market location information to use in conjunction with the food-prices endpoint **Query Parameters:** - **app_identifier** (Required): 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. - **code**: Filter the response by the unique code identifying the market. - **name**: Filter the response by the name of the market. - **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan. - **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>. - **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin2_code**: Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin2_name**: Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin2_get tool to get available admin2 codes and names. - **admin_level**: Filter the response by admin level. - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "location_code": "string", "location_name": "string", "admin1_code": "unknown_type", "lon": "unknown_type", "admin_level": 1, "admin2_name": "unknown_type", "code": "string", "admin2_code": "unknown_type", "name": "string", "lat": "unknown_type", "admin1_name": "unknown_type" } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
poverty_rate_get | Poverty rate data from the Oxford Department of International Development. See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/population_and_socio-economy/#poverty-rate">HDX HAPI documentation</a>, and the <a href="https://ophi.org.uk/global-mpi">Oxford Department of International Development</a> website. **Query Parameters:** - **app_identifier** (Required): 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. - **mpi_min**: Multidimensional Poverty Index (MPI), lower bound. - **mpi_max**: Multidimensional Poverty Index (MPI), upper bound. - **has_hrp**: Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan. - **in_gho**: Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>. - **start_date**: 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 - **end_date**: 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 - **location_code**: Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. Use the metadata_location_get tool to get available location codes and names. - **location_name**: Filter the response by a location (typically a country). The location names are based on the "short name" from the <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. Use the metadata_location_get tool to get available location codes and names. - **admin1_code**: Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin1_name**: Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. Use the metadata_admin1_get tool to get available admin1 codes and names. - **admin_level**: Filter the response by admin level. - **output_format**: No description. - **limit**: Maximum number of records to return. The system will not return more than 10,000 records. - **offset**: Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "data": [ { "location_code": "string", "location_name": "string", "admin1_code": "unknown_type", "admin_level": 1, "resource_hdx_id": "string", "reference_period_end": "unknown_type", "mpi": 1.5, "intensity_of_deprivation": "unknown_type", "in_severe_poverty": 1.5, "vulnerable_to_poverty": 1.5, "reference_period_start": "unknown_type", "admin1_name": "unknown_type", "headcount_ratio": 1.5 } ] } ``` - **400**: Bad Request - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": "string" } ``` - **422**: Validation Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "detail": [ { "loc": [ "unknown_type" ], "msg": "string", "type": "string" } ] } ``` - **500**: Internal Server Error - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "error_sample_list": [ "unknown" ], "error": "string" } ``` |
util_version_get | Display the API and SQL Alchemy versions š **Pagination**: You can page through results using `limit` and `offset` parameters (limit=records per page, offset=starting position). **Responses:** - **200** (Success): Successful Response - Content-Type: `application/json` - **Response Properties:** - **Example:** ```json { "api_version": "string", "hapi_sqlalchemy_schema_version": "string" } ``` |
Manual installation
You can install the MCP server using:
Installation for