Map Tile (maptile)
Description
Returns a map tile image.
Format
Requests against this resource must follow the pattern summarized by the following formula:
https://{1-4}.aerial.maps.ls.hereapi.com
/maptile/2.1/maptile/{map id}/{scheme}/{zoom}/{column}/{row}/{size}/{format}
?apiKey={YOUR_API_KEY}
&{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.
Parameter | Type | Description |
---|---|---|
col | Integer (required) | 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:
Please note that JPG is recommended for |
map id | String (required) | Specifies the map version, either newest or with a hash value. See also Map Versions. |
row | Integer (required) | The number of tiles per row is a function of the |
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 For the Traffic Tiles and Map Tiles support the other traffic related schemes ( |
size | Integer (required) | Returned image size. The following sizes ([width, height]) are supported:
Note: Raster coverage tiles ( |
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.
Parameter | Type | Description |
---|---|---|
app_id (deprecated) | | 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_code (deprecated) | | 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 |
apiKey | | 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 |
Optional Metadata Specific Query Parameters
Parameter | Type | Description |
---|---|---|
metadata | String | Type of metadata to generate, valid values are:
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: returns: 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:
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:
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
Parameter | Type | Description |
---|---|---|
congestion | Boolean | Flag that enables congestion and environmental zone display, if available for the requested tile. Available for the following tiles
|
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 The following languages are supported:
Note: When using mul code the following needs to be taken into account:
|
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 The following languages are supported:
|
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:
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:
Note: For |
pview | String | 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. |
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:
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 . |