HERE Map Tile v2 Developer's Guide

Flow Tile (flowtile)

Description

Returns a transparent image with only traffic flow.

Format

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

https://{1-4}.traffic.maps.ls.hereapi.com/maptile/2.1/flowtile/newest/{scheme}/{zoom}/{column}/{row}/{size}/{format}
?apiKey={YOUR_API_KEY}
&{param}={value}

Note: These example use a HERE API Key to authenticate your request. For the available authentication options, see the Identity & Access Management Developer Guide.

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 = 2^zoom`
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, either `newest` or with a `hash` value. See also 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 = 2^zoom` .
scheme	String (required)	Specifies the view scheme. A complete list of the supported schemes may be obtained by using the Info resource. Note: Be aware that invalid combinations of schemes and tiles are rejected. For all `satellite`, `hybrid` and `terrain` schemes, you need to use the Aerial Tiles base URL instead of the normal one. For the `hybrid.traffic.day` scheme, you need to use the Traffic Tiles base URL instead of the normal one. Traffic Tiles and Map Tiles support the other traffic related schemes (`normal.traffic.day`, `normal.traffic.night`). 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, in addition to Traffic Tiles supporting them.
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 resource.

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 (deprecated)`	`xs:string`	A 20-byte Base64 URL-safe encoded string used in one of the available authentication options for the HERE Map Tile v2. If you use the app ID/app code option, you need to include an `app_id` and `app_code` with every request. For more information on authentication, see the Identity & Access Management Developer Guide.
`app_code (deprecated)`	`xs:string`	A 20-byte Base64 URL-safe encoded string used for the authentication of the client application. If you use the app ID/app code option, you need to include an `app_id` and `app_code` with every request. For more information on authentication, see the Identity & Access Management Developer Guide.
`apiKey`	`xs:string`	A 43-byte Base64 URL-safe encoded string used for the authentication of the client application. As a logged in user, you can generate it at https://developer.here.com/projects. API Keys never expire but you can invalidate your API Keys at any time. You cannot have more than two API Keys for one app at the same time. You must include an `apiKey` with every request. For more information on authentication, see the Identity & Access Management Developer Guide.

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
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`, `satellite.day` 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 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: For specific customers and uses cases other styles have been created. A full list of styles and schemes available can be retrieved at Info. The `default` style always exists. 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.night`, `carnav.day.grey`, and `reduced.day`.