Page info | ||||||
---|---|---|---|---|---|---|
|
Note |
---|
Please be aware that the following page is relevant for the CDS API package of the current CDS system. Although some of the functionalities are common to the new CDS-Beta system we invite you to read the following page for information on some of the changes: Please read: CDS and ADS migrating to new infrastructure: Common Data Store (CDS) Engine |
Info | ||||
---|---|---|---|---|
| ||||
|
Easy Heading Macro |
---|
Introduction
The Climate Data Store (CDS) API is the service to allow users to request data from CDS datasets via a python script. These scripts use a number of keywords which vary from dataset to dataset, usually following the sections of the CDS download form.
As the CDS API cannot currently return the valid keyword list on demand, they are documented on this page for some of the most popular CDS datasets.
In the table below, we present the list of keywords (also referred to as CDS vocabulary) that can be used in these CDS API requests, along with example values for each valid keyword.
Note |
---|
Please note that not all keywords can be used for all datasets. The area selection is only available for the ERA5 family datasets and the Seasonal forecast datasets. CORDEX, CMIP5 and UERRA datasets cannot be regridded. Users are recommended to construct CDS API scripts by using the web interface of the relevant dataset to build a valid request and then using the 'Show API request' button to get the corresponding CDS API code. |
Color legend
Keyword allowed | |
Keyword not allowed |
If a keyword which is not allowed is used, the resulting output file could be corrupted or incomplete or an error could occurred when running the script.
ERA5 family datasets
Datasets name | Keywords | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Product type | variable | year | month | day | time | format** | grid* | area | pressure_level | Example script | |
ERA5 hourly data on single levels from 1979 to present: |
Table of Contents | ||
---|---|---|
|
The Climate Data Store (CDS) API is the service to allow users to request data from CDS datasets via a python script. These scripts use a number of keywords which vary from dataset to dataset, usually following the sections of the CDS download form.
As the CDS API cannot currently return the valid keyword list on demand, they are documented on this page for some of the most popular CDS datasets.
In the table below, we present the list of keywords (also referred to as CDS vocabulary) that can be used in these CDS API requests, along with example values for each valid keyword.
Note |
---|
Please note that not all keywords can be used for all datasets. The area selection is only available for the ERA5 family datasets and the Seasonal forecast datasets. CORDEX, CMIP5 and UERRA datasets cannot be regridded. Users are recommended to construct CDS API scripts by using the web interface of the relevant dataset to build a valid request and then using the 'Show API request' button to get the corresponding CDS API code. |
Color legend
...
If a keyword which is not allowed is used, the resulting output file could be corrupted or incomplete or an error could occurred when running the script.
ERA5 family datasets
Datasets name | Keywords | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Product type | variable | year | month | day | time | format** | area | pressure_level | Example script | ERA5 hourly data on single levels from 1979 to present:'reanalysis-era5-single-levels' | 'reanalysis' | 'total_precipitation' | '2019' | '01' | '01 | '00:00' | 'netcdf' | [1.0,1.0] | [N,W,S,E] |
| ||||||||
ERA5 monthly averaged data on single levels from 1979 to present: 'reanalysis-era5-single-levels-monthly-means' | 'monthly_averaged_reanalysis' | 'total_precipitation' | '2019' | '01' | '00:00' | 'netcdf' | [1.0,1.0] | [N,W,S,E] |
| |||||||||||||||||||
ERA5 hourly data on pressure levels from 1979 to present: 'reanalysis-era5-pressure-levels' | 'reanalysis' | 'temperature' | '2019' | '01' | '01 | '00:00' | 'netcdf' | [1.0,1.0] | [N,W,S,E] | '850' |
| |||||||||||||||||
ERA5 monthly averaged data on pressure levels from 1979 to present: 'reanalysis-era5-pressure-levels-monthly-means' | 'monthly_averaged_reanalysis' | 'relative humidity' | '2019' | '01' | '00:00' | 'netcdf' | [1.0,1.0] | [N,W,S,E] | '850' |
| ||||||||||||||||||
ERA5-Land hourly data from 2001 to present: 'reanalysis-era5-land' | 'total_precipitation' | '2019' | '01' | '01 | '00:00' | 'netcdf' | [1.0,1.0] | [N,W,S,E] |
| |||||||||||||||||||
ERA5-Land monthly averaged data from 2001 to present: 'reanalysis-era5-land-monthly-means' | 'monthly_averaged_reanalysis' | 'total_precipitation' | '2019' | '01' | '00:00' | 'grib' | [1.0,1.0] | [N,W,S,E] |
|
* Latitude/longitude grid. Default: 0.25 x 0.25
** If 'netcdf' selected, the keyword 'grid' must be included.
Datasets name | Keywords | ||||||||||||||||
class | date* | levelist* | levtype | param | stream | time | type | grid | area | format** | Example script | ||||||
reanalysis-era5-complete: | 'ea' | '2020-01-01' | '1' | 'ml' | '155' | 'oper' | '00:00' | 'an' If 'fc' the keyword 'step' have to be added to the script. | [1.0,1.0] | [N,W,S,E] | 'grib' or 'netcdf' |
|
*The syntax '/to/' could be use for intervals.
** If 'netcdf' selected, the keyword 'grid' must be included.
Seasonal forecasts datasets
...
Datasets name | Keywords | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
variable | format | experiment | ensemble_member | period | model | Example script | ||||||||
CMIP5 daily data on single levels: 'projections-cmip5-daily-single-levels' | '2m_temperature' | 'zip' | 'historical' | 'r1i1p1' | '19750101-19991231' | 'access1_3' |
| |||||||
CMIP5 monthly data on single levels: 'projections-cmip5-monthly-single-levels' | '10m_wind_speed' | 'zip' | 'amip' | 'r1i1p1' | '197901-200812' | 'cnrm_cm5' |
| |||||||
CMIP5 daily data on pressure levels: 'projections-cmip5-daily-pressure-levels' | 'u_component_of_wind' | 'zip' | 'historical' | 'r1i1p1' | '20050101-20051231' | 'access1_0' |
| |||||||
CMIP5 monthly data on pressure levels: 'projections-cmip5-monthly-pressure-levels' | 'u_component_of_wind' | 'tgz' | 'rcp_2_6' | 'r3i1p1' | '200601-210012' | 'ipsl_cm5a_lr' |
|
Info | ||
---|---|---|
| ||
This document has been produced in the context of the Copernicus Climate Change Service (C3S). The activities leading to these results have been contracted by the European Centre for Medium-Range Weather Forecasts, operator of C3S on behalf of the European Union (Delegation Agreement signed on 11/11/2014 and Contribution Agreement signed on 22/07/2021). All information in this document is provided "as is" and no guarantee or warranty is given that the information is fit for any particular purpose. The users thereof use the information at their sole risk and liability. For the avoidance of all doubt , the European Commission and the European Centre for Medium - Range Weather Forecasts have no liability in respect of this document, which is merely representing the author's view. |
Related articles
Content by Label | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|