Domains API
Calls to the Domains API provide an inventory of available model domains, either globally or for a specified pair of coordinates.
API Queries
Three separate endpoints are available for retrieving domain information from the API:
fullList
To retrieve a complete list of all available domains, the fullList
endpoint can be used. If the call also contains coordinates, the availableAtPoint
parameter will indicate whether the point lies within the domain's boundaries.
Example URL: https://my.meteoblue.com/meta/domains/fullList?lat=45&lon=8&apikey=DEMOKEY
multimodel
The multimodel
endpoint returns a filtered list of domains available at the provided coordinates.
Example URL: https://my.meteoblue.com/meta/domains/multimodel?lat=45&lon=8&apikey=DEMOKEY
select
Using the select
endpoint, information on a specified domain can be retrieved by providing its name through the domain
parameter.
Example URL: https://my.meteoblue.com/meta/domains/select?domain=NEMS4&apikey=DEMOKEY
Mandatory URL Query Parameters
Parameter | Description | Example |
---|---|---|
apikey | Your personal API key | &apikey=DEMOKEY |
Optional URL Query Parameters
Parameter | Description | Example | Default |
---|---|---|---|
lat | Latitude coordinate in WGS-84 | &lat=47.5584 | none |
lon | Longitude coordinate in WGS-84 | &lon=7.57327 | none |
API Output
[
{
"name": "IFSENS04",
"updateTimeUtc": 1719914480,
"sourceUrl": "https://www.ecmwf.int/",
"modelInit": "20240702T0000",
"source": "ECMWF",
"firstForecastHourUtc": 1719878400,
"historyDataStart": "20230501T0000",
"lastForecastHourUtc": 1721174400,
"supportsSounding": false,
"supportsMultimodel": false,
"availableAtPoint": true,
"region": "Global",
"temporalResolution": "3hourly",
"spatialResolution": "30.0 km",
"modelName": "IFSENS-40",
"updateFrequencyInSeconds": 43200,
"modelColor": "#000000"
},
...
]
Variable | Description | Type |
---|---|---|
name | Designation of the domain | String |
modelName | Designation of the model | String |
source | Designation of the domain's provider | String |
sourceUrl | URL to the website of the domain's provider | String (URL) |
modelInit | Most recent model run's initialisation time | String (ISO 8601 timestamp) |
updateTimeUtc | Most recent update in Coordinated Universal Time | Integer (Unix timestamp) |
firstForecastHourUtc | Most recent update's first timestep in Coordinated Universal Time | Integer (Unix timestamp) |
lastForecastHourUtc | Mmost recent update's last timestep in Coordinated Universal time | Integer (Unix timestamp) |
historyDataStart | First timestep for which historical data is available | String (ISO 8601 timestamp) |
historyDataFinalRun | Last model run (only for discontinued domains) | String (ISO 8601 timestamp) |
supportsSounding | Whether or not this domain can provide sounding data | Boolean |
supportsMultimodel | Whether or not this domain can be used as part of a MultiModel | Boolean |
availableAtPoint | Whether this domain is available at the specified coordinates | Boolean |
region | Name of the area for which this domain is available | String |
spatialResolution | Size of grid cells in kilometres | String |
temporalResolution | Interval between timesteps | String |
updateFrequencyInSeconds | Interval between updates | Integer |
modelColor | Model's color in the MultiModel display | String (Hex) |