githubEdit

API Endpoints

Get Forecasting Metadata

get

Get information about available forecasting models.

Responses
chevron-right
200

Successful Response

application/json
get
/v1/forecasting
200

Successful Response

Get Available Init Times

get

Get list of available initialization times for a model.

Supported Models:

  • ept1_5, ept1_5_early, ept2, ept2_early, ept2_e, ept2_rr, aurora, aifs, ecmwf_ifs_single, icon_global

Unsupported Models:

  • ecmwf_ifs025_single, ecmwf_ifs025_ensemble, ecmwf_aifs025_single, ecmwf_aifs025_ensemble, meteofrance_arome_france_hd, gfs_global_single, gfs_global_ensemble, icon_eu, gfs_graphcast025

Using an unsupported model will return a 404 error with details about supported and unsupported models.

Path parameters
model_namestring · enumRequiredPossible values:
Responses
chevron-right
200

Successful Response

application/json
get
/v1/forecasting/{model_name}/forecasts/available_init_times

Get Latest Metadata

get

Get information about the latest forecast.

Path parameters
model_namestring · enumRequiredPossible values:
Query parameters
min_hours_availableany ofOptional

Minimum hours available for the forecast

integerOptional
or
nullOptional
use_new_namingbooleanOptional

Use new variable naming

Default: true
Responses
chevron-right
200

Successful Response

application/json
get
/v1/forecasting/{model_name}/forecasts/latest

Get latest forecast for specific points, (max 5 points, 24 hours per query)

post

Get latest forecast for the selected model and specified points at a range of lead times.

Path parameters
model_namestring · enumRequiredPossible values:
Body

At the moment we allow querying multiple Coordinates for multiple lead times, and selecting variables of interest..

min_lead_timeintegerOptional

The start of the lead time range

Default: 0
max_lead_timeintegerOptional

The end of the lead time range (inclusive)

Default: 0
fullbooleanOptional

If true, returns the latest forecast with the full horizon available

Default: false
ensemble_statsany ofOptional

If provided, returns the ensemble statistics for the given variables

or
nullOptional
use_new_namingbooleanOptional

Use new variable naming

Default: false
Responses
chevron-right
200

Successful Response

application/json
post
/v1/forecasting/{model_name}/forecasts/latest

Get Forecast Metadata By Init Time

get

Get information about a forecast for a specific initialization time.

Path parameters
model_namestring · enumRequiredPossible values:
init_timestring · date-timeRequired
Query parameters
use_new_namingbooleanOptional

Use new variable naming

Default: true
Responses
chevron-right
200

Successful Response

application/json
get
/v1/forecasting/{model_name}/forecasts/{init_time}

Get latest forecast for specific point

get

Get latest forecast for the selected model and specified points at a range of lead times.

Path parameters
model_namestring · enumRequiredPossible values:
latnumber · min: -90 · max: 90Required
lonnumber · min: -180 · max: 180Required
Query parameters
min_lead_timeintegerOptional

The start of the lead time range

Default: 0
max_lead_timeintegerOptional

The end of the lead time range (inclusive)

Default: 24
fullbooleanOptional

If true, returns the latest forecast with the full horizon available

Default: false
ensemble_statsany ofOptional

If provided, returns the ensemble statistics for the given variables

or
nullOptional
use_new_namingbooleanOptional

Use new variable naming

Default: false
Responses
chevron-right
200

Successful Response

application/json
get
/v1/forecasting/{model_name}/forecasts/latest/{lat},{lon}

Get forecast for specific init time and point

get

Get forecast for the selected model at specified initialization time and point at a range of lead times.

Path parameters
model_namestring · enumRequiredPossible values:
init_timestring · date-timeRequired
latnumber · min: -90 · max: 90Required
lonnumber · min: -180 · max: 180Required
Query parameters
min_lead_timeintegerOptional

The start of the lead time range

Default: 0
max_lead_timeintegerOptional

The end of the lead time range (inclusive)

Default: 24
fullbooleanOptional

If true, returns the latest forecast with the full horizon available

Default: false
ensemble_statsany ofOptional

If provided, returns the ensemble statistics for the given variables

or
nullOptional
use_new_namingbooleanOptional

Use new variable naming

Default: false
Responses
chevron-right
200

Successful Response

application/json
get
/v1/forecasting/{model_name}/forecasts/{init_time}/{lat},{lon}

Get Available Forecasts

get

Get a list of available forecasts per model.

Query parameters
min_init_timeany ofOptional
string · date-timeOptional
or
nullOptional
limitintegerOptionalDefault: 100
Responses
chevron-right
200

Successful Response

application/json
get
/v1/analytics/aggregates/available-forecasts

Get Data

get

Get aggregated data for a given model, zone, init time, and variable.

Query parameters
modelstring · enumRequiredPossible values:
zonestringRequired
init_timestring · date-timeRequired
min_lead_timeintegerRequired
max_lead_timeintegerRequired
variablestring · enumRequired

Weather variable name with units: • air_temperature_at_height_level_2m: K • surface_temperature: K • dew_point_temperature_at_height_level_2m: K • relative_humidity_at_height_level_2m: % • air_pressure_at_mean_sea_level: Pa • surface_air_pressure: Pa • wind_speed_at_height_level_10m: m/s • wind_direction_at_height_level_10m: degrees • wind_speed_at_height_level_100m: m/s • wind_direction_at_height_level_100m: degrees • wind_speed_at_height_level_200m: m/s • wind_direction_at_height_level_200m: degrees • geopotential_at_pressure_level_50000Pa: m²/s² • eastward_wind_at_height_level_10m: m/s • northward_wind_at_height_level_10m: m/s • eastward_wind_at_height_level_100m: m/s • northward_wind_at_height_level_100m: m/s • wind_speed_of_gust_at_height_level_10m_max: m/s • surface_direct_downwelling_shortwave_flux_sum_1h: J/m² • surface_downwelling_longwave_flux_sum_1h: J/m² • surface_downwelling_shortwave_flux_sum_1h: J/m² • surface_downwelling_longwave_flux_sum_6h: J/m² • surface_downwelling_shortwave_flux_sum_6h: J/m² • surface_net_downward_longwave_flux_sum_1h: J/m² • surface_net_downward_shortwave_flux_sum_1h: J/m² • surface_net_downward_longwave_flux_sum_6h: J/m² • surface_net_downward_shortwave_flux_sum_6h: J/m² • cloud_area_fraction_at_entire_atmosphere: fraction (0-1) • cloud_area_fraction_at_entire_atmosphere_high_type: fraction (0-1) • cloud_area_fraction_at_entire_atmosphere_medium_type: fraction (0-1) • cloud_area_fraction_at_entire_atmosphere_low_type: fraction (0-1) • precipitation_amount_sum_1h: mm • precipitation_amount_sum_3h: mm • precipitation_amount_sum_6h: mm • precipitation_amount_sum_12h: mm • precipitation_amount_sum_24h: mm • atmosphere_convective_available_potential_energy: J/kg • predominant_precipitation_type_at_surface: categorical • sea_surface_temperature: K

Possible values:
weightstring · enumRequiredPossible values:
Responses
chevron-right
200

Successful Response

application/json
get
/v1/analytics/aggregates/data

Last updated