Weather 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.

Access token can be provided to API calls either as a query parameter or as an authorization header.

postAuthorization

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.

Parameters

Required

Name	Example	Description
user		Application key username
password		Application key password

Example

Url

authorize/token

Response

{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9mbnc2LmZvcmVjYS5jb21cL2F1dGhvcml6ZVwvdG9rZW4iLCJpYXQiOjE1MjYzMDAzODAsImV4cCI6MTUyNjMwMzk4MCwibmJmIjoxNTI2MzAwMzgwLCJqdGkiOiJxSXl3WVlQNjc1NkczejBEIiwic3ViIjoibFFHa1Y4Z2pIeGUyZU1ibndUUUs4NktqVTY3RXJlS2htenY1IiwicHJ2IjoiYWY3YTAzOThkZGNiNWE3YTUzN2Q3YzdkMjU2NWEyZjgxZGM4ZTQxNCJ9.V8xg6L9yrY9__VH-jdrL_CqXisEpgcfdUa0NoxlGz0k",
  "expires_in": 86400,
  "token_type": "bearer"
}

getCapabilities

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.

Parameters

Required

Name	Example	Description
token		Access token as provided by authorization endpoint.

Example

Url

api/v1/capabilities

Response

{
  "images": [
    {
      "title": "Cell simulated precipitation",
      "description": "Precipitation with more intricate convection visualization",
      "formats": [
        "image/png"
      ],
      "colorschemes": [
        "default",
        "csdata-blue"
      ],
      "extent": {
        "minLat": -79.1709976196289,
        "maxLat": 79.1709976196289,
        "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.1709976196289,
        "maxLat": 79.1709976196289,
        "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
    }
  ]
}

getTile

Tile endpoint is used to obtain weather map tiles for the given layer and color scheme.

Parameters

Required

Name	Example	Description
id		Layer id.
x	74	X index of the requested tile.
y	34	Y index of the requested tile.
z	7	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.

Optional

Name	Example	Description
colorscheme	default	Layer color scheme. Must appear in the color scheme list returned by capabilities endpoint.

Example

h5 class="editor-h5">Url

api/v1/image/tile/{z}/{x}/{y}/{time}/{id}

Response

getLegend

Legend endpoint is used to obtain legend image for a color scheme.

Parameters

Required

Name	Example	Description
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.

Example

Url

api/v1/legend/{colorscheme}/{id}

Response

getUsage

Usage endpoint is used to fetch request statistics. The endpoint can be used to monitor API usage.

Response contains elements representing total hits for each product, combined into daily totals.

Parameters

Required

Name	Example	Description
token		Access token as provided by authorization endpoint.

Optional

Name	Example	Description
startdate		Start date for statistics fetch in ISO format.
enddate		End date for statistics fetch in ISO format.

Example

Url

api/v1/usage

Response

[
  {
    "product": "Info request",
    "date": "2019-01-08",
    "hits": 3
  },
  {
    "product": "Layer 2",
    "date": "2019-01-08",
    "hits": 37
  },
  {
    "product": "Layer 4",
    "date": "2019-01-08",
    "hits": 85
  },
  {
    "product": "Legend 'default' for layer 2",
    "date": "2019-01-08",
    "hits": 1
  },
  {
    "product": "Legend 'default' for layer 4",
    "date": "2019-01-08",
    "hits": 1
  },
  {
    "product": "Statistics request",
    "date": "2019-01-08",
    "hits": 2
  }
]

Weather Map API

Weather Map API provides weather forecasts and observations as map overlays worldwide. Precipitation radar images, atmospheric weather forecasts and satellite images are typically shown as map overlays. Vaisala provides map overlay images through its Weather Map API. Overlays are primarily provided as tiles that are compatible with the most common map services such as HERE, Google Maps and OpenStreetMap. Background maps are also available.

Weather Map API