Description

Returns a tile that contains only labels.

Format

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

https://{1-4}.base.maps.ls.hereapi.com/maptile/2.1/labeltile/{map id}/{scheme}/{zoom}/{column}/{row}/{size}/{format}
?apiKey={YOUR_API_KEY}
&{param}={value}
Note: This example uses 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
ParameterTypeDescription
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, 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 = 2zoom .
scheme String (required) Specifies the view scheme. A complete list of the supported schemes may be obtained by using the resource-info.html 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 resource-info.html 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
ParameterTypeDescription
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 Map Tile API.

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://platform.here.com/portal/. 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.

Optional Metadata Specific Query Parameters

Table 3. Optional Metadata Query parameters
ParameterTypeDescription
Parameter
Type
Description
metadataString 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.
outputString 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_funcString 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.
filterString 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.
mgenString 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.

Optional Query Parameters

Table 4. Optional Query parameters
ParameterTypeDescription
Parameter
Type
Description
lgString

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.
lg2String

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
poisString 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.
ppiInteger 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.

pviewString Use this parameter to render the map with boundaries based on international or local country views. In general, the international view should be used unless the map is being used within one of those countries for which a local view is available. If the parameter is specified and the view is supported, boundaries of the selected country view are being shown. Not specifying the parameter results in a default view of boundaries, a view that's being kept for legacy purposes without maintenance.
Note: There are several ways in which this API can be used, please check Geopolitical Views for details.
Note: You should check the /meta/pviews chapter for further information about how to get the most up to date list of political views available from the service.
Note: The international view is always identified by the special code DEF.
Note: In metainfo tiles you must use this parameter if you want to see information that might be different depending on the geopolitical view.
rangeString 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.
styleStringIf 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 resource-info.html. 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.