Developer

Raster Incident Tiles

Service version: 1
Last edit: 2024.10.31
TomTom Orbis Maps

Important notes:

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.

Styles description

Style details

NameMagnitude valuesLine outline colorsLine main colorsDash colors
light

  • 0: Unknown

  • 1: Minor

  • 2: Moderate

  • 3: Major

  • 4: Undefined (road closures, indefinite delays etc.)

  • #7F8D9F

  • #FF6F00

  • #BC0A01

  • #570000

  • #AD0000

  • #E0E8EB

  • #FFC105

  • #FB2D09

  • #AD0000

  • #E0E8EB

  • #E0E8EB

  • #FFC105

  • #FB2D09

  • #AD0000

  • #E0E8EB

NameMagnitude valuesLine outline colorsLine main colorsDash colors
`dark

  • 0: Unknown

  • 1: Minor

  • 2: Moderate

  • 3: Major

  • 4: Undefined (road closures, indefinite delays etc.)

  • #2F343C

  • #8A3C00

  • #7E0801

  • #3D0014

  • #830101

  • #A9B0B2

  • #DB9200

  • #CE2203

  • #74062B

  • #C6D0D2

  • #C6D0D2

  • #DB9200

  • #CE2203

  • #74062B

  • #C6D0D2

Style examples

Example of light style

light example

Example of dark style

dark example

Request data

HTTPS method: GET

  • Constants and parameters enclosed in curly brackets { } must be replaced with their values.
  • Please see the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.

URL format

get
Request URL format
https://{baseURL}/maps/orbis/traffic/tile/incidents/{zoom}/{x}/{y}.{format}?apiVersion=1&key={Your_API_Key}&style={style}&t={t}

Example

get
Request URL example
https://api.tomtom.com/maps/orbis/traffic/tile/incidents/12/2044/1360.png?apiVersion=1&key={Your_API_Key}&style=light

curl command format

get
Request curl command
curl 'https://{baseURL}/maps/orbis/traffic/tile/incidents/{zoom}/{x}/{y}.{format}?apiVersion=1&key={Your_API_Key}&style={style}&t={t}'

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.
Required parametersDescription

baseURL
string

The base URL for calling TomTom services. Value: api.tomtom.com

zoom
integer

The zoom level of the tile to be rendered.
Value: 0..22

x
integer

The x coordinate of the tile on the zoom grid.
Value: 0..2zoom -1

y
integer

The y coordinate of the tile on the zoom grid.
Value: 0..2<sup>zoom</sup> -1

key
string

An API Key valid for the requested service.
Value: Your valid API Key.

format
string

The format of the response.
Value: png

Optional parametersDescription

style
string

The style to be used to render the tile.
Values:

  • light

  • dark

t
string

The Traffic Model ID is the reference value for the state of traffic at a particular time. Use -1 to get the most recent traffic information.
Default value: -1

tileSize
integer

The tile size dimension in pixels.
Values: 256, and 512
Default value: 256

apiVersion
integer

Contains a version of the API to call. Value: The current version is 1.

Request headers

The following table lists HTTP response headers of particular interest to clients of the Traffic Incident Raster Tiles API endpoint. Note: There are no required headers in this endpoint.

Required headersDescription
TomTom-Api-Version

Contains a version of the API to call.
Value: An integer; the current version is 1.

Optional headersDescription
Tracking-ID

Specifies an identifier for the request.

  • It can be used to trace a call.
  • The value must match the regular expression
    '^[a-zA-Z0-9-]{1,100}$'.
  • An example of the format that matches this regular expression is a UUID (e.g., 9ac68072-c7a4-11e8-a8d5-f2801f1b9fd1).
  • For details check RFC 4122.
  • If specified, it is replicated in the Tracking-ID response header.
  • It is only meant to be used for support and does not involve tracking of you or your users in any form.

Value: <string>

Accept

Advertises which content types, expressed as MIME types, the client is able to understand. In this service, the header is used to specify a preferred Bad Request response format.
Format:

  • Accept: type/subtype

  • Accept: type/subtype, type/subtype - for multiple types

Value
type/subtype is one of:

  • image/png - in case of the 200 OK

  • application/json - in case of the
    400 Bad Request

  • text/xml - in case of the 400 Bad Request

Examples:

  • Accept: application/json

  • Accept: image/png, application/json

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

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

FieldDescription

detailedError
object

Main object of the error response.

code
string

One of a server-defined set of error codes.

message
string

A human-readable description of the error code.
Error response example - XML
1<errorResponse errorCode="400" description="z out of range 0 <= z <= 22" version="traffic-rasterizer 2.0.009">
2  <detailedError>
3    <code>INVALID_REQUEST</code>
4    <message>z out of range 0 <= z <= 22</message>
5  </detailedError>
6</errorResponse>
Error response example - JSON
1{
2  "detailedError": {
3    "code": "INVALID_REQUEST",
4    "message": "z out of range 0 &lt;= z &lt;= 22"
5  }
6}

Response codes

CodeMeaning & possible causes
200

OK

400

Bad request, usually due to a malformed syntax.

  • Zoom n is out of range [0,22]: The requested zoom level is out of the possible range.

  • x n is out of range [0,2zoom -1]: The requested x coordinate is out of the possible range.

  • y n is out of range [0,2zoom -1]: The requested y coordinate is out of the possible range.

  • Unknown Content Type: nnn:
    The requested content type is not supported.

403

Forbidden: The supplied API Key is not valid for this request.

405

Method Not Allowed: The provided HTTP request method is known by the server, but is not supported by the target resource.

429

Too Many Requests: Too many requests were sent in a given amount of time for the supplied API Key.

500

Internal Server Error

503

Service currently unavailable

596

Service Not Found: Unknown version of the service

Response headers

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

HeaderDescription
Access-Control-Allow-Origin

Indicates that cross-origin resource sharing (CORS) is allowed.
Value: *

Allow

Lists the set of supported HTTP methods. The header is sent in case a 405 HTTP response code is returned.
Value: GET, HEAD

Cache-Control

Contains directives for a caching mechanism.
Value: private, no-cache,
no-store, max-age=0,
must-revalidate

Content-Length

Contains information about the size of the response body.
Value: <decimal number>

Content-Type

Indicates the media type of the resource returned.
Values:

  • image/png

  • application/json; charset=utf-8 - in case of the 400 Bad Request

  • text/xml; charset=utf-8 - in case of the 400 Bad Request

In case of the 200 OK the response content should be interpreted according to the type of the format request parameter.

Date

Contains the date and time when the message was originated.
Value: <http-date>

Tracking-ID

An identifier for the request. If the Tracking-ID header was specified in the request, it is replicated in the response. Otherwise, it is generated automatically by the service. For details check RFC 4122. It is only meant to be used for support and does not involve tracking of you or your users in any form.
Value: <string>

TrafficModelID

Contains the reference value for the state of traffic at a particular time. If the request contains a valid Traffic Model ID and is not equal to -1, its value is replicated here. If the request does not contain a Traffic Model ID or it is equal to -1, the most recent one is returned.
Value: <numeric>