The API utilizes GEM models from the Canadian Meteorological Center, optimized for North America. However, updates every 6 hours may not reflect the latest weather developments. For accurate forecasts for any location worldwide, the generic Weather Forecast API is recommended.
Data Source
This API uses Global Environmental Multiscale Model (GEM) from the Canadian weather service. Global and regional weather models are combined into a seamless prediction. For GEM Global, values are interpolated from 3-hourly to 1-hourly values.
| Weather Model | Region | Spatial Resolution | Temporal Resolution | Forecast Length | Update frequency |
|---|---|---|---|---|---|
| GEM Global | Global | 0.15° (~15 km) | 3-Hourly | 10 days | Every 12 hours |
| GEM Regional | North America, North Pole | 10 km | Hourly | 3.5 days | Every 6 hours |
| HRDPS Continental | Canada, Nothern US | 2.5 km | Hourly | 2 days | Every 6 hours |
API Documentation
The API endpoint /v1/gem accepts a geographical coordinate, a list of weather variables and responds with a JSON hourly weather forecast for 7 days. Time always starts at 0:00 today and contains 168 hours. All URL parameters are listed below:
| Parameter | Format | Required | Default | Description |
|---|---|---|---|---|
| latitude, longitude | Floating point | Yes | Geographical WGS84 coordinate of the location | |
| elevation | Floating point | No | The elevation used for statistical downscaling. Per default, a 90 meter digital elevation model is used. You can manually set the elevation to correctly match mountain peaks. If &elevation=nan is specified, downscaling will be disabled and the API uses the average grid-cell height. | |
| hourly | String array | No | A list of weather variables which should be returned. Values can be comma separated, or multiple &hourly= parameter in the URL can be used. | |
| daily | String array | No | A list of daily weather variable aggregations which should be returned. Values can be comma separated, or multiple &daily= parameter in the URL can be used. If daily weather variables are specified, parameter timezone is required. | |
| current_weather | Bool | No | false | Include current weather conditions in the JSON output. |
| temperature_unit | String | No | celsius | If fahrenheit is set, all temperature values are converted to Fahrenheit. |
| windspeed_unit | String | No | kmh | Other wind speed speed units: ms, mph and kn |
| precipitation_unit | String | No | mm | Other precipitation amount units: inch |
| timeformat | String | No | iso8601 | If format unixtime is selected, all time values are returned in UNIX epoch time in seconds. Please note that all timestamp are in GMT+0! For daily values with unix timestamps, please apply utc_offset_seconds again to get the correct date. |
| timezone | String | No | GMT | If timezone is set, all timestamps are returned as local-time and data is returned starting at 00:00 local-time. Any time zone name from the time zone database is supported. If auto is set as a time zone, the coordinates will be automatically resolved to the local time zone. |
| past_days | Integer | No | 0 | If past_days is set, past weather data can be returned. |
| start_date end_date |
String (yyyy-mm-dd) | No | The time interval to get weather data. A day must be specified as an ISO8601 date (e.g. 2022-06-30). | |
| cell_selection | String | No | land | Set a preference how grid-cells are selected. The default land finds a suitable grid-cell on land with similar elevation to the requested coordinates using a 90-meter digital elevation model. sea prefers grid-cells on sea. nearest selects the nearest possible grid-cell. |
| apikey | String | No | Only required to commercial use to access reserved API resources for customers. The server URL requires the prefix customer-. See pricing for more information. |
Additional optional URL parameters will be added. For API stability, no required parameters will be added in the future!
Hourly Parameter Definition
The parameter &hourly= accepts the following values. Most weather variables are given as an instantaneous value for the indicated hour. Some variables like precipitation are calculated from the preceding hour as an average or sum.
| Variable | Valid time | Unit | Description |
|---|---|---|---|
| temperature_2m temperature_40m temperature_80m temperature_120m |
Instant | °C (°F) | Air temperature at 2, 40, 80 or 120 meters above ground. 2 m is the standard level. |
| relativehumidity_2m | Instant | % | Relative humidity at 2 meters above ground |
| dewpoint_2m | Instant | °C (°F) | Dew point temperature at 2 meters above ground |
| apparent_temperature | Instant | °C (°F) | Apparent temperature is the perceived feels-like temperature combining wind chill factor, relative humidity and solar radiation |
| pressure_msl surface_pressure |
Instant | hPa | Atmospheric air pressure reduced to mean sea level (msl) or pressure at surface. Typically pressure on mean sea level is used in meteorology. Surface pressure gets lower with increasing elevation. |
| cloudcover | Instant | % | Total cloud cover as an area fraction |
| cloudcover_low | Instant | % | Low level clouds and fog up to 3 km altitude. Note: Low, medium and high clouds are calculated from pressure level data. Totcal cloud cover might differ. |
| cloudcover_mid | Instant | % | Mid level clouds from 3 to 8 km altitude |
| cloudcover_high | Instant | % | High level clouds from 8 km altitude |
| windspeed_10m windspeed_40m windspeed_80m windspeed_120m |
Instant | km/h (mph, m/s, knots) | Wind speed at 10, 40, 80 or 120 meters above ground. Wind speed on 10 meters is the standard level. |
| winddirection_10m winddirection_40m winddirection_80m winddirection_120m |
Instant | ° | Wind direction at 10, 40, 80 or 120 meters above ground |
| windgusts_10m | Preceding hour max | km/h (mph, m/s, knots) | Gusts at 10 meters above ground as a maximum of the preceding hour |
| shortwave_radiation | Preceding hour mean | W/m² | Shortwave solar radiation as average of the preceding hour. This is equal to the total global horizontal irradiation |
| direct_radiation direct_normal_irradiance |
Preceding hour mean | W/m² | Direct solar radiation as average of the preceding hour on the horizontal plane and the normal plane (perpendicular to the sun). GEM does not offers diffuse and direct radiation directly. It is approximated based on Razo, Müller Witwer |
| diffuse_radiation | Preceding hour mean | W/m² | Diffuse solar radiation as average of the preceding hour. GEM does not offers diffuse and direct radiation directly. It is approximated based on Razo, Müller Witwer |
| vapor_pressure_deficit | Instant | kPa | Vapor Pressure Deificit (VPD) in kilopascal (kPa). For high VPD (>1.6), water transpiration of plants increases. For low VPD (<0.4), transpiration decreases |
| et0_fao_evapotranspiration | Preceding hour sum | mm (inch) | ET₀ Reference Evapotranspiration of a well watered grass field. Based on FAO-56 Penman-Monteith equations ET₀ is calculated from temperature, wind speed, humidity and solar radiation. Unlimited soil water is assumed. ET₀ is commonly used to estimate the required irrigation for plants. |
| weathercode | Instant | WMO code | Weather condition as a numeric code. Follow WMO weather interpretation codes. See table below for details. Weather code is calculated from cloud cover analysis, precipitation, snowfall, cape and gusts. |
| precipitation | Preceding hour sum | mm (inch) | Total precipitation (rain, showers, snow) sum of the preceding hour |
| snowfall | Preceding hour sum | cm (inch) | Snowfall amount of the preceding hour in centimeters. For the water equivalent in millimeter, divide by 7. E.g. 7 cm snow = 10 mm precipitation water equivalent |
| rain | Preceding hour sum | mm (inch) | Rain from large scale weather systems of the preceding hour in millimeter |
| showers | Preceding hour sum | mm (inch) | Showers from convective precipitation in millimeters from the preceding hour |
| soil_temperature_0_to_10cm | Instant | °C (°F) | Average temperature in the soil at 0-10 cm depts. |
| soil_moisture_0_to_10cm | Instant | m³/m³ | Average soil water content as volumetric mixing ratio at 0-10 cm depth. |
Pressure Level Variables
Pressure level variables do not have fixed altitudes. Altitude varies with atmospheric pressure. 1000 hPa is roughly between 60 and 160 meters above sea level. Estimated altitudes are given below. Altitudes are in meters above sea level (not above ground). For precise altitudes, geopotential_height can be used.
GEM includes a 1050 hPa level, which technically is to a level below ground. Please note, that this is not the soil temperature! If geopotential height is below ground, data should not be used.
| Level (hPa) | 10 | 20 | 30 | 50 | 100 | 150 | 175 | 200 | 225 | 250 | 275 | 300 | 350 | 400 | 450 | 500 | 550 | 600 | 650 | 700 | 750 | 800 | 850 | 875 | 900 | 925 | 950 | 970 | 985 | 1000 | 1015 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Altitude | 26 km | 23 km | 22 km | 19.3 km | 15.8 km | 13.5 km | 12.6 km | 11.8 km | 11 km | 10.4 km | 9.7 km | 9.2 km | 8.1 km | 7.2 km | 6.3 km | 5.6 km | 4.9 km | 4.2 km | 3.6 km | 3 km | 2.5 km | 1900 m | 1500 m | 1200 m | 1000 m | 800 m | 500 m | 370 m | 240 m | 110 m | -10 m |
All pressure level have valid times of the indicated hour (instant).
| Variable | Unit | Description |
|---|---|---|
| weathercode | WMO code | The most severe weather condition on a given day |
| temperature_1000hPa temperature_975hPa, ... |
°C (°F) | Air temperature at the specified pressure level. Air temperatures decrease linearly with pressure. |
| relativehumidity_1000hPa relativehumidity_975hPa, ... |
% | Relative humidity at the specified pressure level. |
| dewpoint_1000hPa dewpoint_975hPa, ... |
°C (°F) | Dew point temperature at the specified pressure level. |
| cloudcover_1000hPa cloudcover_975hPa, ... |
% | Cloud cover at the specified pressure level. GEM does not inlude parameterised cloud cover directly. It is approximated based on relative humidity using Sundqvist et al. (1989). It may not match perfectly with low, mid and high cloud cover variables. |
| windspeed_1000hPa windspeed_975hPa, ... |
km/h (mph, m/s, knots) | Wind speed at the specified pressure level. |
| winddirection_1000hPa winddirection_975hPa, ... |
° | Wind direction at the specified pressure level. |
| geopotential_height_1000hPa geopotential_height_975hPa, ... |
meter | Geopotential height at the specified pressure level. This can be used to get the correct altitude in meter above sea level of each pressure level. Be carefull not to mistake it with altitude above ground. |
Daily Parameter Definition
Aggregations are a simple 24 hour aggregation from hourly values. The parameter &daily= accepts the following values:
| Variable | Unit | Description |
|---|---|---|
| weathercode | WMO code | The most severe weather condition on a given day |
| temperature_2m_max temperature_2m_min |
°C (°F) | Maximum and minimum daily air temperature at 2 meters above ground |
| apparent_temperature_max apparent_temperature_min |
°C (°F) | Maximum and minimum daily apparent temperature |
| precipitation_sum | mm | Sum of daily precipitation (including rain, showers and snowfall) |
| rain_sum | mm | Sum of daily rain |
| showers_sum | mm | Sum of daily showers |
| snowfall_sum | cm | Sum of daily snowfall |
| precipitation_hours | hours | The number of hours with rain |
| sunrise sunset |
iso8601 | Sun rise and set times |
| windspeed_10m_max windgusts_10m_max |
km/h (mph, m/s, knots) | Maximum wind speed and gusts on a day |
| winddirection_10m_dominant | ° | Dominant wind direction |
| shortwave_radiation_sum | MJ/m² | The sum of solar radiation on a given day in Megajoules |
| et0_fao_evapotranspiration | mm | Daily sum of ET₀ Reference Evapotranspiration of a well watered grass field |
JSON Return Object
On success a JSON object will be returned.
"latitude": 52.52,
"longitude": 13.419,
"elevation": 44.812,
"generationtime_ms": 2.2119,
"utc_offset_seconds": 0,
"timezone": "Europe/Berlin",
"timezone_abbreviation": "CEST",
"hourly": {
"time": ["2022-07-01T00:00", "2022-07-01T01:00", "2022-07-01T02:00", ...],
"temperature_2m": [13, 12.7, 12.7, 12.5, 12.5, 12.8, 13, 12.9, 13.3, ...]
},
"hourly_units": {
"temperature_2m": "°C"
},
"current_weather": {
"time": "2022-07-01T09:00",
"temperature": 13.3,
"weathercode": 3,
"windspeed": 10.3,
"winddirection": 262
}
| Parameter | Format | Description |
|---|---|---|
| latitude, longitude | Floating point | WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be a few kilometers away from the requested coordinate. |
| elevation | Floating point | The elevation from a 90 meter digital elevation model. This effects which grid-cell is selected (see parameter cell_selection). Statistical downscaling is used to adapt weather conditions for this elevation. This elevation can also be controlled with the query parameter elevation. If &elevation=nan is specified, all downscaling is disabled and the averge grid-cell elevation is used. |
| generationtime_ms | Floating point | Generation time of the weather forecast in milliseconds. This is mainly used for performance monitoring and improvements. |
| utc_offset_seconds | Integer | Applied timezone offset from the &timezone= parameter. |
| timezone timezone_abbreviation |
String | Timezone identifier (e.g. Europe/Berlin) and abbreviation (e.g. CEST) |
| hourly | Object | For each selected weather variable, data will be returned as a floating point array. Additionally a time array will be returned with ISO8601 timestamps. |
| hourly_units | Object | For each selected weather variable, the unit will be listed here. |
| daily | Object | For each selected daily weather variable, data will be returned as a floating point array. Additionally a time array will be returned with ISO8601 timestamps. |
| daily_units | Object | For each selected daily weather variable, the unit will be listed here. |
| current_weather | Object | Current weather conditions with the attributes: time, temperature, windspeed, winddirection and weathercode |
Errors
In case an error occurs, for example a URL parameter is not correctly specified, a JSON error object is returned with a HTTP 400 status code.
"error": true,
"reason": "Cannot initialize WeatherVariable from invalid String value tempeture_2m for key hourly"