Raster Incident Tiles

Service version: 4
Last edit: 2021.07.20

On this page

Purpose

The TomTom Traffic Tile service serves 256 x 256 pixel or 512 x 512 pixel tiles showing traffic incidents.

• All tiles use the same grid system.
• Because the traffic tiles use transparent images, they can be layered on top of map tiles to create a compound display.
• Traffic tiles render graphics to indicate traffic on the roads in the specified area.
• The Traffic incidents tiles use colors to indicate the magnitude of delay associated with the particular incident on a road segment.
  • The magnitude of delay is determined based on the severity of traffic congestion associated with the particular incident.

Run this endpoint

You can easily run this and other endpoints.

1. Go to the TomTom API Explorer page.
2. Click an endpoint.
   1. Click Try it out.
   2. Enter/select all required parameter values and any optional parameter values.
   3. At the bottom of the form, click Execute.
3. Review the response.

Styles description

Style examples

Example of s0 style

Example of s0-dark style

▲ Return to top

Request data

HTTPS method: GET

URL format

For ease of viewing and identification:

• Required constants and parameters are shown in bold text.
• Optional parameters are shown in plain text.

https://baseURL/traffic/map/versionNumber/tile/incidents/style/zoom/x/y.format?key=Your_API_Key&t=t

Example:

https://api.tomtom.com/traffic/map/4/tile/incidents/s3/12/2044/1360.png?key=Your_API_Key

curl command

curl -XGET 'https://api.tomtom.com/traffic/map/4/tile/incidents/s3/12/2044/1360.png?key=Your_API_Key'

Request parameters

The following table describes the parameters that can be used in a request.

• Required parameters must be used or the call will fail.
• Parameters and values are case-sensitive.
• Optional parameters may be used.

▲ Return to top

HTTP request headers

The following table lists HTTP response headers of particular interest to clients of the Traffic Incident Raster Tiles API endpoint.

▲ Return to top

Response data

Successful response

The Raster Incident Tiles API endpoint for a valid single request returns a response in PNG format. See: style examples for more.

Error response

The Raster Incident Tiles API endpoint for an invalid single request returns a response body in XML or JSON format.

• By default the Error response is returned in XML format.
• In order to obtain the Error response in JSON format, the Accept request header with a proper value must be used.
• The types of the fields refer to a JSON response.

Error response field structure

Error response XML example

<errorResponse errorCode="400" description="z out of range 0 <= z <= 22" version="traffic-rasterizer 2.0.009">
  <detailedError>
    <code>INVALID_REQUEST</code>
    <message>z out of range 0 <= z <= 22</message>
  </detailedError>
</errorResponse>

Error response JSON example

{
  "detailedError" : {
    "code" : "INVALID_REQUEST",
    "message" : "z out of range 0 <= z <= 22"
  }
}

▲ Return to top

HTTP response codes

▲ Return to top

HTTP response headers

The following table lists HTTP response headers of particular interest to clients of the Traffic Incident Raster Tiles API endpoint.

▲ Return to top