Raster Incident Tiles
Service version: 4
Last edit: 2020.12.16
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.
- The
Run this endpoint
You can easily run this and other endpoints.
- Go to the TomTom API Explorer page.
- Click an endpoint.
- Click Try it out.
- Enter/select all required parameter values and any optional parameter values.
- At the bottom of the form, click Execute.
- Review the Response.
Styles description
Style details | |||||||
---|---|---|---|---|---|---|---|
Name | Magnitude values | Line glow colors | Line outline colors | Line main colors | Dash colors | POI stroke colors | POI main colors |
s0 |
|
No glow |
|
|
|
|
|
s0-dark |
|
No glow |
|
|
|
|
|
s1 |
|
No glow |
|
|
|
No POIs | No POIs |
s2 |
|
|
|
|
No dashes | No POIs | No POIs |
s3 |
|
|
|
|
No dashes | No POIs | No POIs |
night |
|
|
|
|
No dashes | No POIs | No POIs |
Style examples
Example of s0
style
Example of s0-dark
style
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.
- If an optional parameter is not specified, where applicable, the default value listed in the table below will be used.
Required parameters | |
---|---|
Parameter | Description |
baseURL string |
The base URL for calling TomTom services. Value: api.tomtom.com |
versionNumber string |
The version of the service to call. Value: The current value is 4 . |
style string |
The style to be used to render the tile.
|
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..2 zoom -1 |
y integer |
The y coordinate of the tile on the zoom grid.Value: 0..2 zoom -1 |
key string |
An API Key valid for the requested service. Value: Your valid API Key. |
format string |
The format of the Response. Value:
|
Optional parameters | |
Parameter | Description |
[t] string |
The Traffic Model ID is the reference value for the state of traffic at a particular time.
-1 |
[tileSize] integer |
The tile size dimension in pixels. Value:
256
|
HTTP Request headers
The following table lists HTTP Response headers of particular interest to clients of the Traffic Incident Raster Tiles API endpoint.
Required headers | |
---|---|
Note: There are no required headers in this endpoint. | |
Optional headers | |
Parameter | Description |
Tracking-ID |
Specifies an identifier for the Request.
|
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:
type/subtype is one of:
|
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
Field | Description |
---|---|
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 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"
}
}
HTTP response codes
Code | Meaning and possible causes |
---|---|
200 |
OK |
400 |
Bad request, usually due to a malformed syntax.
|
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 |
HTTP Response headers
The following table lists HTTP Response headers of particular interest to clients of the Traffic Incident Raster Tiles API endpoint.
Header | Description |
---|---|
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. Value:
200 OK the Response content should be interpreted according to the type of the mimeType Request parameter.
|
Date |
Contains the date and time at which the message was originated. Value: <http-date> |
Tracking-ID |
An identifier for the Request.
<string> |