--- title: "Get baseline population data" method: GET path: "/api/v2/geography-infrastructure/baseline-population" tags: ["Geography & Infrastructure"] --- # Get baseline population data `GET /api/v2/geography-infrastructure/baseline-population` Baseline population data sourced and maintained by UNFPA (UN Population Fund). See the more detailed technical HDX HAPI documentation, and the UNFPA on HDX. ## Query parameters - `app_identifier` string, nullable, required — base64 encoded application name and email, as in `base64("app_name:email")`. This value can also be passed in the `X-HDX-HAPI-APP-IDENTIFIER` header. See the *encoded_app_identifier* endpoint. - `gender` 'f' | 'm' | 'x' | 'u' | 'o' | 'all' - `age_range` string, nullable — Filter the response by the age range. These are expressed as [start age]-[end age], or [start age]+ for an age range starting at [start age] or above. The end age is assumed to be inclusive, though that is not always explicit in the source data. - `population_min` integer, nullable — Filter the response by a lower bound for the population. - `population_max` integer, nullable — Filter the response by a upper bound for the population. - `has_hrp` boolean, nullable — Filter the response by the has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan. - `in_gho` boolean, nullable — Filter the response by the in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview. - `start_date` string, nullable — Filter entries to include rows where the reference period overlaps with or extends beyond this date, e.g. 2020, 2020-01, 2020-01-01 or 2020-01-01T00:00:00 - `end_date` string, nullable — Filter entries to include rows where the reference period overlaps with or begins prior to this date, e.g. 2020, 2020-01, 2020-01-01, 2020-01-01 or 2020-01-01T23:59:59 - `location_code` string, nullable — 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. - `location_name` string, nullable — 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. - `admin1_code` string, nullable — 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. - `admin1_name` string, nullable — 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. - `admin2_code` string, nullable — 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. - `admin2_name` string, nullable — 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. - `admin_level` '0' | '1' | '2' - `output_format` 'csv' | 'json' - `limit` integer — Maximum number of records to return. The system will not return more than 10,000 records. - `offset` integer — Number of records to skip in the response. Use in conjunction with the limit parameter to paginate. ## Response `200` Successful Response - HapiGenericResponsePopulationResponse - `data` PopulationResponse[], required - `location_code` string, required — A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes. - `location_name` string, required — A location (typically a country). The location names are based on the "short name" from the UN M49 Standard. - `admin1_code` string, nullable, required — The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets. - `admin1_name` string, nullable, required — 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` string, nullable, required — The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets. - `admin2_name` string, nullable, required — 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` integer, required — Admin level. - `resource_hdx_id` string, required — 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` 'f' | 'm' | 'x' | 'u' | 'o' | 'all', required - `age_range` string, required — 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` integer, nullable, required — The minimum age from `age_range`, set to `null` if `age_range` is "all" and there is no age disaggregation - `max_age` integer, nullable, required — 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` integer, required — The number of people - `reference_period_start` string, date-time, nullable, required — The start date for which the data are applicable - `reference_period_end` string, date-time, nullable, required — The end date for which the data are applicable ## Other responses - `400` — Bad Request - `422` — Validation Error - `500` — Internal Server Error --- [API](https://skmtc.dev/humdata/apis/hdx-apis.md) · [All operations](https://skmtc.dev/humdata/apis/hdx-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/humdata/hdx-apis/revisions/cc1970bc392c/schema)