---
title: "Get rainfall data"
method: GET
path: "/api/v2/climate/rainfall"
tags: ["Climate"]
---

# Get rainfall data

`GET /api/v2/climate/rainfall`

Rainfall data . See the more detailed technical <a href="https://hdx-hapi.readthedocs.io/en/latest/data_usage_guides/

## 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.
- `aggregation_period` 'dekad' | '1-month' | '3-month'
- `version` 'final' | 'forecast' | 'preliminary'
- `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 <a href="https://humanitarianaction.info/">Global Humanitarian Overview</a>.
- `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 <a href="/docs#/Metadata/get_locations_api_v1_metadata_location_get" target="_blank">location endpoint</a> 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 <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>. See the <a href="/docs#/Metadata/get_locations_api_v1_metadata_location_get" target="_blank">location endpoint</a> 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 <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. See the <a href="/docs#/Metadata/get_admin1_api_v1_metadata_admin1_get" target="_blank">admin1 endpoint</a> for details.
- `admin1_name` string, nullable — Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. See the <a href="/docs#/Metadata/get_admin1_api_v1_metadata_admin1_get" target="_blank">admin1 endpoint</a> 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 <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>. See the <a href="/docs#/Metadata/get_admin2_api_v1_metadata_admin2_get" target="_blank">admin2 endpoint</a> for details.
- `admin2_name` string, nullable — Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source. See the <a href="/docs#/Metadata/get_admin2_api_v1_metadata_admin2_get" target="_blank">admin2 endpoint</a> 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

- HapiGenericResponseRainfallResponse
  - `data` RainfallResponse[], 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 <a href="https://unstats.un.org/unsd/methodology/m49/#fn2">UN M49 Standard</a>.
    - `admin1_code` string, nullable, required — The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>.
    - `admin1_name` string, nullable, required — The 1st subnational administrative divisions. The admin1 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source.
    - `admin2_code` string, nullable, required — The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>.
    - `admin2_name` string, nullable, required — The 2nd subnational administrative divisions. The admin2 names refer to either the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a> or those provided in the original data source.
    - `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.
    - `aggregation_period` 'dekad' | '1-month' | '3-month', required
    - `provider_admin1_code` string, nullable, required — The 1st subnational administrative divisions provided in the original data source.
    - `provider_admin2_code` string, nullable, required — The 2nd subnational administrative divisions provided in the original data source.
    - `rainfall` number, required
    - `rainfall_long_term_average` number, required
    - `rainfall_anomaly_pct` number, required
    - `number_pixels` integer, nullable, required — Rainfall number pixels
    - `version` 'final' | 'forecast' | 'preliminary', required
    - `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)