Developer

Raster Flow Tiles

Service version: 1
Last edit: 2024.11.25
TomTom Orbis Maps

Important notes:

Purpose

The TomTom Traffic Raster Flow Tile service serves 256 x 256 pixel or 512 x 512 pixel tiles showing traffic flow. 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. The Raster Flow tiles use colors to indicate either the speed of traffic on different road segments, or the difference between that speed and the free-flow speed on the road segment in question.

Styles description

Style details

NameRelation to speedSpeed intervalsLine outline colorsLine main colorsDash colors
lightrelative to free-flow
  • road closed
  • 0 ≤ speed < 0.15
  • 0.15 ≤ speed < 0.35
  • 0.35 ≤ speed < 0.75
  • 0.75 ≤ speed

  • #B30000

  • #570000

  • #BC0A01

  • #FF6F00

  • #319B51

  • #EFF4F6

  • #AD0000

  • #FB2D09

  • #FFC105

  • #2AE57B

  • #FFFFFF

  • #AD0000

  • #FB2D09

  • #FFC105

  • No dashes

dark

relative to free-flow
  • road closed
  • 0 ≤ speed < 0.15
  • 0.15 ≤ speed < 0.35
  • 0.35 ≤ speed < 0.75
  • 0.75 ≤ speed

  • #B30000

  • #3D0014

  • #7E0801

  • #8A3C00

  • #194D31

  • #C6D0D2

  • #74062B

  • #CE2203

  • #DB9200

  • #149F67

  • #C6D0D2

  • #74062B

  • #CE2203

  • #DB9200

  • No dashes

Style examples

Example of light style

Example of light style

Example of dark style

Example of dark style

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
https://{baseURL}/maps/orbis/traffic/tile/flow/{zoom}/{x}/{y}.{format}?apiVersion=1&key={Your_API_Key}&style={style}&tileSize={tileSize}

Example

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

curl command format

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

Request parameters

The following table describes all of 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

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

x
integer

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

y
integer

y coordinate of tile on zoom grid.
Value: 0..2zoom -1

format
string

The format of the response.
Value: png

apiKey
string

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

Optional parametersDescription

style
string

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

  • light

  • dark

tileSize
integer

The tile size dimension in pixels.
Values:

  • 256

  • 512

Default value: 256

apiVersion
integer

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

Note that the flow layer can create a patchwork tile effect if the flow traffic data changes between calls of adjacent tiles.

Request headers

The following table lists HTTP request headers of particular interest to clients of the Raster Flow 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 Flow Tiles API endpoint for a valid single request returns a response in PNG format. See: Style examples for more.

Error response

The Raster Flow 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 an 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 <= z <= 22"
5  }
6}

Response codes

CodeMeaning & possible causes
200

OK

400

Bad request

  • Unknown style: The requested style is not available.

  • 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,2 zoom -1] : The requested x coordinate is out of the possible range.

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

  • Unknown format: The requested format 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 Raster Flow 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.
Values: GET, HEAD

Cache-Control

Contains directives for a caching mechanism.
Values: 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 - in case of the 200 OK

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

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: A <string>