Traffic API Developer's Guide

Request Format

Each request must conform to the format appropriate to the resource (service function) and the addressing scheme (geospatial filter) the request uses to define the area for which to retrieve traffic information.

The supported addressing schemes are:

  • Tile addressing schemes:
    • [Z]/[X]/[Y] – specifies the map zoom level and the coordinates of the map tile in the tile grid corresponding to that zoom level, see The Mercator Projection for details
    • quadkey – an alternative to the [Z]/[X]/[Y] addressing scheme that uses a single value to identify the map tile, see also Quadkeys
  • Area filters:
    • bounding box – defines the area for which to retrieve information as a bounding box (using the parameter bbox, whose value is specified as the latitude and longitude of the top left and bottom right corners of the area, for example, bbox=52.516,13.355;52.511,13.400)
    • proximity – defines the area for which to retrieve information as a circle (using the parameter prox, whose value is the latitude and longitude of the search center, followed by the radius of the search area in meters)
    • corridor – defines the area for which to retrieve information along a specified path (using the parameter corridor, with path and width. The path is a line along the center of the corridor represented by a series of latitude/longitude pairs. Corridor width is given in meters.)

Please see also Table 1 for information about addressing schemes and available resources.

Once you have determined the resource and the addressing scheme, select the appropriate request format pattern, following the guidelines below (listed according to the API resource, whose name is shown in brackets).

Traffic Flow Data (flow)

Traffic flow data can be retrieved using one of the following request patterns, which reflect the addressing scheme:

Table 1. Traffic flow data request patterns
Addressing scheme URL pattern
[Z]/[X]/[Y] {base-url}/{path}/{resource}/{format}/{zoom}/{column}/{row}?
Quadkey {base-url}/{path}/{resource}.{format}?quadkey={quadkey}
Bounding box {base-url}/{path}/{resource}.{format}?bbox={bounding box coordinates}
Proximity {base-url}/{path}/{resource}.{format}?prox={proximity coordinates}
Corridor {base-url}/{path}/{resource}.{format}?corridor={corridor coordinates}

Note {path} in the request patterns above must be /traffic/6.2/ .

Traffic Tile (tiles)

Traffic tiles can be retrieved using one of the following request patterns, which reflect the addressing scheme:

Table 2. Traffic tile request patterns
Addressing scheme URL pattern
[Z]/[X]/[Y] {tile-base-url}/{path}/{resource}/{format}/{resource}/{zoom}/{column}/{row}/{size}?
Quadkey {tile-base-url}/{path}/{resource}/quadkeytraffic?quadkey={quadkey}
Note that when using the [Z]/[X]/[Y] tile addressing scheme, you can specify tile size and color depth as follows:
  • {size}: tile size, can be one the following values 512, 256, or 128.
  • {format}: color-depth, can be one of the following png, png8, or png32.
See also Selecting Tile Size and Selecting Tile Color Depth.

Traffic Incidents (incidents)

Traffic incident reports can be retrieved using one of the following request patterns, which reflect the addressing scheme (this applies for both incident endpoints "traffic/6.0/incidents" and "traffic/6.1/incidents"):

Table 3. Traffic incident request patterns
Addressing scheme URL pattern
[Z]/[X]/[Y] {base-url}/{path}/{resource}/{format}/{zoom}/{column}/{row}?
Quadkey {base-url}/{path}/{resource}.{format}?quadkey={quadkey}
Bounding box {base-url}/{path}/{resource}.{format}?bbox={bounding box coordinates}
Proximity {base-url}/{path}/{resource}.{format}?prox={proximity coordinates}
Corridor coordinates {base-url}/{path}/{resource}.{format}?corridor={corridor coordinates}

Traffic Flow Availability (flowavailability)

Traffic flow availability information can be retrieved for your profile with an address following the pattern shown below:

Table 4. Traffic flow availability request pattern
Addressing scheme URL pattern
Profile {base-url}/{path}/{resource}.{format}?profile={profile name}

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.