Weather tile resource

This resource retrieves a weather map tiles for a given layer.

Method	URL format
`GET`	`https://{base_url}/weather/2.0/tile/{zoom}/{x}/{y}/{layer_id}`

You can find more details on the applicable query and path parameters in the sections below. The base_url will be provided during the process of obtaining credentials.

Authorization

Each request is authenticated and requires a valid bearer token to be included in HTTP Authorization header:

Authorization: Bearer <token>

For more information about obtaining credentials, see the Identity and Access Management Developer Guide.

Path parameters

The table below documents the path parameters.

Parameter	Required	Description
`x`	Yes	x coordinate for the tile, can be any number between 0 and 2^zoom - 1
`y`	Yes	y coordinate for the tile, can be any number between 0 and 2^zoom - 1
`zoom`	Yes	zoom level, value can be from 3 to 11 for layer id=1 and from 4 to 9 for layer id=2
`layer_id`	Yes	ID of the layer. `1` - the Doppler radar layer. Shows current or historical precipitation based on actual radar images. Coverage is limited to available radar stations. `2` - Global precipitation layer. Shows current, historical, or future precipitation. Based on a precipitation model that uses radar, satellite imagery, climate models, and possibly other inputs. Images are more accurate than radar alone, and they cover locations where no radar is available, in addition to forecasting the future.

XYZ tiling scheme

Weather tile API provides doppler radar data as map tiles compatible with commonly used map services such as Open Street Maps or Google Maps.

More details about XYZ tiling scheme can be found here:

Query parameters

The table below documents the query parameters.

Parameter	Required	Description
`ts`	No	The time in ISO 8601 format. It defaults to the current time. Specify a time in the past to get archived images, or in the future to retrieve precipitation forecasts (layer 2 only). Images in the past are available 24 hours back in 5, 10 or 15 minutes interval (depends on region, see Tile coverage). Global precipitation images (only) are available for the next 15 hours in 15-minute intervals. Example: ts=2019-09-11T12:00:00Z
`format`	No	The desired image output format. Currently the output format is `PNG`, but other formats might be supported in the future.

Response

On success, the response status is 200 OK and the response payload contains an image with the specified format (default is PNG) and with a resolution of 256 x 256 pixels. Custom header 'X-RADAR-IMAGE' in the response contains image timestamp:

X-RADAR-IMAGE=2019-09-12T05:00:00Z Response status is 200 and transparent image is returned if requested area is not covered. Custom header 'X-RADAR-IMAGE' in the response contains value 'NC'.

See Tile coverage Response status 400 Bad Request is returned if 'ts' query parameter does not conform format or is out of range (too old or too far in the future). Error message contains available timestamps range:

{
    "Type": "Invalid Request",
    "Message": [
        "Given timestamp is out of range. Radar images are available for timestamps from '2019-09-10T08:45:00Z' until '2019-09-14T09:00:00Z'."
    ]
}

On failure, the response has a different status code and may include additional information about the error. You can use this additional information to troubleshoot this issue. For more information see Response status codes Radar color scheme legend: