Authorization
Authorization endpoint is used to fetch tokens for API access. Tokens are disposable, and should only be used for a single session. User and password must be kept secret and this request must be performed from a trusted source. Token lifetime in seconds is given in the authorization response.
Token
user
Application key username
password
Application key password
/authorize/token
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9mbnc2LmZvcmVjYS5jb21cL2F1dGhvcml6ZVwvdG9rZW4iLCJpYXQiOjE1MjYzMDAzODAsImV4cCI6MTUyNjMwMzk4MCwibmJmIjoxNTI2MzAwMzgwLCJqdGkiOiJxSXl3WVlQNjc1NkczejBEIiwic3ViIjoibFFHa1Y4Z2pIeGUyZU1ibndUUUs4NktqVTY3RXJlS2htenY1IiwicHJ2IjoiYWY3YTAzOThkZGNiNWE3YTUzN2Q3YzdkMjU2NWEyZjgxZGM4ZTQxNCJ9.V8xg6L9yrY9__VH-jdrL_CqXisEpgcfdUa0NoxlGz0k",
"expires_in": 3600,
"token_type": "bearer"
}Weather API
Weather API exposes an HTTP interface, providing global weather point forecasts.
Location search
Locations and associated identifiers matching a search query. Can be used as alternatives to coordinates.
query
Search query
/api/v1/location/search/:query
{
"locations": [
{
"id": 102643743,
"name": "London",
"country": "United Kingdom",
"timezone": "Europe/London",
"lon": -0.125532746,
"lat": 51.508415222
},
{
"id": 103458449,
"name": "Londrina",
"country": "Brazil",
"timezone": "America/Sao_Paulo",
"lon": -51.162776947,
"lat": -23.310277939
},
{
"id": 106058560,
"name": "London",
"country": "Canada",
"timezone": "America/Toronto",
"lon": -81.233039856,
"lat": 42.983390808
}
]
}Observations
Observations from a nearby representative weather station.
location
"Longitude,latitude" or location identifier (id) from the location endpoint
tz (optional)
Time zone of returned dates
stations (optional)
Amount of stations (default 3, maximum 6)
tempunit (optional)
Temperature unit: "C", "F" (default "C")
windunit (optional)
Wind unit: "MS" (m/s), "KTS" (knots), "KMH" (km/h), or "MPH" (mph) (default m/s)
/api/v1/observation/latest/:location
{
"observations": [
{
"station": "Espoo Tapiola",
"distance": "21 km N",
"time": "2020-03-16T14:30:00+02:00",
"temperature": 5,
"feelsLikeTemp": 2,
"symbol": "d400",
"windDirString": "NW",
"windDir": 315,
"windSpeed": 4,
"windGust": 6,
"pressure": 1007.9,
"relHumidity": 80,
"visibility": 48992
},
{
"station": "Helsinki Kaisaniemi",
"distance": "24 km NE",
"time": "2020-03-16T14:30:00+02:00",
"temperature": 5,
"feelsLikeTemp": 2,
"symbol": "d400",
"windDirString": "NW",
"windDir": 336,
"windSpeed": 4,
"windGust": 6,
"pressure": 1007.8,
"relHumidity": 77,
"visibility": 50000
},
{
"station": "Helsinki Kumpula",
"distance": "27 km NE",
"time": "2020-03-16T14:30:00+02:00",
"temperature": 5,
"feelsLikeTemp": 2,
"symbol": "d400",
"windDirString": "NW",
"windDir": 300,
"windSpeed": 4,
"windGust": 6,
"pressure": 1007.8,
"relHumidity": 79,
"visibility": 50000
}
]
}Current
Current weather estimate.
location
"Longitude,latitude" or location identifier (id) from the location endpoint
alt (optional)
Altitude in meters
tempunit (optional)
Temperature unit
windunit (optional)
Wind unit: "MS" (m/s), "KTS" (knots), "KMH" (km/h), or "MPH" (mph) (default m/s)
tz (optional)
Time zone of returned dates
/api/v1/current/:location
{
"current": {
"time": "2020-06-02T04:17-06:00",
"symbol": "n200",
"symbolPhrase": "partly cloudy",
"temperature": 19,
"feelsLikeTemp": 19,
"relHumidity": 50,
"dewPoint": 8,
"windSpeed": 1,
"windDirString": "SW",
"windGust": 4,
"precipProb": 1,
"precipRate": 0,
"cloudiness": 61,
"thunderProb": 0,
"uvIndex": 0,
"pressure": 1011.46,
"visibility": 33516
}
}Nowcast
3-hour forecast in 15-minute time steps. The values represent the conditions at the associated time stamp unless otherwise specified.
location
"Longitude,latitude" or location identifier (id) from the location endpoint
periods (optional)
Number of time steps (default 8, maximum 12)
alt (optional)
Altitude in meters
tempunit (optional)
Temperature unit: "C", "F" (default "C")
windunit (optional)
Wind unit: "MS" (m/s), "KTS" (knots), "KMH" (km/h), or "MPH" (mph) (default m/s)
tz (optional)
Time zone of returned dates
dataset (optional)
Variable set: "standard" or "full" (default "standard")
/api/v1/forecast/15minutely/:location
{
"forecast": [
{
"time": "2020-03-16T16:00+02:00",
"symbol": "d240",
"temperature": 29,
"feelsLikeTemp": 33,
"windDir": 292,
"windGust": 8,
"windSpeed": 1,
"windDirString": "W",
"precipProb": 68,
"precipRate": 0.374569
},
{
"time": "2020-03-16T16:15+02:00",
"symbol": "d240",
"temperature": 28,
"feelsLikeTemp": 32,
"windDir": 290,
"windGust": 8,
"windSpeed": 2,
"windDirString": "W",
"precipProb": 74,
"precipRate": 0.374569
},
{
"time": "2020-03-16T16:30+02:00",
"symbol": "d240",
"temperature": 28,
"feelsLikeTemp": 31,
"windDir": 289,
"windGust": 9,
"windSpeed": 2,
"windDirString": "W",
"precipProb": 81,
"precipRate": 0.374569
}
]
}Hourly
Hourly forecasts. The values represent the conditions at the associated time stamp unless otherwise specified.
location
"Longitude,latitude" or location identifier (id) from the location endpoint
periods (optional)
Number of time steps (default 24, maximum 168)
alt (optional)
Altitude in meters
tempunit (optional)
Temperature unit: "C", "F" (default "C")
windunit (optional)
Wind unit: "MS" (m/s), "KTS" (knots), "KMH" (km/h), or "MPH" (mph) (default m/s)
tz (optional)
Time zone of returned dates
dataset (optional)
Variable set: "standard" or "full" (default "standard")
/api/v1/forecast/hourly/:location
{
"forecast": [
{
"time": "2020-03-16T14:00+01:00",
"symbol": "d410",
"temperature": 14,
"feelsLikeTemp": 14,
"windSpeed": 4,
"windGust": 12,
"windDir": 54,
"windDirString": "NE",
"precipProb": 76,
"precipAccum": 0.04
},
{
"time": "2020-03-16T15:00+01:00",
"symbol": "d410",
"temperature": 15,
"feelsLikeTemp": 15,
"windSpeed": 4,
"windGust": 12,
"windDir": 56,
"windDirString": "NE",
"precipProb": 69,
"precipAccum": 0.04
},
{
"time": "2020-03-16T16:00+01:00",
"symbol": "d410",
"temperature": 15,
"feelsLikeTemp": 15,
"windSpeed": 4,
"windGust": 13,
"windDir": 59,
"windDirString": "NE",
"precipProb": 62,
"precipAccum": 0.07
}
]
}Daily
Daily forecasts.
location
"Longitude,latitude" or location identifier (id) from the location endpoint
periods (optional)
Number of time steps (default 7, maximum 14)
alt (optional)
Altitude in meters
tempunit (optional)
Temperature unit: "C", "F" (default "C")
windunit (optional)
Wind unit: "MS" (m/s), "KTS" (knots), "KMH" (km/h), or "MPH" (mph) (default m/s)
tz (optional)
Time zone of returned dates
dataset (optional)
Variable set: "standard" or "full" (default "standard")
/api/v1/forecast/daily/:location
{
"forecast": [
{
"date": "2020-03-16",
"symbol": "d320",
"maxTemp": 16,
"minTemp": 12,
"precipAccum": 12.34,
"maxWindSpeed": 4,
"windDir": 51
},
{
"date": "2020-03-17",
"symbol": "d320",
"maxTemp": 17,
"minTemp": 13,
"precipAccum": 9.54,
"maxWindSpeed": 5,
"windDir": 40
},
{
"date": "2020-03-18",
"symbol": "d000",
"maxTemp": 19,
"minTemp": 11,
"precipAccum": 0.01,
"maxWindSpeed": 4,
"windDir": 71
}
]
}Map API
Weather Map API provides global weather forecast, radar and satellite data as map tiles compatible with commonly used map services such as Open Street Maps or Google Maps. All required and optional parameters are given as path and query parameters respectively. To obtain images one must first request an access token using valid credentials. The access token can then be used to fetch capabilities-response, which contains information on how to fetch images.
Capabilities
Capabilities endpoint is used to fetch layer metadata. This metadata is used to perform image queries. Capabilities-response provides layer information such as description, temporal and spatial extents as well as available color schemes. Images are layers renderable to image formats such as png or svg. The current data property in time element is the index to the most recent available time. Image products may have additional color schemes which can be optionally specified.
token
Access token as provided by authorization endpoint
/api/v1/capabilities
{
"images": [
{
"title": "Cell simulated precipitation",
"description": "Precipitation with more intricate convection visualization",
"formats": [
"image/png"
],
"colorschemes": [
"default",
"csdata-blue"
],
"extent": {
"minLat": -79.171,
"maxLat": 79.171,
"minLon": -180,
"maxLon": 180,
"maxZoom": 11,
"minZoom": 3
},
"times": {
"updated": "2017-01-01T00:00:00Z",
"available": [
"2017-09-01T03:00:00Z",
"2017-09-01T06:00:00Z"
],
"current": 1
},
"id": 1
},
{
"title": "Wind symbol",
"description": "Traditional wind symbol",
"formats": [
"image/svg+xml"
],
"colorschemes": [
"default",
"data-pt"
],
"extent": {
"minLat": -79.171,
"maxLat": 79.171,
"minLon": -180,
"maxLon": 180,
"maxZoom": 11,
"minZoom": 3
},
"times": {
"updated": "2017-01-01T00:00:00Z",
"available": [
"2017-09-18T06:00:00Z",
"2017-09-18T07:00:00Z"
],
"current": 0
},
"id": 2
}
]
}Tile
Tile endpoint is used to obtain weather map tiles for the given layer and color scheme
id
Layer id
x
X index of the requested tile
y
Y index of the requested tile
z
Zoom level of the requested tile
time
UTC timestamp value for the data to retrieve in ISO 8601 format. Must appear in the available times list
token
Access token as provided by authorization endpoint
colorscheme (optional)
Layer color scheme. Must appear in the color scheme list returned by capabilities endpoint
/api/v1/image/tile/:z/:x/:y/:time/:id
Legend
Legend endpoint is used to obtain legend image for a color scheme
colorscheme
Color scheme id. Must appear in the color scheme list returned by capabilities endpoint
id
Layer id
token
Access token as provided by authorization endpoint
/api/v1/legend/:colorscheme/:id
Usage API
Monitor your API usage.
Month's usage
Given month's hit sums by API
month
Month (e.g. "2020-03")
user
Username
password
Administrative password
/usage/month/:month
{
"apis": [
{
"name": "Weather API",
"hits": 3252
},
{
"name": "Map API",
"hits": 2
},
{
"name": "Administrative",
"hits": 136
}
],
"hits": 3390
}Day's usage
Given day's hit sums by API
day
Day (e.g. "2020-03-15")
user
Username
password
Administrative password
/usage/day/:day
{
"apis": [
{
"name": "Weather API",
"hits": 156
},
{
"name": "Map API",
"hits": 2
},
{
"name": "Administrative",
"hits": 0
}
],
"hits": 158
}