{ "openapi": "3.1.0", "info": { "title": "HDX HAPI", "description": "\nThe Humanitarian API (HDX HAPI) is a service of the \nHumanitarian Data Exchange (HDX), part of OCHA's \nCentre for Humanitarian Data.\n\nThis is the reference documentation of the API. \nYou may want to get started here.\n\nAll queries require an `app_identifier` which can be supplied as a query parameter or as a header \n(`X-HDX-HAPI-APP-IDENTIFIER`). The `app_identifier` is simply a base64 encoded version of a user supplied\napplication name and email address.\n\nThe `limit` and `offset` parameters are available for all queries and have the usual database meanings \nto provide pagination of results. If no `limit` is specified, a maximum of 10,000 records will be returned.\n\nThe `output_format` parameter is available for all queries and can be set to JSON or csv, \nwhere JSON is selected rows of data are supplied under a data key.\n\nQuery parameters that access string fields are implicitly wildcards and case insensitive \nso that `location_name=Mali` will return data for Mali and Somalia.\n", "version": "0.9.13" }, "servers": [ { "url": "https://hapi.humdata.org", "description": "Production" } ], "paths": { "/api/v2/encode_app_identifier": { "get": { "tags": [ "Generate App Identifier" ], "summary": "Get an app identifier by encoding an application name and email", "description": "Encode an application name and email address in base64 to serve as an client identifier in HDX HAPI calls.", "operationId": "get_encoded_identifier_api_v2_encode_app_identifier_get", "parameters": [ { "name": "application", "in": "query", "required": true, "schema": { "type": "string", "minLength": 4, "maxLength": 512, "description": "A name for the calling application.", "title": "Application" }, "description": "A name for the calling application." }, { "name": "email", "in": "query", "required": true, "schema": { "type": "string", "format": "email", "maxLength": 512, "description": "An email address.", "title": "Email" }, "description": "An email address." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentifierResponse" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/affected-people/refugees-persons-of-concern": { "get": { "tags": [ "Affected People" ], "summary": "Get refugees data", "description": "UNHCR's Refugee data provides information about displaced people in a crisis. See the more detailed technical HDX HAPI documentation, and the original HDX source website.", "operationId": "get_refugees_api_v2_affected_people_refugees_persons_of_concern_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "population_group", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PopulationGroup", "maxLength": 32 }, { "type": "null" } ], "description": "Filter the response by the population group, available values are described here.", "title": "Population Group" }, "description": "Filter the response by the population group, available values are described here." }, { "name": "population_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter the response by a lower bound for the population.", "title": "Population Min" }, "description": "Filter the response by a lower bound for the population." }, { "name": "population_max", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter the response by a upper bound for the population.", "title": "Population Max" }, "description": "Filter the response by a upper bound for the population." }, { "name": "gender", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/Gender", "maxLength": 3 }, { "type": "null" } ], "description": "Filter the response by the gender, available values are described here.", "title": "Gender" }, "description": "Filter the response by the gender, available values are described here." }, { "name": "age_range", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "description": "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.", "title": "Age Range" }, "description": "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." }, { "name": "origin_location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Origin Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "origin_location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Origin Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "origin_has_hrp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.", "title": "Origin Has Hrp" }, "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan." }, { "name": "origin_in_gho", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.", "title": "Origin In Gho" }, "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview." }, { "name": "asylum_location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Asylum Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "asylum_location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Asylum Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "asylum_has_hrp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.", "title": "Asylum Has Hrp" }, "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan." }, { "name": "asylum_in_gho", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.", "title": "Asylum In Gho" }, "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "Start Date" }, "description": "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" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "End Date" }, "description": "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" }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_RefugeesResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/affected-people/humanitarian-needs": { "get": { "tags": [ "Affected People" ], "summary": "Get humanitarian needs data", "description": "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 HDX HAPI documentation, and the original JIAF source website.", "operationId": "get_humanitarian_needs_api_v2_affected_people_humanitarian_needs_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "category", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "A category combining gender, age range, disability marker and population group information", "title": "Category" }, "description": "A category combining gender, age range, disability marker and population group information" }, { "name": "sector_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "description": "Filter the response by the sector code.", "title": "Sector Code" }, "description": "Filter the response by the sector code." }, { "name": "population_status", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PopulationStatus", "maxLength": 32 }, { "type": "null" } ], "description": "Filter the response by the population status, available values are described here.", "title": "Population Status" }, "description": "Filter the response by the population status, available values are described here." }, { "name": "population_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter the response by a lower bound for the population.", "title": "Population Min" }, "description": "Filter the response by a lower bound for the population." }, { "name": "population_max", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter the response by a upper bound for the population.", "title": "Population Max" }, "description": "Filter the response by a upper bound for the population." }, { "name": "sector_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the sector name.", "title": "Sector Name" }, "description": "Filter the response by the sector name." }, { "name": "has_hrp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.", "title": "Has Hrp" }, "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan." }, { "name": "in_gho", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.", "title": "In Gho" }, "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "Start Date" }, "description": "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" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "End Date" }, "description": "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" }, { "name": "location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "admin1_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details.", "title": "Admin1 Code" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details." }, { "name": "admin1_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details.", "title": "Admin1 Name" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details." }, { "name": "admin2_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details.", "title": "Admin2 Code" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details." }, { "name": "admin2_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details.", "title": "Admin2 Name" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details." }, { "name": "admin_level", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AdminLevel" }, { "type": "null" } ], "description": "Filter the response by admin level.", "title": "Admin Level" }, "description": "Filter the response by admin level." }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_HumanitarianNeedsResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/affected-people/idps": { "get": { "tags": [ "Affected People" ], "summary": "Get idps data", "operationId": "get_idps_api_v2_affected_people_idps_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "has_hrp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.", "title": "Has Hrp" }, "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan." }, { "name": "in_gho", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.", "title": "In Gho" }, "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "Start Date" }, "description": "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" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "End Date" }, "description": "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" }, { "name": "location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "admin1_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details.", "title": "Admin1 Code" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details." }, { "name": "admin1_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details.", "title": "Admin1 Name" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details." }, { "name": "admin2_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details.", "title": "Admin2 Code" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details." }, { "name": "admin2_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details.", "title": "Admin2 Name" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details." }, { "name": "admin_level", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AdminLevel" }, { "type": "null" } ], "description": "Filter the response by admin level.", "title": "Admin Level" }, "description": "Filter the response by admin level." }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_IdpsResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/affected-people/returnees": { "get": { "tags": [ "Affected People" ], "summary": "Get returnees data", "operationId": "get_returnees_api_v2_affected_people_returnees_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "population_group", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PopulationGroup" }, { "type": "null" } ], "description": "Filter the response by the population group, available values are described here.", "title": "Population Group" }, "description": "Filter the response by the population group, available values are described here." }, { "name": "gender", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/Gender" }, { "type": "null" } ], "description": "Filter the response by the gender, available values are described here.", "title": "Gender" }, "description": "Filter the response by the gender, available values are described here." }, { "name": "age_range", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "description": "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.", "title": "Age Range" }, "description": "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." }, { "name": "min_age", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "description": "The minimum age from `age_range`, set to `null` if `age_range` is \"all\" and there is no age disaggregation", "title": "Min Age" }, "description": "The minimum age from `age_range`, set to `null` if `age_range` is \"all\" and there is no age disaggregation" }, { "name": "max_age", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "description": "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", "title": "Max Age" }, "description": "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" }, { "name": "origin_location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Origin Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "origin_location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Origin Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "origin_has_hrp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.", "title": "Origin Has Hrp" }, "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan." }, { "name": "origin_in_gho", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.", "title": "Origin In Gho" }, "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview." }, { "name": "asylum_location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Asylum Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "asylum_location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Asylum Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "asylum_has_hrp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.", "title": "Asylum Has Hrp" }, "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan." }, { "name": "asylum_in_gho", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.", "title": "Asylum In Gho" }, "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "Start Date" }, "description": "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" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "End Date" }, "description": "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" }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_ReturneesResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/coordination-context/operational-presence": { "get": { "tags": [ "Coordination & Context" ], "summary": "Get the list of organizations present and in which humanitarian sectors they are working", "description": "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 HDX HAPI documentation, and the original OCHA 3W source website.", "operationId": "get_operational_presence_api_v2_coordination_context_operational_presence_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "sector_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by sector codes, which describe the humanitarian sector to which the operational presence applies. See the sector endpoint for details.", "title": "Sector Code" }, "description": "Filter the response by sector codes, which describe the humanitarian sector to which the operational presence applies. See the sector endpoint for details." }, { "name": "sector_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by sector names, which describe the humanitarian sector to which the operational presence applies. See the sector endpoint for details.", "title": "Sector Name" }, "description": "Filter the response by sector names, which describe the humanitarian sector to which the operational presence applies. See the sector endpoint for details." }, { "name": "org_acronym", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "description": "Filter the response by the acronym of the organization to which the operational presence applies. See the org endpoint for details.", "title": "Org Acronym" }, "description": "Filter the response by the acronym of the organization to which the operational presence applies. See the org endpoint for details." }, { "name": "org_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the name of the organization to which the operational presence applies. See the org endpoint for details.", "title": "Org Name" }, "description": "Filter the response by the name of the organization to which the operational presence applies. See the org endpoint for details." }, { "name": "has_hrp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.", "title": "Has Hrp" }, "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan." }, { "name": "in_gho", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.", "title": "In Gho" }, "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "Start Date" }, "description": "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" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "End Date" }, "description": "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" }, { "name": "location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "admin1_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details.", "title": "Admin1 Code" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details." }, { "name": "admin1_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details.", "title": "Admin1 Name" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details." }, { "name": "admin2_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details.", "title": "Admin2 Code" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details." }, { "name": "admin2_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details.", "title": "Admin2 Name" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details." }, { "name": "admin_level", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AdminLevel" }, { "type": "null" } ], "description": "Filter the response by admin level.", "title": "Admin Level" }, "description": "Filter the response by admin level." }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_OperationalPresenceResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/coordination-context/funding": { "get": { "tags": [ "Coordination & Context" ], "summary": "Get funding data", "description": "OCHA's funding data from the Financial Tracking Service provides information on humanitarian aid contributions. See the more detailed technical HDX HAPI documentation, and the original FTS source website.", "operationId": "get_funding_api_v2_coordination_context_funding_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "appeal_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "description": "Filter the response by a unique code given by FTS to each appeal", "title": "Appeal Code" }, "description": "Filter the response by a unique code given by FTS to each appeal" }, { "name": "appeal_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "description": "Filter the response by the type of the appeal, such as flash or HRP", "title": "Appeal Type" }, "description": "Filter the response by the type of the appeal, such as flash or HRP" }, { "name": "location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "has_hrp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.", "title": "Has Hrp" }, "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan." }, { "name": "in_gho", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.", "title": "In Gho" }, "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "Start Date" }, "description": "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" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "End Date" }, "description": "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" }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_FundingResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/coordination-context/conflict-events": { "get": { "tags": [ "Coordination & Context" ], "summary": "Get the list of conflict events", "description": "Armed Conflict Location & Events Data from ACLED. See the more detailed technical HDX HAPI documentation, and the original ACLED source website.", "operationId": "get_conflict_event_api_v2_coordination_context_conflict_events_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "event_type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/EventType" }, { "type": "null" } ], "description": "Filter the response by the ACLED event-type categories (non-mutually exclusive), available values are described here.", "title": "Event Type" }, "description": "Filter the response by the ACLED event-type categories (non-mutually exclusive), available values are described here." }, { "name": "has_hrp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.", "title": "Has Hrp" }, "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan." }, { "name": "in_gho", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.", "title": "In Gho" }, "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "Start Date" }, "description": "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" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "End Date" }, "description": "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" }, { "name": "location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "admin1_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details.", "title": "Admin1 Code" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details." }, { "name": "admin1_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details.", "title": "Admin1 Name" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details." }, { "name": "admin2_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details.", "title": "Admin2 Code" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details." }, { "name": "admin2_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details.", "title": "Admin2 Name" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details." }, { "name": "admin_level", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AdminLevel" }, { "type": "null" } ], "description": "Filter the response by admin level.", "title": "Admin Level" }, "description": "Filter the response by admin level." }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_ConflictEventResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/coordination-context/national-risk": { "get": { "tags": [ "Coordination & Context" ], "summary": "Get national risk data", "description": "European Commission national risk data from the INFORM-risk framework. See the more detailed technical HDX HAPI documentation, and the original INFORM-risk source website.", "operationId": "get_national_risk_api_v2_coordination_context_national_risk_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "risk_class", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RiskClass" }, { "type": "null" } ], "description": "Filter the response by the INFORM risk class, available values are described here.", "title": "Risk Class" }, "description": "Filter the response by the INFORM risk class, available values are described here." }, { "name": "global_rank_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter the response by a lower bound for the Global Rank.", "title": "Global Rank Min" }, "description": "Filter the response by a lower bound for the Global Rank." }, { "name": "global_rank_max", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter the response by an upper bound for the Global Rank.", "title": "Global Rank Max" }, "description": "Filter the response by an upper bound for the Global Rank." }, { "name": "overall_risk_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Filter the response by a lower bound for the Overall Risk.", "title": "Overall Risk Min" }, "description": "Filter the response by a lower bound for the Overall Risk." }, { "name": "overall_risk_max", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Filter the response by an upper bound for the Overall Risk.", "title": "Overall Risk Max" }, "description": "Filter the response by an upper bound for the Overall Risk." }, { "name": "hazard_exposure_risk_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Filter the response by a lower bound for the Hazard Exposure Risk.", "title": "Hazard Exposure Risk Min" }, "description": "Filter the response by a lower bound for the Hazard Exposure Risk." }, { "name": "hazard_exposure_risk_max", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Filter the response by an upper bound for the Hazard Exposure Risk.", "title": "Hazard Exposure Risk Max" }, "description": "Filter the response by an upper bound for the Hazard Exposure Risk." }, { "name": "vulnerability_risk_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Filter the response by a lower bound for the Vulnerability Risk.", "title": "Vulnerability Risk Min" }, "description": "Filter the response by a lower bound for the Vulnerability Risk." }, { "name": "vulnerability_risk_max", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Filter the response by an upper bound for the Vulnerability Risk.", "title": "Vulnerability Risk Max" }, "description": "Filter the response by an upper bound for the Vulnerability Risk." }, { "name": "coping_capacity_risk_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Filter the response by a lower bound for the Coping Capacity Risk.", "title": "Coping Capacity Risk Min" }, "description": "Filter the response by a lower bound for the Coping Capacity Risk." }, { "name": "coping_capacity_risk_max", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Filter the response by a lower bound for the Coping Capacity Risk.", "title": "Coping Capacity Risk Max" }, "description": "Filter the response by a lower bound for the Coping Capacity Risk." }, { "name": "location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "has_hrp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.", "title": "Has Hrp" }, "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan." }, { "name": "in_gho", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.", "title": "In Gho" }, "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "Start Date" }, "description": "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" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "End Date" }, "description": "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" }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_NationalRiskResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/food-security-nutrition-poverty/food-security": { "get": { "tags": [ "Food Security, Nutrition & Poverty" ], "summary": "Get food security data", "description": "Integrated Food Security Phase Classification from the IPC. See the more detailed technical HDX HAPI documentation, and the original IPC source website.", "operationId": "get_food_security_api_v2_food_security_nutrition_poverty_food_security_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "ipc_phase", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IPCPhase" }, { "type": "null" } ], "description": "Filter the response by the IPC phase, available values are described here.", "title": "Ipc Phase" }, "description": "Filter the response by the IPC phase, available values are described here." }, { "name": "ipc_type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IPCType" }, { "type": "null" } ], "description": "Filter the response by the IPC type, available values are described here.", "title": "Ipc Type" }, "description": "Filter the response by the IPC type, available values are described here." }, { "name": "has_hrp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.", "title": "Has Hrp" }, "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan." }, { "name": "in_gho", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.", "title": "In Gho" }, "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "Start Date" }, "description": "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" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "End Date" }, "description": "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" }, { "name": "location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "admin1_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details.", "title": "Admin1 Code" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details." }, { "name": "admin1_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details.", "title": "Admin1 Name" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details." }, { "name": "admin2_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details.", "title": "Admin2 Code" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details." }, { "name": "admin2_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details.", "title": "Admin2 Name" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details." }, { "name": "admin_level", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AdminLevel" }, { "type": "null" } ], "description": "Filter the response by admin level.", "title": "Admin Level" }, "description": "Filter the response by admin level." }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_FoodSecurityResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/food-security-nutrition-poverty/food-prices-market-monitor": { "get": { "tags": [ "Food Security, Nutrition & Poverty" ], "summary": "Get food prices", "description": "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 HDX HAPI documentation, and the original WFP source website.", "operationId": "get_food_price_api_v2_food_security_nutrition_poverty_food_prices_market_monitor_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "market_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "description": "Filter the response by the unique code identifying the market", "title": "Market Code" }, "description": "Filter the response by the unique code identifying the market" }, { "name": "market_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the name of the market", "title": "Market Name" }, "description": "Filter the response by the name of the market" }, { "name": "commodity_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "description": "Filter the response by the unique code identifying the commodity", "title": "Commodity Code" }, "description": "Filter the response by the unique code identifying the commodity" }, { "name": "commodity_category", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/CommodityCategory" }, { "type": "null" } ], "description": "Filter the response by the food group that the commodity belongs to, available values are described here.", "title": "Commodity Category" }, "description": "Filter the response by the food group that the commodity belongs to, available values are described here." }, { "name": "commodity_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the name of the commodity", "title": "Commodity Name" }, "description": "Filter the response by the name of the commodity" }, { "name": "price_flag", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PriceFlag" }, { "type": "null" } ], "description": "Filter the response by the pre-processing characteristics of food prices, available values are described here.", "title": "Price Flag" }, "description": "Filter the response by the pre-processing characteristics of food prices, available values are described here." }, { "name": "price_type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PriceType" }, { "type": "null" } ], "description": "Filter the response by the point in the supply chain at which the price is determined, available values are described here.", "title": "Price Type" }, "description": "Filter the response by the point in the supply chain at which the price is determined, available values are described here." }, { "name": "price_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "description": "Filter the response by a lower bound for the price.", "title": "Price Min" }, "description": "Filter the response by a lower bound for the price." }, { "name": "price_max", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "description": "Filter the response by a upper bound for the price.", "title": "Price Max" }, "description": "Filter the response by a upper bound for the price." }, { "name": "has_hrp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.", "title": "Has Hrp" }, "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan." }, { "name": "in_gho", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.", "title": "In Gho" }, "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "Start Date" }, "description": "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" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "End Date" }, "description": "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" }, { "name": "location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "admin1_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details.", "title": "Admin1 Code" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details." }, { "name": "admin1_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details.", "title": "Admin1 Name" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details." }, { "name": "admin2_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details.", "title": "Admin2 Code" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details." }, { "name": "admin2_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details.", "title": "Admin2 Name" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details." }, { "name": "admin_level", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AdminLevel" }, { "type": "null" } ], "description": "Filter the response by admin level.", "title": "Admin Level" }, "description": "Filter the response by admin level." }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_FoodPriceResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/food-security-nutrition-poverty/poverty-rate": { "get": { "tags": [ "Food Security, Nutrition & Poverty" ], "summary": "Get poverty rate data", "description": "Poverty rate data from the Oxford Department of International Development. See the more detailed technical HDX HAPI documentation, and the Oxford Department of International Development website.", "operationId": "get_poverty_rate_api_v2_food_security_nutrition_poverty_poverty_rate_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "mpi_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Multidimensional Poverty Index (MPI), lower bound.", "title": "Mpi Min" }, "description": "Multidimensional Poverty Index (MPI), lower bound." }, { "name": "mpi_max", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Multidimensional Poverty Index (MPI), upper bound.", "title": "Mpi Max" }, "description": "Multidimensional Poverty Index (MPI), upper bound." }, { "name": "has_hrp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.", "title": "Has Hrp" }, "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan." }, { "name": "in_gho", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.", "title": "In Gho" }, "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "Start Date" }, "description": "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" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "End Date" }, "description": "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" }, { "name": "location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "admin1_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details.", "title": "Admin1 Code" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details." }, { "name": "admin1_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details.", "title": "Admin1 Name" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details." }, { "name": "admin_level", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AdminLevel" }, { "type": "null" } ], "description": "Filter the response by admin level.", "title": "Admin Level" }, "description": "Filter the response by admin level." }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_PovertyRateResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/geography-infrastructure/baseline-population": { "get": { "tags": [ "Geography & Infrastructure" ], "summary": "Get baseline population data", "description": "Baseline population data sourced and maintained by UNFPA (UN Population Fund). See the more detailed technical HDX HAPI documentation, and the UNFPA on HDX.", "operationId": "get_population_api_v2_geography_infrastructure_baseline_population_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "gender", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/Gender", "maxLength": 3 }, { "type": "null" } ], "description": "Filter the response by the gender, available values are described here.", "title": "Gender" }, "description": "Filter the response by the gender, available values are described here." }, { "name": "age_range", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "description": "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.", "title": "Age Range" }, "description": "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." }, { "name": "population_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter the response by a lower bound for the population.", "title": "Population Min" }, "description": "Filter the response by a lower bound for the population." }, { "name": "population_max", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter the response by a upper bound for the population.", "title": "Population Max" }, "description": "Filter the response by a upper bound for the population." }, { "name": "has_hrp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.", "title": "Has Hrp" }, "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan." }, { "name": "in_gho", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.", "title": "In Gho" }, "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "Start Date" }, "description": "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" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "End Date" }, "description": "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" }, { "name": "location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "admin1_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details.", "title": "Admin1 Code" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details." }, { "name": "admin1_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details.", "title": "Admin1 Name" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details." }, { "name": "admin2_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details.", "title": "Admin2 Code" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details." }, { "name": "admin2_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details.", "title": "Admin2 Name" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details." }, { "name": "admin_level", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AdminLevel" }, { "type": "null" } ], "description": "Filter the response by admin level.", "title": "Admin Level" }, "description": "Filter the response by admin level." }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_PopulationResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/climate/rainfall": { "get": { "tags": [ "Climate" ], "summary": "Get rainfall data", "description": "Rainfall data . See the more detailed technical here.", "title": "Aggregation Period" }, "description": "Filter the response by the aggregation period, available values are described here." }, { "name": "version", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/Version", "maxLength": 16 }, { "type": "null" } ], "description": "Version rainfall", "title": "Version" }, "description": "Version rainfall" }, { "name": "has_hrp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.", "title": "Has Hrp" }, "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan." }, { "name": "in_gho", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.", "title": "In Gho" }, "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "Start Date" }, "description": "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" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "End Date" }, "description": "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" }, { "name": "location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "admin1_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details.", "title": "Admin1 Code" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details." }, { "name": "admin1_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details.", "title": "Admin1 Name" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details." }, { "name": "admin2_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details.", "title": "Admin2 Code" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details." }, { "name": "admin2_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details.", "title": "Admin2 Name" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details." }, { "name": "admin_level", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AdminLevel" }, { "type": "null" } ], "description": "Filter the response by admin level.", "title": "Admin Level" }, "description": "Filter the response by admin level." }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_RainfallResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/metadata/dataset": { "get": { "tags": [ "Metadata" ], "summary": "Get information about the sources of the data in HDX HAPI", "description": "Get information about the HDX Datasets that are used as data sources\nfor HDX HAPI. Datasets contain one or more resources, which are the sources of the data found in HDX HAPI.", "operationId": "get_dataset_api_v2_metadata_dataset_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "dataset_hdx_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 36 }, { "type": "null" } ], "description": "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.", "title": "Dataset Hdx Id" }, "description": "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." }, { "name": "dataset_hdx_stub", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "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.", "title": "Dataset Hdx Stub" }, "description": "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." }, { "name": "dataset_hdx_title", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "description": "Filter the response by the title of the dataset as it appears in the HDX interface. This name is not unique and can change.", "title": "Dataset Hdx Title" }, "description": "Filter the response by the title of the dataset as it appears in the HDX interface. This name is not unique and can change." }, { "name": "hdx_provider_stub", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "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.", "title": "Hdx Provider Stub" }, "description": "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." }, { "name": "hdx_provider_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the display name of the provider (organization) of the dataset on HDX.", "title": "Hdx Provider Name" }, "description": "Filter the response by the display name of the provider (organization) of the dataset on HDX." }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_DatasetResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/metadata/resource": { "get": { "tags": [ "Metadata" ], "summary": "Get information about the sources of the data in HDX HAPI", "description": "Get information about the resources that are used as data sources for HDX HAPI. Datasets contain one or\nmore resources, which are the sources of the data found in HDX HAPI.", "operationId": "get_resources_api_v2_metadata_resource_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "resource_hdx_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 36 }, { "type": "null" } ], "description": "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.", "title": "Resource Hdx Id" }, "description": "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." }, { "name": "format", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "description": "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.", "title": "Format" }, "description": "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." }, { "name": "update_date_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Minimum date that datasets was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00", "title": "Update Date Min" }, "description": "Minimum date that datasets was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00" }, { "name": "update_date_max", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Maximum date that datasets was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00", "title": "Update Date Max" }, "description": "Maximum date that datasets was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00" }, { "name": "is_hxl", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by whether or not the resource contains HXL tags.", "title": "Is Hxl" }, "description": "Filter the response by whether or not the resource contains HXL tags." }, { "name": "dataset_hdx_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 36 }, { "type": "null" } ], "description": "Filter the response by the dataset ID (dataset_hdx_id), which is a unique and fixed identifier of a dataset on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]` will load the dataset page on HDX. See the dataset endpoint for details. ", "title": "Dataset Hdx Id" }, "description": "Filter the response by the dataset ID (dataset_hdx_id), which is a unique and fixed identifier of a dataset on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]` will load the dataset page on HDX. See the dataset endpoint for details. " }, { "name": "dataset_hdx_stub", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the URL-safe name (dataset_hdx_stub) of the dataset as displayed on HDX. This name is unique but can change. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_stub]` will load the dataset page on HDX. See the dataset endpoint for details.", "title": "Dataset Hdx Stub" }, "description": "Filter the response by the URL-safe name (dataset_hdx_stub) of the dataset as displayed on HDX. This name is unique but can change. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_stub]` will load the dataset page on HDX. See the dataset endpoint for details." }, { "name": "dataset_hdx_title", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "description": "Filter the response by the title of the dataset as it appears in the HDX interface. This name is not unique and can change. See the dataset endpoint for details.", "title": "Dataset Hdx Title" }, "description": "Filter the response by the title of the dataset as it appears in the HDX interface. This name is not unique and can change. See the dataset endpoint for details." }, { "name": "dataset_hdx_provider_stub", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "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.", "title": "Dataset Hdx Provider Stub" }, "description": "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." }, { "name": "dataset_hdx_provider_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the display name of the provider (organization) of the dataset on HDX.", "title": "Dataset Hdx Provider Name" }, "description": "Filter the response by the display name of the provider (organization) of the dataset on HDX." }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_ResourceResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/metadata/location": { "get": { "tags": [ "Metadata" ], "summary": "Get the list of locations (typically countries) included in HDX HAPI", "description": "Not all data are available for all locations. Learn more about the scope of data coverage in HDX HAPI in the Overview and Getting Started documentation.", "operationId": "get_location_api_v2_metadata_location_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter the response by a location (typically a country) reference number.", "title": "Id" }, "description": "Filter the response by a location (typically a country) reference number." }, { "name": "code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes.", "title": "Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard.", "title": "Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." }, { "name": "has_hrp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.", "title": "Has Hrp" }, "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan." }, { "name": "in_gho", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.", "title": "In Gho" }, "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "Start Date" }, "description": "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" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "End Date" }, "description": "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" }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_LocationResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/metadata/admin1": { "get": { "tags": [ "Metadata" ], "summary": "Get the list of first-level subnational administrative divisions available in HDX HAPI", "description": "Not all data are available for all locations. Learn more about the scope of data coverage in HDX HAPI in the Overview and Getting Started documentation.", "operationId": "get_admin1_api_v2_metadata_admin1_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter the response by a location (typically a country), using the unique identifier (id) from the location table associated with each entry.", "title": "Id" }, "description": "Filter the response by a location (typically a country), using the unique identifier (id) from the location table associated with each entry." }, { "name": "location_ref", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter the response by a location (typically a country) reference number.", "title": "Location Ref" }, "description": "Filter the response by a location (typically a country) reference number." }, { "name": "code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets.", "title": "Code" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets." }, { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source.", "title": "Name" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source." }, { "name": "location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "Start Date" }, "description": "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" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "End Date" }, "description": "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" }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_Admin1Response_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/metadata/admin2": { "get": { "tags": [ "Metadata" ], "summary": "Get the list of second-level administrative divisions available in HDX HAPI", "description": "Not all data are available for all locations. Learn more about the scope of data coverage in HDX HAPI in the Overview and Getting Started documentation.", "operationId": "get_admin2_api_v2_metadata_admin2_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter the response by a location (typically a country), using the unique identifier (id) from the location table associated with each entry.", "title": "Id" }, "description": "Filter the response by a location (typically a country), using the unique identifier (id) from the location table associated with each entry." }, { "name": "admin1_ref", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter the response by a location (typically a country) reference number.", "title": "Admin1 Ref" }, "description": "Filter the response by a location (typically a country) reference number." }, { "name": "location_ref", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter the response by a location (typically a country) reference number.", "title": "Location Ref" }, "description": "Filter the response by a location (typically a country) reference number." }, { "name": "code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets.", "title": "Code" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets." }, { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source.", "title": "Name" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source." }, { "name": "admin1_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details.", "title": "Admin1 Code" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details." }, { "name": "admin1_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details.", "title": "Admin1 Name" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details." }, { "name": "location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "Start Date" }, "description": "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" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "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", "title": "End Date" }, "description": "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" }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_Admin2Response_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/metadata/currency": { "get": { "tags": [ "Metadata" ], "summary": "Get information about how currencies are classified", "description": "Provide currency information to use in conjunction with the food-prices endpoint", "operationId": "get_currency_api_v2_metadata_currency_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "description": "Filter the response by the currency code.", "title": "Code" }, "description": "Filter the response by the currency code." }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_CurrencyResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/metadata/org": { "get": { "tags": [ "Metadata" ], "summary": "Get the list of organizations represented in the data available in HDX HAPI", "operationId": "get_org_api_v2_metadata_org_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "acronym", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "description": "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.", "title": "Acronym" }, "description": "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": "name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "Name" }, "description": "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." }, { "name": "org_type_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "description": "Filter the response by the organization type code.", "title": "Org Type Code" }, "description": "Filter the response by the organization type code." }, { "name": "org_type_description", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the organization type description. See the org type endpoint for details.", "title": "Org Type Description" }, "description": "Filter the response by the organization type description. See the org type endpoint for details." }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_OrgResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/metadata/org-type": { "get": { "tags": [ "Metadata" ], "summary": "Get information about how organizations are classified in HDX HAPI", "description": "There is no agreed standard for the classification of organizations. The codes and descriptions used in HDX HAPI\nare based on this dataset.", "operationId": "get_org_type_api_v2_metadata_org_type_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "description": "Filter the response by the organization type code.", "title": "Code" }, "description": "Filter the response by the organization type code." }, { "name": "description", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the organization type description.", "title": "Description" }, "description": "Filter the response by the organization type description." }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_OrgTypeResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/metadata/sector": { "get": { "tags": [ "Metadata" ], "summary": "Get information about how humanitarian response activities are classified", "description": "There are a variety of standards for the naming of humanitarian sectors. The codes and descriptions used\nin HDX HAPI are based on\nthis dataset.", "operationId": "get_sector_api_v2_metadata_sector_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "description": "Filter the response by the sector code.", "title": "Code" }, "description": "Filter the response by the sector code." }, { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the sector name.", "title": "Name" }, "description": "Filter the response by the sector name." }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_SectorResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/metadata/wfp-commodity": { "get": { "tags": [ "Metadata" ], "summary": "Get the list of WFP commodities", "description": "Provide commodity information to use in conjunction with the food-prices endpoint", "operationId": "get_wfp_commodities_api_v2_metadata_wfp_commodity_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "description": "Filter the response by the unique code identifying the commodity.", "title": "Code" }, "description": "Filter the response by the unique code identifying the commodity." }, { "name": "category", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/CommodityCategory" }, { "type": "null" } ], "description": "Filter the response by the food group that the commodity belongs to, available values are described here.", "title": "Category" }, "description": "Filter the response by the food group that the commodity belongs to, available values are described here." }, { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the name of the commodity.", "title": "Name" }, "description": "Filter the response by the name of the commodity." }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_WfpCommodityResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/metadata/wfp-market": { "get": { "tags": [ "Metadata" ], "summary": "Get the list of WFP markets.", "description": "Provide physical market location information to use in conjunction with the food-prices endpoint", "operationId": "get_wfp_market_api_v2_metadata_wfp_market_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "description": "Filter the response by the unique code identifying the market.", "title": "Code" }, "description": "Filter the response by the unique code identifying the market." }, { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the name of the market.", "title": "Name" }, "description": "Filter the response by the name of the market." }, { "name": "has_hrp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan.", "title": "Has Hrp" }, "description": "Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan." }, { "name": "in_gho", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview.", "title": "In Gho" }, "description": "Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview." }, { "name": "location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "admin1_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details.", "title": "Admin1 Code" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details." }, { "name": "admin1_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details.", "title": "Admin1 Name" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details." }, { "name": "admin2_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details.", "title": "Admin2 Code" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details." }, { "name": "admin2_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details.", "title": "Admin2 Name" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details." }, { "name": "admin_level", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AdminLevel" }, { "type": "null" } ], "description": "Filter the response by admin level.", "title": "Admin Level" }, "description": "Filter the response by admin level." }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_WfpMarketResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/metadata/data-availability": { "get": { "tags": [ "Metadata" ], "summary": "Get information about the availability of data for different geographic admin levels", "description": "Provide currency information to use in conjunction with the food-prices endpoint", "operationId": "get_data_availability_api_v2_metadata_data_availability_get", "parameters": [ { "name": "app_identifier", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "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.", "title": "App Identifier" }, "description": "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." }, { "name": "category", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a data category", "title": "Category" }, "description": "Filter the response by a data category" }, { "name": "subcategory", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a data subcategory", "title": "Subcategory" }, "description": "Filter the response by a data subcategory" }, { "name": "hapi_updated_date_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Minimum date that datasets was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00", "title": "Hapi Updated Date Min" }, "description": "Minimum date that datasets was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00" }, { "name": "hapi_updated_date_max", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Maximum date that datasets was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00", "title": "Hapi Updated Date Max" }, "description": "Maximum date that datasets was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00" }, { "name": "output_format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/OutputFormat", "default": "json" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "default": 10000, "title": "Limit" }, "description": "Maximum number of records to return. The system will not return more than 10,000 records.", "example": 100 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.", "default": 0, "title": "Offset" }, "description": "Number of records to skip in the response. Use in conjunction with the limit parameter to paginate." }, { "name": "location_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details.", "title": "Location Code" }, "description": "Filter the response by a location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. See the location endpoint for details." }, { "name": "location_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details.", "title": "Location Name" }, "description": "Filter the response by a location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard. See the location endpoint for details." }, { "name": "admin1_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details.", "title": "Admin1 Code" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. See the admin1 endpoint for details." }, { "name": "admin1_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details.", "title": "Admin1 Name" }, "description": "Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin1 endpoint for details." }, { "name": "admin2_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details.", "title": "Admin2 Code" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. See the admin2 endpoint for details." }, { "name": "admin2_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details.", "title": "Admin2 Name" }, "description": "Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source. See the admin2 endpoint for details." }, { "name": "admin_level", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AdminLevel" }, { "type": "null" } ], "description": "Filter the response by admin level.", "title": "Admin Level" }, "description": "Filter the response by admin level." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HapiGenericResponse_AvailabilityResponse_" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } }, "description": "Bad Request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseValidationResponse" } } }, "description": "Internal Server Error" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/util/version": { "get": { "tags": [ "Util" ], "summary": "Display the API and SQL Alchemy versions", "operationId": "get_version_api_v2_util_version_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionResponse" } } } } } } } }, "components": { "schemas": { "Admin1Response": { "properties": { "id": { "type": "integer", "title": "Id", "description": "1st subnational administrative division, using the unique identifier (id) from the admin1 table associated with each entry." }, "location_ref": { "type": "integer", "title": "Location Ref", "description": "A location (typically a country) reference number." }, "code": { "type": "string", "maxLength": 128, "title": "Code", "description": "The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets." }, "name": { "type": "string", "maxLength": 512, "title": "Name", "description": "The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source." }, "from_cods": { "type": "boolean", "title": "From Cods" }, "reference_period_start": { "type": "string", "format": "date-time", "title": "Reference Period Start", "description": "The start date for which the data are applicable" }, "reference_period_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period End", "description": "The end date for which the data are applicable" }, "location_code": { "type": "string", "maxLength": 128, "title": "Location Code", "description": "A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, "location_name": { "type": "string", "maxLength": 512, "title": "Location Name", "description": "A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." } }, "type": "object", "required": [ "id", "location_ref", "code", "name", "from_cods", "reference_period_start", "reference_period_end", "location_code", "location_name" ], "title": "Admin1Response" }, "Admin2Response": { "properties": { "id": { "type": "integer", "title": "Id", "description": "2nd subnational administrative division, using the unique identifier (id) from the admin2 table associated with each entry." }, "admin1_ref": { "type": "integer", "title": "Admin1 Ref", "description": "The 2nd subnational administrative division reference number." }, "code": { "type": "string", "maxLength": 128, "title": "Code", "description": "The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets." }, "name": { "type": "string", "maxLength": 512, "title": "Name", "description": "The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source." }, "from_cods": { "type": "boolean", "title": "From Cods" }, "reference_period_start": { "type": "string", "format": "date-time", "title": "Reference Period Start", "description": "The start date for which the data are applicable" }, "reference_period_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period End", "description": "The end date for which the data are applicable" }, "admin1_code": { "type": "string", "maxLength": 128, "title": "Admin1 Code", "description": "The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets." }, "admin1_name": { "type": "string", "maxLength": 512, "title": "Admin1 Name", "description": "The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source." }, "location_code": { "type": "string", "maxLength": 128, "title": "Location Code", "description": "A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, "location_name": { "type": "string", "maxLength": 512, "title": "Location Name", "description": "A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." }, "location_ref": { "type": "integer", "title": "Location Ref", "description": "A location (typically a country) reference number." } }, "type": "object", "required": [ "id", "admin1_ref", "code", "name", "from_cods", "reference_period_start", "reference_period_end", "admin1_code", "admin1_name", "location_code", "location_name", "location_ref" ], "title": "Admin2Response" }, "AdminLevel": { "type": "string", "enum": [ "0", "1", "2" ], "title": "AdminLevel" }, "AggregationPeriod": { "type": "string", "enum": [ "dekad", "1-month", "3-month" ], "title": "AggregationPeriod" }, "AvailabilityResponse": { "properties": { "location_code": { "type": "string", "maxLength": 128, "title": "Location Code", "description": "A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, "location_name": { "type": "string", "maxLength": 512, "title": "Location Name", "description": "A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." }, "admin1_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin1 Code", "description": "The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets." }, "admin1_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin1 Name", "description": "The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin2_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin2 Code", "description": "The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets." }, "admin2_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin2 Name", "description": "The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin_level": { "type": "integer", "title": "Admin Level", "description": "Admin level." }, "category": { "type": "string", "maxLength": 32, "title": "Category", "description": "HAPI category" }, "subcategory": { "type": "string", "maxLength": 512, "title": "Subcategory", "description": "HAPI subcategory" }, "hapi_updated_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Hapi Updated Date", "description": "Date that dataset was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00" } }, "type": "object", "required": [ "location_code", "location_name", "admin1_code", "admin1_name", "admin2_code", "admin2_name", "admin_level", "category", "subcategory", "hapi_updated_date" ], "title": "AvailabilityResponse" }, "BadRequestResponse": { "properties": { "detail": { "type": "string", "title": "Detail" } }, "type": "object", "required": [ "detail" ], "title": "BadRequestResponse" }, "CommodityCategory": { "type": "string", "enum": [ "cereals and tubers", "meat, fish and eggs", "milk and dairy", "miscellaneous food", "non-food", "oil and fats", "pulses and nuts", "vegetables and fruits" ], "title": "CommodityCategory" }, "ConflictEventResponse": { "properties": { "location_code": { "type": "string", "maxLength": 128, "title": "Location Code", "description": "A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, "location_name": { "type": "string", "maxLength": 512, "title": "Location Name", "description": "A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." }, "admin1_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin1 Code", "description": "The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets." }, "admin1_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin1 Name", "description": "The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin2_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin2 Code", "description": "The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets." }, "admin2_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin2 Name", "description": "The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin_level": { "type": "integer", "title": "Admin Level", "description": "Admin level." }, "resource_hdx_id": { "type": "string", "maxLength": 36, "title": "Resource Hdx Id", "description": "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." }, "event_type": { "$ref": "#/components/schemas/EventType", "description": "Filter the response by the ACLED event-type categories (non-mutually exclusive), available values are described here." }, "events": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Events", "description": "The number of events with the given `event_type`" }, "fatalities": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fatalities", "description": "The number of fatalities due to the given `event_type`" }, "reference_period_start": { "type": "string", "format": "date-time", "title": "Reference Period Start", "description": "The start date for which the data are applicable" }, "reference_period_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period End", "description": "The end date for which the data are applicable" } }, "type": "object", "required": [ "location_code", "location_name", "admin1_code", "admin1_name", "admin2_code", "admin2_name", "admin_level", "resource_hdx_id", "event_type", "events", "fatalities", "reference_period_start", "reference_period_end" ], "title": "ConflictEventResponse" }, "CurrencyResponse": { "properties": { "code": { "type": "string", "maxLength": 32, "title": "Code", "description": "ISO-4217 currency code" }, "name": { "type": "string", "maxLength": 512, "title": "Name", "description": "Currency name" } }, "type": "object", "required": [ "code", "name" ], "title": "CurrencyResponse" }, "DTMAssessmentType": { "type": "string", "enum": [ "BA", "ETT", "SA" ], "title": "DTMAssessmentType" }, "DatasetResponse": { "properties": { "dataset_hdx_id": { "type": "string", "maxLength": 36, "title": "Dataset Hdx Id", "description": "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": { "type": "string", "maxLength": 128, "title": "Dataset Hdx Stub", "description": "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": { "type": "string", "maxLength": 1024, "title": "Dataset Hdx Title", "description": "The title of the dataset as it appears in the HDX interface. This name is not unique and can change." }, "hdx_provider_stub": { "type": "string", "maxLength": 128, "title": "Hdx Provider Stub", "description": "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": { "type": "string", "maxLength": 512, "title": "Hdx Provider Name", "description": "The display name of the provider (organization) of the dataset on HDX." }, "hdx_link": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Hdx Link", "readOnly": true }, "hdx_api_link": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Hdx Api Link", "readOnly": true }, "provider_hdx_link": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Provider Hdx Link", "readOnly": true }, "provider_hdx_api_link": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Provider Hdx Api Link", "readOnly": true } }, "type": "object", "required": [ "dataset_hdx_id", "dataset_hdx_stub", "dataset_hdx_title", "hdx_provider_stub", "hdx_provider_name", "hdx_link", "hdx_api_link", "provider_hdx_link", "provider_hdx_api_link" ], "title": "DatasetResponse" }, "EventType": { "type": "string", "enum": [ "civilian_targeting", "demonstration", "political_violence" ], "title": "EventType" }, "FoodPriceResponse": { "properties": { "location_code": { "type": "string", "maxLength": 128, "title": "Location Code", "description": "A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, "location_name": { "type": "string", "maxLength": 512, "title": "Location Name", "description": "A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." }, "admin1_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin1 Code", "description": "The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets." }, "admin1_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin1 Name", "description": "The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin2_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin2 Code", "description": "The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets." }, "admin2_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin2 Name", "description": "The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin_level": { "type": "integer", "title": "Admin Level", "description": "Admin level." }, "resource_hdx_id": { "type": "string", "maxLength": 36, "title": "Resource Hdx Id", "description": "Unique resource UUID on HDX" }, "market_code": { "type": "string", "maxLength": 32, "title": "Market Code", "description": "The unique code identifying the market" }, "market_name": { "type": "string", "maxLength": 512, "title": "Market Name", "description": "The name of the market" }, "commodity_code": { "type": "string", "maxLength": 32, "title": "Commodity Code", "description": "The unique code identifying the commodity" }, "commodity_name": { "type": "string", "maxLength": 512, "title": "Commodity Name", "description": "The name of the commodity" }, "commodity_category": { "$ref": "#/components/schemas/CommodityCategory", "description": "The food group that the commodity belongs to, available values are described here." }, "currency_code": { "type": "string", "maxLength": 32, "title": "Currency Code", "description": "ISO-4217 currency code" }, "unit": { "type": "string", "maxLength": 32, "title": "Unit", "description": "The unit of the commodity, such as weight or number" }, "price_flag": { "$ref": "#/components/schemas/PriceFlag", "description": "The pre-processing characteristics of food prices, available values are described here." }, "price_type": { "$ref": "#/components/schemas/PriceType", "description": "The point in the supply chain at which the price is determined, available values are described here." }, "price": { "type": "number", "minimum": 0.0, "title": "Price" }, "lat": { "anyOf": [ { "type": "number", "maximum": 90.0, "minimum": -90.0 }, { "type": "null" } ], "title": "Lat", "description": "The market's latitude" }, "lon": { "anyOf": [ { "type": "number", "maximum": 180.0, "minimum": -180.0 }, { "type": "null" } ], "title": "Lon", "description": "The market's longitude" }, "reference_period_start": { "type": "string", "format": "date-time", "title": "Reference Period Start", "description": "The start date for which the data are applicable" }, "reference_period_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period End", "description": "The end date for which the data are applicable" } }, "type": "object", "required": [ "location_code", "location_name", "admin1_code", "admin1_name", "admin2_code", "admin2_name", "admin_level", "resource_hdx_id", "market_code", "market_name", "commodity_code", "commodity_name", "commodity_category", "currency_code", "unit", "price_flag", "price_type", "price", "lat", "lon", "reference_period_start", "reference_period_end" ], "title": "FoodPriceResponse" }, "FoodSecurityResponse": { "properties": { "location_code": { "type": "string", "maxLength": 128, "title": "Location Code", "description": "A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, "location_name": { "type": "string", "maxLength": 512, "title": "Location Name", "description": "A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." }, "admin1_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin1 Code", "description": "The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets." }, "admin1_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin1 Name", "description": "The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin2_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin2 Code", "description": "The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets." }, "admin2_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin2 Name", "description": "The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin_level": { "type": "integer", "title": "Admin Level", "description": "Admin level." }, "resource_hdx_id": { "type": "string", "maxLength": 36, "title": "Resource Hdx Id", "description": "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." }, "ipc_phase": { "type": "string", "maxLength": 32, "title": "Ipc Phase", "description": "The IPC phase, available values are described here." }, "ipc_type": { "type": "string", "maxLength": 32, "title": "Ipc Type", "description": "The IPC type, available values are described here." }, "population_in_phase": { "type": "integer", "title": "Population In Phase", "description": "The number of people in the IPC phase" }, "population_fraction_in_phase": { "type": "number", "title": "Population Fraction In Phase", "description": "The fraction of people in the IPC phase" }, "reference_period_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period Start", "description": "The start date for which the data are applicable" }, "reference_period_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period End", "description": "The end date for which the data are applicable" } }, "type": "object", "required": [ "location_code", "location_name", "admin1_code", "admin1_name", "admin2_code", "admin2_name", "admin_level", "resource_hdx_id", "ipc_phase", "ipc_type", "population_in_phase", "population_fraction_in_phase", "reference_period_start", "reference_period_end" ], "title": "FoodSecurityResponse" }, "FundingResponse": { "properties": { "resource_hdx_id": { "type": "string", "maxLength": 36, "title": "Resource Hdx Id", "description": "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." }, "appeal_code": { "type": "string", "maxLength": 64, "title": "Appeal Code", "description": "A unique code given by FTS to each appeal" }, "appeal_name": { "type": "string", "maxLength": 256, "title": "Appeal Name", "description": "Name of the appeal" }, "appeal_type": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Appeal Type", "description": "The type of the appeal, such as flash or HRP" }, "requirements_usd": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "Requirements Usd", "description": "The funding requirements in US dollars" }, "funding_usd": { "type": "number", "minimum": 0.0, "title": "Funding Usd", "description": "The actual funding in US dollars" }, "funding_pct": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "Funding Pct", "description": "The percentage of required funding received by the appeal" }, "location_code": { "type": "string", "maxLength": 128, "title": "Location Code", "description": "A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, "location_name": { "type": "string", "maxLength": 512, "title": "Location Name", "description": "A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." }, "reference_period_start": { "type": "string", "format": "date-time", "title": "Reference Period Start", "description": "The start date for which the data are applicable" }, "reference_period_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period End", "description": "The end date for which the data are applicable" } }, "type": "object", "required": [ "resource_hdx_id", "appeal_code", "appeal_name", "appeal_type", "requirements_usd", "funding_usd", "funding_pct", "location_code", "location_name", "reference_period_start", "reference_period_end" ], "title": "FundingResponse" }, "Gender": { "type": "string", "enum": [ "f", "m", "x", "u", "o", "all" ], "title": "Gender" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "HapiGenericResponse_Admin1Response_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Admin1Response" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[Admin1Response]" }, "HapiGenericResponse_Admin2Response_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Admin2Response" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[Admin2Response]" }, "HapiGenericResponse_AvailabilityResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/AvailabilityResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[AvailabilityResponse]" }, "HapiGenericResponse_ConflictEventResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ConflictEventResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[ConflictEventResponse]" }, "HapiGenericResponse_CurrencyResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/CurrencyResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[CurrencyResponse]" }, "HapiGenericResponse_DatasetResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/DatasetResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[DatasetResponse]" }, "HapiGenericResponse_FoodPriceResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/FoodPriceResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[FoodPriceResponse]" }, "HapiGenericResponse_FoodSecurityResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/FoodSecurityResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[FoodSecurityResponse]" }, "HapiGenericResponse_FundingResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/FundingResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[FundingResponse]" }, "HapiGenericResponse_HumanitarianNeedsResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/HumanitarianNeedsResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[HumanitarianNeedsResponse]" }, "HapiGenericResponse_IdpsResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/IdpsResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[IdpsResponse]" }, "HapiGenericResponse_LocationResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/LocationResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[LocationResponse]" }, "HapiGenericResponse_NationalRiskResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/NationalRiskResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[NationalRiskResponse]" }, "HapiGenericResponse_OperationalPresenceResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/OperationalPresenceResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[OperationalPresenceResponse]" }, "HapiGenericResponse_OrgResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/OrgResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[OrgResponse]" }, "HapiGenericResponse_OrgTypeResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/OrgTypeResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[OrgTypeResponse]" }, "HapiGenericResponse_PopulationResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PopulationResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[PopulationResponse]" }, "HapiGenericResponse_PovertyRateResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PovertyRateResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[PovertyRateResponse]" }, "HapiGenericResponse_RainfallResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/RainfallResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[RainfallResponse]" }, "HapiGenericResponse_RefugeesResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/RefugeesResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[RefugeesResponse]" }, "HapiGenericResponse_ResourceResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ResourceResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[ResourceResponse]" }, "HapiGenericResponse_ReturneesResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ReturneesResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[ReturneesResponse]" }, "HapiGenericResponse_SectorResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/SectorResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[SectorResponse]" }, "HapiGenericResponse_WfpCommodityResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/WfpCommodityResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[WfpCommodityResponse]" }, "HapiGenericResponse_WfpMarketResponse_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/WfpMarketResponse" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "HapiGenericResponse[WfpMarketResponse]" }, "HumanitarianNeedsResponse": { "properties": { "location_code": { "type": "string", "maxLength": 128, "title": "Location Code", "description": "A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, "location_name": { "type": "string", "maxLength": 512, "title": "Location Name", "description": "A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." }, "admin1_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin1 Code", "description": "The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets." }, "admin1_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin1 Name", "description": "The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin2_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin2 Code", "description": "The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets." }, "admin2_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin2 Name", "description": "The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin_level": { "type": "integer", "title": "Admin Level", "description": "Admin level." }, "resource_hdx_id": { "type": "string", "maxLength": 36, "title": "Resource Hdx Id", "description": "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." }, "sector_code": { "type": "string", "maxLength": 32, "title": "Sector Code", "description": "The sector code, derived either from the [Global Coordination Groups](https://data.humdata.org/dataset/global-coordination-groups-beta?) dataset, or created for HDX HAPI" }, "category": { "type": "string", "maxLength": 128, "title": "Category", "description": "A category combining gender, age range, disability marker and population group information" }, "population_status": { "$ref": "#/components/schemas/PopulationStatus", "description": "The population status, available values are described here." }, "population": { "type": "integer", "minimum": 0.0, "title": "Population", "description": "The number of people" }, "reference_period_start": { "type": "string", "format": "date-time", "title": "Reference Period Start", "description": "The start date for which the data are applicable" }, "reference_period_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period End", "description": "The end date for which the data are applicable" }, "sector_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Sector Name", "description": "The name of the sector" } }, "type": "object", "required": [ "location_code", "location_name", "admin1_code", "admin1_name", "admin2_code", "admin2_name", "admin_level", "resource_hdx_id", "sector_code", "category", "population_status", "population", "reference_period_start", "reference_period_end", "sector_name" ], "title": "HumanitarianNeedsResponse" }, "IPCPhase": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "3+", "all" ], "title": "IPCPhase" }, "IPCType": { "type": "string", "enum": [ "current", "first projection", "second projection" ], "title": "IPCType" }, "IdentifierResponse": { "properties": { "encoded_app_identifier": { "type": "string", "maxLength": 512, "title": "Encoded App Identifier", "description": "Base64 encoded app_identifier compiled from application name and email address" } }, "type": "object", "required": [ "encoded_app_identifier" ], "title": "IdentifierResponse" }, "IdpsResponse": { "properties": { "location_code": { "type": "string", "maxLength": 128, "title": "Location Code", "description": "A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, "location_name": { "type": "string", "maxLength": 512, "title": "Location Name", "description": "A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." }, "admin1_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin1 Code", "description": "The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets." }, "admin1_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin1 Name", "description": "The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin2_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin2 Code", "description": "The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets." }, "admin2_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin2 Name", "description": "The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin_level": { "type": "integer", "title": "Admin Level", "description": "Admin level." }, "resource_hdx_id": { "type": "string", "maxLength": 36, "title": "Resource Hdx Id", "description": "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." }, "reporting_round": { "type": "integer", "title": "Reporting Round", "description": "Data collection round number" }, "assessment_type": { "$ref": "#/components/schemas/DTMAssessmentType", "description": "Either baseline assessment (BA),site assessment (SA) or event track (ETT)" }, "operation": { "type": "string", "title": "Operation", "description": "Name of DTM Operation for which the data was collected" }, "population": { "type": "integer", "title": "Population", "description": "The number of people" }, "reference_period_start": { "type": "string", "format": "date-time", "title": "Reference Period Start", "description": "The start date for which the data are applicable" }, "reference_period_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period End", "description": "The end date for which the data are applicable" } }, "type": "object", "required": [ "location_code", "location_name", "admin1_code", "admin1_name", "admin2_code", "admin2_name", "admin_level", "resource_hdx_id", "reporting_round", "assessment_type", "operation", "population", "reference_period_start", "reference_period_end" ], "title": "IdpsResponse" }, "LocationResponse": { "properties": { "id": { "type": "integer", "title": "Id", "description": "A location (typically a country), using the unique identifier (id) from the location table associated with each entry." }, "code": { "type": "string", "maxLength": 128, "title": "Code", "description": "A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." }, "name": { "type": "string", "maxLength": 512, "title": "Name", "description": "A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, "has_hrp": { "type": "boolean", "title": "Has Hrp", "description": "The has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan." }, "in_gho": { "type": "boolean", "title": "In Gho", "description": "The in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview." }, "from_cods": { "type": "boolean", "title": "From Cods" }, "reference_period_start": { "type": "string", "format": "date-time", "title": "Reference Period Start", "description": "The start date for which the data are applicable" }, "reference_period_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period End", "description": "The end date for which the data are applicable" } }, "type": "object", "required": [ "id", "code", "name", "has_hrp", "in_gho", "from_cods", "reference_period_start", "reference_period_end" ], "title": "LocationResponse" }, "NationalRiskResponse": { "properties": { "risk_class": { "$ref": "#/components/schemas/RiskClass", "description": "The INFORM risk class, available values are described here." }, "global_rank": { "type": "integer", "maximum": 250.0, "minimum": 1.0, "title": "Global Rank", "description": "The rank of the country based on `overall_risk`. Higher rank (smaller number) is associated with more risk." }, "overall_risk": { "type": "number", "maximum": 10.0, "minimum": 0.0, "title": "Overall Risk", "description": "The INFORM composite risk index, based on a combination of 54 indicators into three dimensions of risk: hazard and exposure, vulnerability, and lack of coping capacity. Risk score is given out of 10." }, "hazard_exposure_risk": { "type": "number", "maximum": 10.0, "minimum": 0.0, "title": "Hazard Exposure Risk", "description": "Risk due to events that may occur, and exposure to them. Risk score is given out of 10. " }, "vulnerability_risk": { "type": "number", "maximum": 10.0, "minimum": 0.0, "title": "Vulnerability Risk", "description": "Risk due to hazard susceptibility. Risk score is given out of 10." }, "coping_capacity_risk": { "type": "number", "maximum": 10.0, "minimum": 0.0, "title": "Coping Capacity Risk", "description": "Risk due to lack of coping capacity to alleviate hazard impact. Risk score is given out of 10." }, "meta_missing_indicators_pct": { "anyOf": [ { "type": "number", "maximum": 100.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Meta Missing Indicators Pct", "description": "The average of the total number of years older than the reference year per indicator, to account for any older data used as a proxy" }, "meta_avg_recentness_years": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "Meta Avg Recentness Years", "description": "The average of the total number of years older than the reference year per indicator, to account for any older data used as a proxy)" }, "reference_period_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period Start", "description": "The start date for which the data are applicable" }, "reference_period_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period End", "description": "The end date for which the data are applicable" }, "resource_hdx_id": { "type": "string", "maxLength": 36, "title": "Resource Hdx Id", "description": "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." }, "location_code": { "type": "string", "maxLength": 128, "title": "Location Code", "description": "A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, "location_name": { "type": "string", "maxLength": 512, "title": "Location Name", "description": "A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." } }, "type": "object", "required": [ "risk_class", "global_rank", "overall_risk", "hazard_exposure_risk", "vulnerability_risk", "coping_capacity_risk", "meta_missing_indicators_pct", "meta_avg_recentness_years", "reference_period_start", "reference_period_end", "resource_hdx_id", "location_code", "location_name" ], "title": "NationalRiskResponse" }, "OperationalPresenceResponse": { "properties": { "location_code": { "type": "string", "maxLength": 128, "title": "Location Code", "description": "A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, "location_name": { "type": "string", "maxLength": 512, "title": "Location Name", "description": "A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." }, "admin1_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin1 Code", "description": "The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets." }, "admin1_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin1 Name", "description": "The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin2_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin2 Code", "description": "The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets." }, "admin2_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin2 Name", "description": "The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin_level": { "type": "integer", "title": "Admin Level", "description": "Admin level." }, "resource_hdx_id": { "type": "string", "maxLength": 36, "title": "Resource Hdx Id", "description": "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." }, "org_acronym": { "type": "string", "maxLength": 32, "title": "Org Acronym", "description": "The organization acronym" }, "org_name": { "type": "string", "maxLength": 512, "title": "Org Name", "description": "The organization name" }, "sector_code": { "type": "string", "maxLength": 32, "title": "Sector Code", "description": "The sector code, derived either from the [Global Coordination Groups](https://data.humdata.org/dataset/global-coordination-groups-beta?) dataset, or created for HDX HAPI" }, "sector_name": { "type": "string", "maxLength": 512, "title": "Sector Name", "description": "The name of the sector" }, "reference_period_start": { "type": "string", "format": "date-time", "title": "Reference Period Start", "description": "The start date for which the data are applicable" }, "reference_period_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period End", "description": "The end date for which the data are applicable" }, "org_type_code": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "title": "Org Type Code", "description": "The code referring to the organization type" }, "org_type_description": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Org Type Description", "description": "A description of the organization type" } }, "type": "object", "required": [ "location_code", "location_name", "admin1_code", "admin1_name", "admin2_code", "admin2_name", "admin_level", "resource_hdx_id", "org_acronym", "org_name", "sector_code", "sector_name", "reference_period_start", "reference_period_end", "org_type_code", "org_type_description" ], "title": "OperationalPresenceResponse" }, "OrgResponse": { "properties": { "acronym": { "type": "string", "maxLength": 32, "title": "Acronym", "description": "The organization acronym" }, "name": { "type": "string", "maxLength": 512, "title": "Name", "description": "The organization name" }, "org_type_code": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "title": "Org Type Code", "description": "The code referring to the organization type" }, "org_type_description": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "title": "Org Type Description", "description": "A description of the organization type" } }, "type": "object", "required": [ "acronym", "name", "org_type_code", "org_type_description" ], "title": "OrgResponse" }, "OrgTypeResponse": { "properties": { "code": { "type": "string", "maxLength": 32, "title": "Code", "description": " The code referring to the organization type, derived either from the [OCHA Digital Services organization types list](https://data.humdata.org/dataset/organization-types-beta), or created for HDX HAPI" }, "description": { "type": "string", "maxLength": 512, "title": "Description", "description": "A description of the organization type" } }, "type": "object", "required": [ "code", "description" ], "title": "OrgTypeResponse" }, "OutputFormat": { "type": "string", "enum": [ "csv", "json" ], "title": "OutputFormat" }, "PopulationGroup": { "type": "string", "enum": [ "REF", "ROC", "ASY", "OIP", "IDP", "IOC", "STA", "OOC", "HST", "RET", "RST", "NAT", "RDP", "RRI", "all" ], "title": "PopulationGroup" }, "PopulationResponse": { "properties": { "location_code": { "type": "string", "maxLength": 128, "title": "Location Code", "description": "A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, "location_name": { "type": "string", "maxLength": 512, "title": "Location Name", "description": "A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." }, "admin1_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin1 Code", "description": "The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets." }, "admin1_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin1 Name", "description": "The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin2_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin2 Code", "description": "The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets." }, "admin2_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin2 Name", "description": "The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin_level": { "type": "integer", "title": "Admin Level", "description": "Admin level." }, "resource_hdx_id": { "type": "string", "maxLength": 36, "title": "Resource Hdx Id", "description": "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." }, "gender": { "$ref": "#/components/schemas/Gender", "description": "The gender, available values are described here." }, "age_range": { "type": "string", "maxLength": 32, "title": "Age Range", "description": "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": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Min Age", "description": "The minimum age from `age_range`, set to `null` if `age_range` is \"all\" and there is no age disaggregation" }, "max_age": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Max Age", "description": "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" }, "population": { "type": "integer", "title": "Population", "description": "The number of people" }, "reference_period_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period Start", "description": "The start date for which the data are applicable" }, "reference_period_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period End", "description": "The end date for which the data are applicable" } }, "type": "object", "required": [ "location_code", "location_name", "admin1_code", "admin1_name", "admin2_code", "admin2_name", "admin_level", "resource_hdx_id", "gender", "age_range", "min_age", "max_age", "population", "reference_period_start", "reference_period_end" ], "title": "PopulationResponse" }, "PopulationStatus": { "type": "string", "enum": [ "AFF", "INN", "TGT", "REA", "all" ], "title": "PopulationStatus" }, "PovertyRateResponse": { "properties": { "location_code": { "type": "string", "maxLength": 128, "title": "Location Code", "description": "A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, "location_name": { "type": "string", "maxLength": 512, "title": "Location Name", "description": "A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." }, "admin1_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin1 Code", "description": "The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets." }, "admin1_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin1 Name", "description": "The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin_level": { "type": "integer", "title": "Admin Level", "description": "Admin level." }, "resource_hdx_id": { "type": "string", "maxLength": 36, "title": "Resource Hdx Id", "description": "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." }, "mpi": { "type": "number", "title": "Mpi", "description": "The multidimensional poverty index, derived as a product of the `headcount_ratio` and `intensity_of_deprivation`. Note that this metric is presented as a fraction, while the others are percentages." }, "headcount_ratio": { "type": "number", "title": "Headcount Ratio", "description": "The percentage of people deprived in 33% or more indicators" }, "intensity_of_deprivation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Intensity Of Deprivation", "description": "The average proportion of indicators in which people are deprived, given as a percentage." }, "vulnerable_to_poverty": { "type": "number", "title": "Vulnerable To Poverty", "description": "The percentage of people deprived in 20-33% of indicators" }, "in_severe_poverty": { "type": "number", "title": "In Severe Poverty", "description": "The percentage of people deprived in 50% or more indicators" }, "reference_period_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period Start", "description": "The start date for which the data are applicable" }, "reference_period_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period End", "description": "The end date for which the data are applicable" } }, "type": "object", "required": [ "location_code", "location_name", "admin1_code", "admin1_name", "admin_level", "resource_hdx_id", "mpi", "headcount_ratio", "intensity_of_deprivation", "vulnerable_to_poverty", "in_severe_poverty", "reference_period_start", "reference_period_end" ], "title": "PovertyRateResponse" }, "PriceFlag": { "type": "string", "enum": [ "actual", "aggregate", "actual,aggregate" ], "title": "PriceFlag" }, "PriceType": { "type": "string", "enum": [ "Farm Gate", "Producer", "Retail", "Wholesale" ], "title": "PriceType" }, "RainfallResponse": { "properties": { "location_code": { "type": "string", "maxLength": 128, "title": "Location Code", "description": "A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, "location_name": { "type": "string", "maxLength": 512, "title": "Location Name", "description": "A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." }, "admin1_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin1 Code", "description": "The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets." }, "admin1_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin1 Name", "description": "The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin2_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin2 Code", "description": "The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets." }, "admin2_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin2 Name", "description": "The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin_level": { "type": "integer", "title": "Admin Level", "description": "Admin level." }, "resource_hdx_id": { "type": "string", "maxLength": 36, "title": "Resource Hdx Id", "description": "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." }, "aggregation_period": { "$ref": "#/components/schemas/AggregationPeriod", "description": "The aggregation period, available values are described here." }, "provider_admin1_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Provider Admin1 Code", "description": "The 1st subnational administrative divisions provided in the original data source." }, "provider_admin2_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Provider Admin2 Code", "description": "The 2nd subnational administrative divisions provided in the original data source." }, "rainfall": { "type": "number", "minimum": 0.0, "title": "Rainfall" }, "rainfall_long_term_average": { "type": "number", "minimum": 0.0, "title": "Rainfall Long Term Average" }, "rainfall_anomaly_pct": { "type": "number", "minimum": 0.0, "title": "Rainfall Anomaly Pct" }, "number_pixels": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Number Pixels", "description": "Rainfall number pixels" }, "version": { "anyOf": [ { "$ref": "#/components/schemas/Version" }, { "type": "null" } ], "description": "Version rainfall" }, "reference_period_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period Start", "description": "The start date for which the data are applicable" }, "reference_period_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period End", "description": "The end date for which the data are applicable" } }, "type": "object", "required": [ "location_code", "location_name", "admin1_code", "admin1_name", "admin2_code", "admin2_name", "admin_level", "resource_hdx_id", "aggregation_period", "provider_admin1_code", "provider_admin2_code", "rainfall", "rainfall_long_term_average", "rainfall_anomaly_pct", "number_pixels", "version", "reference_period_start", "reference_period_end" ], "title": "RainfallResponse" }, "RefugeesResponse": { "properties": { "resource_hdx_id": { "type": "string", "maxLength": 36, "title": "Resource Hdx Id", "description": "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." }, "population_group": { "$ref": "#/components/schemas/PopulationGroup", "description": "The population group, available values are described here." }, "gender": { "$ref": "#/components/schemas/Gender", "description": "The gender, available values are described here." }, "age_range": { "type": "string", "maxLength": 32, "title": "Age Range", "description": "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": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Min Age", "description": "The minimum age from `age_range`, set to `null` if `age_range` is \"all\" and there is no age disaggregation" }, "max_age": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Max Age", "description": "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" }, "population": { "type": "integer", "minimum": 0.0, "title": "Population", "description": "The number of people" }, "reference_period_start": { "type": "string", "format": "date-time", "title": "Reference Period Start", "description": "The start date for which the data are applicable" }, "reference_period_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period End", "description": "The end date for which the data are applicable" }, "origin_location_code": { "type": "string", "maxLength": 128, "title": "Origin Location Code", "description": "Location of origin p-code (ISO-3)" }, "origin_location_name": { "type": "string", "maxLength": 512, "title": "Origin Location Name", "description": "Location of origin name" }, "asylum_location_code": { "type": "string", "maxLength": 128, "title": "Asylum Location Code", "description": "Location of asylum p-code (ISO-3)" }, "asylum_location_name": { "type": "string", "maxLength": 512, "title": "Asylum Location Name", "description": "Location of asylum name" } }, "type": "object", "required": [ "resource_hdx_id", "population_group", "gender", "age_range", "min_age", "max_age", "population", "reference_period_start", "reference_period_end", "origin_location_code", "origin_location_name", "asylum_location_code", "asylum_location_name" ], "title": "RefugeesResponse" }, "ResourceResponse": { "properties": { "resource_hdx_id": { "type": "string", "maxLength": 36, "title": "Resource Hdx Id", "description": "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." }, "dataset_hdx_id": { "type": "string", "maxLength": 36, "title": "Dataset Hdx Id", "description": "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." }, "name": { "type": "string", "maxLength": 256, "title": "Name", "description": "The resource name on HDX. In combination with the dataset UUIDsfrom the `dataset_hdx_id` and `resource_hdx_id` fields respectively, it can be used to construct a URL to download the resource: `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]/download/[name]`, which can be found in the `download_url` field." }, "format": { "type": "string", "maxLength": 32, "title": "Format", "description": "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": { "type": "string", "format": "date-time", "title": "Update Date", "description": "The date the resource was last updated" }, "is_hxl": { "type": "boolean", "title": "Is Hxl", "description": "whether or not the resource contains HXL tags." }, "download_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Download Url", "description": "A URL to directly download the resource file from HDX, in the format specified in the `format` field." }, "hapi_updated_date": { "type": "string", "format": "date-time", "title": "Hapi Updated Date", "description": "The date that the resource was ingested into HDX HAPI" }, "dataset_hdx_stub": { "type": "string", "maxLength": 128, "title": "Dataset Hdx Stub", "description": "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": { "type": "string", "maxLength": 1024, "title": "Dataset Hdx Title", "description": "The title of the dataset as it appears in the HDX interface. This name is not unique and can change." }, "dataset_hdx_provider_stub": { "type": "string", "maxLength": 128, "title": "Dataset Hdx Provider Stub", "description": "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": { "type": "string", "maxLength": 512, "title": "Dataset Hdx Provider Name", "description": "Filter the response by the display name of the provider (organization) of the dataset on HDX." }, "hdx_link": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Hdx Link", "readOnly": true }, "hdx_api_link": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Hdx Api Link", "readOnly": true }, "dataset_hdx_link": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Dataset Hdx Link", "readOnly": true }, "dataset_hdx_api_link": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Dataset Hdx Api Link", "readOnly": true }, "provider_hdx_link": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Provider Hdx Link", "readOnly": true }, "provider_hdx_api_link": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Provider Hdx Api Link", "readOnly": true } }, "type": "object", "required": [ "resource_hdx_id", "dataset_hdx_id", "name", "format", "update_date", "is_hxl", "download_url", "hapi_updated_date", "dataset_hdx_stub", "dataset_hdx_title", "dataset_hdx_provider_stub", "dataset_hdx_provider_name", "hdx_link", "hdx_api_link", "dataset_hdx_link", "dataset_hdx_api_link", "provider_hdx_link", "provider_hdx_api_link" ], "title": "ResourceResponse" }, "ResponseValidationResponse": { "properties": { "error_sample_list": { "items": {}, "type": "array", "title": "Error Sample List" }, "error": { "type": "string", "title": "Error" } }, "type": "object", "required": [ "error_sample_list", "error" ], "title": "ResponseValidationResponse" }, "ReturneesResponse": { "properties": { "resource_hdx_id": { "type": "string", "maxLength": 36, "title": "Resource Hdx Id", "description": "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." }, "population_group": { "$ref": "#/components/schemas/PopulationGroup", "description": "The population group, available values are described here." }, "gender": { "$ref": "#/components/schemas/Gender", "description": "The gender, available values are described here." }, "age_range": { "type": "string", "maxLength": 32, "title": "Age Range", "description": "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": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Min Age", "description": "The minimum age from `age_range`, set to `null` if `age_range` is \"all\" and there is no age disaggregation" }, "max_age": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Max Age", "description": "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" }, "population": { "type": "integer", "minimum": 0.0, "title": "Population", "description": "The number of people" }, "reference_period_start": { "type": "string", "format": "date-time", "title": "Reference Period Start", "description": "The start date for which the data are applicable" }, "reference_period_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reference Period End", "description": "The end date for which the data are applicable" }, "origin_location_code": { "type": "string", "maxLength": 128, "title": "Origin Location Code", "description": "A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, "origin_location_name": { "type": "string", "maxLength": 512, "title": "Origin Location Name", "description": "A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." }, "asylum_location_code": { "type": "string", "maxLength": 128, "title": "Asylum Location Code", "description": "A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, "asylum_location_name": { "type": "string", "maxLength": 512, "title": "Asylum Location Name", "description": "A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." } }, "type": "object", "required": [ "resource_hdx_id", "population_group", "gender", "age_range", "min_age", "max_age", "population", "reference_period_start", "reference_period_end", "origin_location_code", "origin_location_name", "asylum_location_code", "asylum_location_name" ], "title": "ReturneesResponse" }, "RiskClass": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "title": "RiskClass" }, "SectorResponse": { "properties": { "code": { "type": "string", "maxLength": 32, "title": "Code", "description": "The sector code, derived either from the [Global Coordination Groups](https://data.humdata.org/dataset/global-coordination-groups-beta?) dataset, or created for HDX HAPI" }, "name": { "type": "string", "maxLength": 512, "title": "Name", "description": "The name of the sector" } }, "type": "object", "required": [ "code", "name" ], "title": "SectorResponse" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "Version": { "type": "string", "enum": [ "final", "forecast", "preliminary" ], "title": "Version" }, "VersionResponse": { "properties": { "api_version": { "type": "string", "maxLength": 16, "title": "Api Version" }, "hapi_sqlalchemy_schema_version": { "type": "string", "maxLength": 16, "title": "Hapi Sqlalchemy Schema Version" } }, "type": "object", "required": [ "api_version", "hapi_sqlalchemy_schema_version" ], "title": "VersionResponse" }, "WfpCommodityResponse": { "properties": { "code": { "type": "string", "maxLength": 32, "title": "Code", "description": "The unique code identifying the commodity" }, "category": { "$ref": "#/components/schemas/CommodityCategory", "description": "The food group that the commodity belongs to, available values are described here." }, "name": { "type": "string", "maxLength": 512, "title": "Name", "description": "The name of the commodity" } }, "type": "object", "required": [ "code", "category", "name" ], "title": "WfpCommodityResponse" }, "WfpMarketResponse": { "properties": { "location_code": { "type": "string", "maxLength": 128, "title": "Location Code", "description": "A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes." }, "location_name": { "type": "string", "maxLength": 512, "title": "Location Name", "description": "A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard." }, "admin1_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin1 Code", "description": "The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets." }, "admin1_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin1 Name", "description": "The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin2_code": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Admin2 Code", "description": "The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets." }, "admin2_name": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Admin2 Name", "description": "The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source." }, "admin_level": { "type": "integer", "title": "Admin Level", "description": "Admin level." }, "code": { "type": "string", "maxLength": 32, "title": "Code", "description": "The unique code identifying the market" }, "name": { "type": "string", "maxLength": 512, "title": "Name", "description": "The name of the market" }, "lat": { "anyOf": [ { "type": "number", "maximum": 90.0, "minimum": -90.0 }, { "type": "null" } ], "title": "Lat", "description": "The market's latitude" }, "lon": { "anyOf": [ { "type": "number", "maximum": 180.0, "minimum": -180.0 }, { "type": "null" } ], "title": "Lon", "description": "The market's longitude" } }, "type": "object", "required": [ "location_code", "location_name", "admin1_code", "admin1_name", "admin2_code", "admin2_name", "admin_level", "code", "name", "lat", "lon" ], "title": "WfpMarketResponse" } } } }