Raster Flow Tiles
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.
Run this endpoint
You can easily run this and other endpoints. Go to the TomTom API Explorer page and follow the directions.
Styles description
Style details
Name | Relation to speed | Speed intervals | Line outline colors | Line main colors | Dash colors |
---|---|---|---|---|---|
| absolute |
|
|
| No dashes |
| relative to free-flow |
|
|
| No dashes |
| relative to free-flow |
|
|
|
|
| relative to free-flow |
|
|
|
|
| relative to free-flow |
|
|
| No dashes |
| relative to free-flow |
|
|
| No dashes |
Style examples
Example of relative0
style
![Relative0 example](https://developer.tomtom.com/sites/default/files/dp-9024/raster-relative0-example.png)
Example of relative0-dark
style
![Example of relative0 dark-style](https://developer.tomtom.com/sites/default/files/dp-9024/raster-relative0-dark-example.png)
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
https://{baseURL}/traffic/map/{versionNumber}/tile/flow/{style}/{zoom}/{x}/{y}.{format}?key={Your_API_Key}&thickness={thickness}&tileSize={tileSize}
Example
https://api.tomtom.com/traffic/map/4/tile/flow/absolute/12/2044/1360.png?key={Your_API_Key}
curl command format
curl 'https://{baseURL}/traffic/map/{versionNumber}/tile/flow/{style}/{zoom}/{x}/{y}.{format}?key={Your_API_Key}&thickness={thickness}&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 parameters | Description |
---|---|
| Base URL for calling TomTom services.
|
| Version of the service to call. |
| The style to be used to render the tile. When the style is
Values:
|
| Zoom level of the tile to be rendered. |
| x coordinate of the tile on the zoom grid. |
| y coordinate of tile on zoom grid. |
| The format of the response. |
| API Key valid for requested service. |
Optional parameters | Description |
---|---|
| The segment width multiplier. This parameter can only be used with the following styles:
Value: |
| The tile size dimension in pixels.
Default value: |
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.
Optional headers | Description |
---|---|
Tracking-ID | Specifies an identifier for the request. It can be used to trace a call.
The value must match the regular expression
|
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.
Value:
Examples:
|
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
Field | Description |
---|---|
| Main object of the error response. |
| One of a server-defined set of error codes. |
| A human-readable description of the error code. |
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>
1{2 "detailedError": {3 "code": "INVALID_REQUEST",4 "message": "z out of range 0 <= z <= 22"5 }6}
Response codes
Code | Meaning & possible causes |
---|---|
| OK |
| Bad request
|
| Forbidden: The supplied API Key is not valid for this request. |
| Method Not Allowed: The provided HTTP request method is known by the server, but is not supported by the target resource. |
| Too Many Requests: Too many requests were sent in a given amount of time for the supplied API Key. |
| Internal Server Error. |
| Service currently unavailable. |
| 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.
Header | Description |
---|---|
Indicates that cross-origin resource sharing (CORS) is allowed. | |
Lists the set of supported HTTP methods. The header is sent in case a
| |
Contains directives for a caching mechanism. | |
Contains information about the size of the response body. | |
Indicates the media type of the resource returned.
| |
Contains the date and time when the message was originated. | |
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. |