Traffic API Developer's Guide

Tiles

This resource processes requests for map tiles reflecting traffic information for a particular geographic area. The response delivers the map tile as bitmap.

Deprecation Notice

HERE has changed the way traffic tiles are served. Live traffic tiles have been deprecated in the Traffic API and are now delivered by the Map Tile API infrastructure. Documentation on live traffic tiles is part of the Map Tile API documentation.

This does not affect traffic pattern tiles, which continue to be served by the Traffic API.

Parameter Combinations for Common Use Cases

Table 1. Request a Traffic Pattern Tile
Required Optional
  • quadkey (used only in a quadkey address)
  • pattern_time
  • noContent
  • profile
  • tables
  • res (quadkey address only)
  • depth (quadkey address only)
Table 2. Set the Color Depth of a Traffic Tile
Required Optional
  • endpoint change (used only in a [Z]/[X]/[Y] address):
    .../{zoom}/{column}/{row}/{size}/{format}?
  • quadkey (used only in a quadkey address)
  • depth (used only in a quadkey address)
  • noContent
  • profile
  • tables
  • pattern_time
  • res (quadkey address only)
Table 3. Set the Size of a Traffic Tile
Required Optional
  • endpoint change (used only in a [Z]/[X]/[Y] address):
    .../{zoom}/{column}/{row}/{size}/{format}?
  • quadkey (used only in a quadkey address)
  • res (used only in a quadkey address)
  • depth (quadkey address only)
  • noContent
  • profile
  • pattern_time
  • tables
Table 4. Filter Tile Display by TMC Table
Required Optional
  • quadkey (used only in a quadkey address)
  • tables
  • depth (quadkey address only)
  • noContent
  • profile
  • pattern_time
  • res (quadkey address only)

Resource Parameters

Table 5. Tile Request Parameters
Parameter Description
app_id

xs:string

A 20-byte Base64 URL-safe encoded string used for the authentication of the client application.

You must include an app_id and app_code with every request.  For further details, please see Acquiring Credentials.

app_code

xs:string

A 20-byte Base64 URL-safe encoded string used for the authentication of the client application.

You must include an app_id and app_code with every request. For further details, please see Acquiring Credentials.

depth

xs:string

An indicator of tile color depth. The permitted values are:

  • 8bit
  • 32bit

Used only with quadkey tile addressing.

nc

xs:int

A flag indicating whether the response is to return HTTP error code 204 (empty) for unpopulated traffic tiles (1).

The permitted values are:

  • 1
  • 0
pattern_time

xs:int

An indicator of the time (within the week) for which to obtain a traffic pattern tile. The value represents local time for the targeted area, in seconds beginning on Sunday at 0:00. The permitted values are numeric and must fall in the range from 0 to 604800.

profile

xs:string

Profile defines such attributes as geographic coverage (TMC tables available for use) and custom color mapping for tile overlays.

quadkey

QuadkeyType

An identifier of a map tile in a grid of tiles spanning the entire globe. A quadkey is a single number string from 0 to 21 digits long. The map zoom level for the grid to which a quadkey refers is equal to the number of digits in the quadkey string. Use only with a quadkey addressing scheme endpoint. See also Quadkeys.

res

xs:string

An indicator of the map tile resolution to be used only with a quadkey tile address. It specifies the dimensions of a rendered square map tile in pixels. The permitted values are:

  • bitmap128
  • bitmap256
  • bitmap512
tables

TMCCodeType

A parameter that specifies TMC tables in the profile to include or exclude from response. If the value specifies multiple tables, the table ids are separated by commas. Positive values are included, and negative values are excluded.
Note: A combination of positive and negative values is not supported and results in an error response.
By default (when the parameter is not used in a request) the response includes all tables in the profile. See TMCCodeType for a full list of TMC tables or your customer profile for a list of tables available to you.

Tile Response Parameters

If a traffic tile request is successful, then it returns a PNG overlay image, as well as the following items containing additional information about the image:

Table 6. Traffic Response
Attribute Required Description Example
Status Code Yes Server response status code. 200 OK
Cache-Control Yes The max-age value defines how long (in seconds) that a tile can be stored in the client cache. public, max-age=39
Expires Yes When this tile expires. Client caches should rerequest tiles after their expiry time. Tue, 27 Jul 14:59:00 GMT
Content-Type Yes The content type of the response. This can be a PNG image or plain text, depending on the request. image/png
Content-Length Yes The size of the response. 7989
Date Yes The date and time when the tile was created. Tue, 27 Jul 14:56:18 GMT
X-LastUpdateFromTrafficAdapter Yes When this tile information was last updated. 29 Oct 2015 14:49:32 UTC
X-NLP-IRT No The internal response time of the request in microseconds. 126273
X-NLP-TID Yes The hashed unique identifier of the request. 5121b4a3-faa6-4f15-bc25-9e8856a099c6
X-Served-By No Identifier of an instance/server which served the request. i-4864c4f0.eu-west-1b

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.