Map Tile API Developer's Guide

Flow Label Tile (flowlabeltile)

Description

Returns a transparent image with traffic flow and labels.

Format

Requests against this resource must follow the pattern summarized by the following formula:

https://{1-4}.traffic.maps.cit.api.here.com
/maptile/2.1/flowlabeltile/newest/{scheme}/{zoom}/{column}/{row}/{size}/{format}
?app_id={YOUR_APP_ID}
&app_code={YOUR_APP_CODE}
&{param}={value}

For information on how to construct the request, see Constructing a Request

Common URI Parameters

The following table lists the URI parameters that are common for all requests.

Table 1. Common URI Parameters
Parameter Type Description
col Integer (required)

col – can be any number between 0 and number of columns - 1, both inclusive.

The number of tiles per column is a function of the zoom:

number of columns = 2zoom
format String (required) Returned image format. The following image formats are supported:
  • png – PNG format, 24 bit, RGB
  • png8 – PNG format, 8 bit, indexed color
  • jpg – JPG format at 90% quality

Please note that JPG is recommended for satellite and hybrid schemes only.

map id String (required) Specifies the map version. It can be:
  • version id the map version of the requested map tile resource; request the latest version by using newest as map id.
  • hash A unique key, unambiguously representing a specific map version.

See Requesting the Right Map Version for more information on map versions.

row Integer (required)

row –  can be any number between 0 and number of rows - 1, both inclusive.

The number of tiles per row is a function of the zoom: number of rows = 2zoom .

scheme String (required) Specifies the view scheme. A complete list of the supported schemes may be obtained by using the Info. The following schemes are available:
  • normal.day – for a normal map view in daylight mode
  • normal.day.grey – for a color-reduced map view in daylight mode (especially used for background maps)
  • normal.day.transit – for a color-reduced map view with a public transport scheme in daylight mode
  • normal.night.transit – for a color-reduced map view with a public transport scheme in night mode
  • normal.traffic.day – for a color-reduced map view designed for displaying traffic in daylight mode
  • normal.traffic.night – for a color-reduced map view designed for displaying traffic in night mode
  • normal.day.custom – for a normal map view in daylight mode
  • normal.night – for a normal map view in night mode
  • normal.night.grey – for a color-reduced map view in night mode (especially used for background maps)
  • pedestrian.day – pedestrian map view in daylight mode
  • pedestrian.day.mobile – pedestrian map view in daylight mode for mobile usage
  • pedestrian.night – pedestrian map view in night mode
  • pedestrian.night.mobile – pedestrian map view in night mode for mobile usage
  • carnav.day.grey – for a normal map view in daylight mode for car navigation
  • normal.day.mobile – mobile version of the scheme
  • normal.day.grey.mobile – mobile version of the scheme
  • normal.day.transit.mobile – mobile version of the scheme
  • normal.night.transit.mobile – mobile version of the scheme
  • normal.night.mobile – mobile version of the scheme
  • normal.night.grey.mobile – mobile version of the scheme
  • reduced.day – for a reduced map view in daylight mode with few colors
  • reduced.night – for a reduced map view in night mode with few colors
  • terrain.day – for a terrain map view in daylight mode
  • satellite.day – for a satellite map view in daylight mode
  • hybrid.day – for a satellite map view with streets in daylight mode
  • hybrid.day.transit – for a satellite map view with public transport scheme in daylight mode
  • hybrid.grey.day – for a satellite map view with streets in daylight mode with few colors
  • hybrid.traffic.day – for a satellite map view with streets designed for traffic
  • terrain.day.mobile – mobile version of the scheme
  • hybrid.day.mobile – mobile version of the scheme

Note: Please be aware that invalid combinations of schemes and Tiles are rejected. For all satellite, hybrid and terrain schemes, the Aerial Tiles base URL must be used instead of the normal one. For the hybrid.traffic.day scheme, the Traffic Tiles base URL must be used instead of the normal one. The other traffic related schemes (normal.traffic.day, normal.traffic.night) are supported by Traffic Tiles and Map Tiles. Originally they are supposed to be used only with Traffic Tiles, but in order to properly support the traffic overlay case where you would request a transparent traffic tile from Traffic Tiles and a base tile from Map Tiles, the Map Tiles also support these schemes.

size Integer (required) Returned image size. The following sizes ([width, height]) are supported:
  • 256 = [256, 256]
  • 512 = [512, 512]
The following sizes ([width, height]) are deprecated, although usage is still accepted:
  • 128 = [128, 128]

Note: Raster coverage tiles (rctile, rconlytile and rcdistonlytile) only support 256 sizes.

zoom Integer (required) Zoom level of the map image. Minimum and maximum zoom levels are specified in the Info.

Mandatory Query Parameters

The following table lists the mandatory parameters that need to be specified with every request. Not specifying these parameters will make the system reject the request.

Table 2. Mandatory Query Parameters
Parameter Type Description
app_id String A URL-safe encoded string obtained during the application registration. See Acquiring Credentials for information on getting credentials.
app_code String A URL-safe encoded string obtained during the application registration. See Acquiring Credentials for information on getting credentials.

Note: Usage of token is accepted although is deprecated

Traffic Specific Query Parameters

The following table lists parameters for traffic options.

Table 3. Traffic Specific Query Parameters
Parameter Type Description
min_traffic_congestion String (optional) Specifies the minimum traffic congestion level to use for rendering traffic flow. It accepts the following values:
  • free (default) – renders all traffic lines, which includes free flow, heavy, queuing and blocked traffic lines.
  • heavy – renders all heavy traffic, queuing traffic and blocked roads.
  • queuing – renders the queuing traffic and blocked traffic lines.
  • blocked – renders only the black traffic lines for blocked roads.
time xs:dateTime or unix time (optional) The date and time for showing historical traffic patterns on the tile, in one of the following formats:
  • YYYY-MM-DDThh:mm:ss.szzzzzz – See xs:dateTime for format specification.
  • unix time – Number of seconds that have elapsed since 00:00:00 (UTC), Thursday, 1 January 1970.
A time before year 2009 is not supported.

Optional Query Parameters

Table 4. Optional Query parameters
Parameter Type Description
lg String

The MARC three-letter language code for requesting a map tile rendered in a specific language. If the given language is not available, the default language eng is used.

The following languages are supported:
  • ara – Arabic
  • baq – Basque
  • cat – Catalan
  • chi – Chinese (simplified)
  • cht – Chinese (traditional)
  • cze – Czech
  • dan – Danish
  • dut – Dutch
  • eng – English
  • fin – Finnish
  • fre – French
  • ger – German
  • gle – Gaelic
  • gre – Greek
  • heb – Hebrew
  • hin – Hindi
  • ind – Indonesian
  • ita – Italian
  • mul – Multiple Languages
  • nor – Norwegian
  • per – Persian
  • pol – Polish
  • por – Portuguese
  • rus – Russian
  • sin – Sinhalese
  • spa – Spanish
  • swe – Swedish
  • tha – Thai
  • tur – Turkish
  • ukr – Ukrainian
  • urd – Urdu
  • vie – Vietnamese
  • wel – Welsh
Note: When using mul code the following needs to be taken into account:
  • Each country will be shown in the default language of the country.
  • The following labels will be shown in the default language: continent, country, water bodies.
lg2 String

This parameter can be used to provide a second language for use in dual labeling, it follows the same behaviour as the parameter lg.

The following languages are supported:
  • ara – Arabic
  • baq – Basque
  • cat – Catalan
  • chi – Chinese (simplified)
  • cht – Chinese (traditional)
  • cze – Czech
  • dan – Danish
  • dut – Dutch
  • eng – English
  • fin – Finnish
  • fre – French
  • ger – German
  • gle – Gaelic
  • gre – Greek
  • heb – Hebrew
  • hin – Hindi
  • ind – Indonesian
  • ita – Italian
  • mul – Multiple Languages
  • nor – Norwegian
  • per – Persian
  • pol – Polish
  • por – Portuguese
  • rus – Russian
  • sin – Sinhalese
  • spa – Spanish
  • swe – Swedish
  • tha – Thai
  • tur – Turkish
  • ukr – Ukrainian
  • urd – Urdu
  • vie – Vietnamese
  • wel – Welsh
pois String This parameter works as a mask for the POIs Categories contained in the map. If present, pois are shown at a zoom level greater than or equal to 15, if not present, regular tiles are shown. Each symbol of the mask is written in hexadecimal. Every symbol groups four POI categories, the first available symbol groups categories 0-3 and the last one 386-389. The mask can be used as follows:
  • all enabled (default): pois
  • all disabled: pois=0
  • using disabled by default: pois=F (it only enables the categories present, all others are disabled)
  • using enabled by default: pois=!F (it only disables the categories present, all others are enabled)
  • all customized: pois=123.....F (all possible values are given in the mask)
Note: Hexadecimal uses the symbols 0-9 to represent values zero to nine, and A, B, C, D, E, F (or alternatively a-f) to represent values ten to fifteen.
Note: There are several ways in which this API can be used, please check POI Filtering Usage for details.
Note: There are currently 390 POI categories, but you should check the /meta/pois chapter for further information about how to get the most up to date list of categories.
Note: In metainfo tiles you must use this parameter if you want to see POI information.
ppi Integer Pixels per inch. Resolution that can be requested, valid values are:
  • 72 – normal, used by default if no value provided
  • 250 – mobile
  • 320 – hi-res
  • 500 – 500 ppi

Note: For mobile schemes only mobile ppi value can be used, for hi-res schemes only hi-res ppi value can be used. For carnav scheme and normal.day.custom only normal ppi is accepted.

range String Only relevant if output=base64 is also specified as a parameter range must be one of 2x2, 3x3 or 4x4, which indicates the size of the array of tiles returned. The tile specified by col and row is the top left of the array, and must divide by the array size.
style String If present, selects the style to use to render the tile. The possible values are:
  • default
  • alps
  • fleet
  • wings
  • dreamworks
  • flame
  • mini
Note: Only a subset of the schemes and tiles are available for the styles, which is checked at runtime. If the scheme or tile is not available for the given style , a 400 Error is generated.
Note: Each of these styles has been developed for specific customers and very concrete uses cases so if you are not one of those customers you should not use these map styles as the usage is monitored. The only exception is default, which always exists and is used for the default style. Adding this style to the url or not using any style parameter renders the same results.
Note: Fleet only supports normal.day, hybrid.day and terrain.day.
Note: Wings only supports normal.day, reduced.day, normal.night and normal.night.grey.
Note: Dreamworks only support normal.day.
Note: Flame only supports normal.day and hybrid.day.
Note: Alps and Mini only support normal.day, normal.day.grey, normal.day.transit, normal.day.custom, normal.night, normal.night.grey, terrain.day, satellite.day, hybrid.day, pedestrian.day, pedestrian.night, carnav.day.grey, and reduced.day.

Optional Metadata Specific Query Parameters

Table 5. Optional Metadata Query parameters
Parameter Type Description
metadata String Type of metadata to generate, valid values are:
  • metaonly: only metadata are returned; output=base64 is automatically enabled
  • metatile: both the requested image and the associated metadata are returned; output=base64 is automatically on
Note: Optionally, the parameter callback_func can be used as well.
output String Can only have the value base64, which indicates that the map tile is returned as base64 encoded text instead of as a standalone image.
Note: Please be aware that this feature is not available for traffic.
callback_func String A function name that is wrapped around the JSON output. This technique allows for a more secure way of parsing the output with JavaScript, for example:
&callback_func=test

returns:

test( [ ... ] ); 
Note: The value is url-decoded, but it is the responsibility of the requester to provide a value that is JavaScript correct.
filter String This parameter accepts two values:
  • 0 (no effect)
  • 1 (filter out only roadsigns)
Note: This parameter only filters out information in a metadata response.
Note: This parameter only works in combination with the parameter mgen.
mgen String Specifies the metadata generation to use. This parameter accepts the following values:
  • 1: default
  • 2: optimized out JSON format that filters empty values and allows the usage of parameter filter, the output of this version might change between releases as it is still under development
  • latest: always takes the latest version available
Note: For maptile, this parameter is only available for metadata requests and output JSON.
Note: For info requests, this parameter is only available when using output JSON.