Map Image API Developer's Guide

The Route Resource

This resource provides the functionality for the route and route marker representation (no calculation included) on a map image. Multiple routes can be shown on same map and the color and thickness of the drawn route line can be customized.

It supports also different map schemes, image sizes; image formats as well as zooming out from automatically calculated zoom level.

Routes can be drawn as polylines connecting waypoints specified in the request parameters (latitude and longitude pairs). The route waypoints are connected together with a line in the order they are given.

The zoom level for the displayed image is determined automatically using the route information and display size (width and height parameters). A given zoom level is only considered if it is smaller than the calculated one to provide a wider view of the map.

Note: The method POST is supported but limited to payloads of 8K maximum.

Resource URI

/route?[f=...]...

Resource Parameters

Parameter	Type	Description
app_id	String	Typically, but not guaranteed to be, 20 bytes 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 further details, see Acquiring Credentials.
app_code	String	Typically, but not guaranteed to be, 20 bytes 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 further details, see Acquiring Credentials.
apiKey	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.
ctr	Geo Coordinate	Map center point geo coordinate. If the position is on the border of the map, the dot might be cropped. Note: For Basic Map: If center point is not given in the request, the position parameter will be used as the center point, if no POIs (parameter `poi`) or custom text labels (parameter `tx0`,`tx1`,...) are requested. If the center point parameter is provided it is preferred over a given position parameter. In this situation, it is possible that the requested position (parameter `c`) is out of the map image. This parameter is ignored if parameter `ectr` is provided or POIs (parameter poi) or custom text labels (parameter `tx0,tx1,...`) are requested. Ignored if a geo search is also requested. Note: For Route: Using this overrides the automatically calculated route center point. Using this also enables free zoom level definition i.e. also zooming in (not only zooming out) is possible from automatically calculated zoom level.
ectr	Encoded Geo Coordinate	Encoded equivalent of map center point geo coordinate parameter `ctr`. Parameter `ctr` is ignored if this parameter is present.
f	Integer	Image format. It is possible to request the map image in following formats: 0 PNG 1 JPEG (default) 2 GIF 3 BMP 4 PNG8 5 SVG (only for companylogo) If this is not given, JPEG is used as default. Note: For PNG8 images some of the colors may differ compared to full color images so use it with precaution. Note: For SVG: parameters `w` and `h` are ignored. Note: For Roadsign: Only PNG format is available. Note: For Companylogo: Only PNG and SVG formats is available.
h	Integer	Result image height in pixels, maximum 2048. Height and width parameter can be provided independently, i.e. there is no need to enter both to resize the image.
lc,lc0,lc1,...	Color	Line color. When presenting only a single route or area/region, the index 0 of the parameter is not required i.e. plain `lc` can be used. If no line colors are defined, default blue line colors are used. Note: For Region: Outline color of area/region. It is used only if fill color `fc` for corresponding index is not given i.e. outline and fill color cannot be combined. If no outline color is defined for some area/region, default fill color will be used for it, if fill color for corresponding area/region index is not given. The parameter is ignored if no `a` parameter is given. Note: For Route: Route line color.Consecutive numbering is necessary in indexes and a gap in sequential numbering leads to ignoring of all the subsequent index parameters and those will get the color of the last available indexed line color parameter before the gap. Note: For Turning Point: This is the arrow line color. Use parameter `lc` without index for Turning Point since it does not support the indexing i.e. multiple line colors.
lw,lw0,lw1,...	Integer	Line width. When presenting only a single route or area/region, the index 0 of the parameter is not required i.e. plain `lw` can be used. If no line widths are defined, default value 4 for line widths is used. Note: Valid values are from 1 to 20. Note: For Region: Outline width of area/region. Outline width is used only if outline color lc for corresponding index is given, and fill color fc for corresponding index is not given. Note: For Route: Route line width. Consecutive numbering is necessary in indexes and a gap in sequential numbering leads to ignoring of all the subsequent index parameters and those will get the width of the last available indexed line width parameter before the gap. The final line width consists of this line width and the additional border (shadow) line width (one pixel on both sides of the line) but only if the border line color is not set fully transparent for the route line with similarly indexed parameter sc. Note: For Turning Point: Arrow line width.Use parameter lw without index for Turning Point since it does not support the indexing i.e. multiple line widths. The final line width consists of this line width and the additional border (shadow) line width (one pixel on both sides of the line) but only if the border line color is not set fully transparent for the arrow line with parameter sc. Note: For Routing: Since only one route is supported only one value will be used. Therefore `lw` or `lw0` might be used, but only one of them. The rest of the values provided will be ignored.
m,m0,m1,...	Geo Coordinate List	List of geocoordinates for route waypoint marker icon group. Marker point lists have to be distinguished by indexes when showing multiple route marker groups. Consecutive numbering is necessary in indexes and a gap in sequential numbering leads to ignoring of all the subsequent index parameters. For single route marker group the index 0 of the parameter is not required. Marker groups can be customized by setting common default fill color for all groups (parameter mfc), group specific fill color (parameter `mfcN` where N means group's index 0..n), common default text color for all groups (parameter `mtxc`), group specific text color (parameter `mtxcN` where N means group's index 0..n), common default text size for all groups (parameter `mtxs`) and group specific text size (parameter mtxsN where N means group's index 0..n). Common marker labeling type for all marker groups can be defined with parameter `mlbl`. If custom text for markers is needed, POIs should be used instead of route markers. Note: The marker points are meant to be along the considered route, preferably they should be a subset of the points given in the associated route parameter. This is not required for markers to be shown, but to see the markers they must be near enough the route area i.e. markers do not affect the automatic zoom level calculation or shown bounding box and can therefore go out of the image.
mfc,mfc0,mfc1,...	Color	Fill color for route markers. This can used to define common default fill color for all route markers (without index) or route marker group specific fill color (with index). If no fill colors are available, system default fill color will be used for all markers. Marker group index having no fill color defined will use the default.
ml	String	Map label language. Specifies the language to be used to display descriptions of details inside the map image. If the parameter is not provided, the default language depends on the highest prioritized locale of the client's Accept-Language HTTP header which is currently supported. If no map language based on HTTP header can be determined, the server configured default is used. If the map language is locked on the server config, this parameter (or alternatively the Accept-Language HTTP header) has no effect, i.e. the locked map language is used. The following MARC three-letter language codes are supported currently (the language codes are case insensitive): 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 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 The language code is case insensitive. If the parameter is not provided, the map language is selected based on Accept-Language header locale values as follows: en* English zh* Chinese de* German fr* French it* Italian es* Spanish ru* Russian ar* Arabic Note: The languages listed in this document might not be up to date as they are dependant on the specific configuration on the server.
mlbl	Integer	Route marker labeling type. 0 Numerical i.e. 1,2,3,... etc. 1 Alphabetical i.e. A,B,C,... etc. (default if not provided)
mthm	Integer	Route marker theme. 0 Bubble 1 Pin 2 HERE style pin If no theme is available, system default value 0 (Bubble) for the route marker theme will be used.
mtxc,mtxc0,mtxc1,...	Color	Text color for route markers. This can be used to define common default text color for all route markers (without index) or route marker group specific text color (with index). If no text colors are available, system default white text color will be used for all markers. Marker group index having no text color defined will also use white as default color.
mtxs,mtxs0,mtxs1,...	Integer	Text font size for route markers between 8-30. This can be used to define common default text font size for all route markers (without index) or route marker group specific text font size (with index). If no text sizes are available, system default text size 12 will be used for all markers. Marker group index having no text size defined will also use the default size 12.
nocrop	Flag	Flag to avoid having cropped labels on the map. If the parameter is present in the request, the labels that do not fit completely on the image requested will not be on the map, if the parameter is not present, the default behavior will apply, that is, showing the labels even if they are cropped.
nocp	Flag	Flag for hiding copyright information on the map. Note: When this parameter is used, parameter `scp` will be ignored.
noicon	Flag	Flag for hiding route icons (markers). Does not affect POIs.
poi	Geo Coordinate List	List of geo coordinates for Points of Interest. Points are shown on map with markers if flag `nomrk` is not used. The poi will always be cropped if it does not fit in the image. Markers can be customized as a group by setting common defaults for fill color (parameter `poifc`), text color (parameter `poitxc`) and text size (parameter `poitxs`). If customization per single POI marker is needed, the extended POI parameters `poixN` (where N means index 0..n) must be used and all POIs must be defined separately as single extended POIs. Note: For Basic map: When this parameter is used, parameters `ctr, pip` and `txN` (where N means index 0..n) will be ignored. Also parameter i is ignored if this parameter is used without nomrk flag. And this parameter itself is ignored if HTML container is requested (parameter hc) or extended POIs (parameter `poixN` where N means index 0..n) are requested. Note: For Route: POI markers are always shown, but only if they are near enough the route area i.e. POI markers do not affect the automatic zoom level calculation or shown bounding box and can therefore go out of the image. Note: This parameter can not be mixed with parameter `poix`.
poifc	Color	Default fill color for POI markers. This can used to define common default fill color for all POI markers. If no default fill color is available, system default ligth blue (0xBF0066AA) fill color will be used. Note: This parameter is parced as BGR (invert of RGB).
poilbl	Integer	POI marker labeling type. 0 Numerical i.e. 1,2,3,... etc. (default if not provided) 1 Alphabetical i.e. A,B,C,... etc.
poithm	Integer	POI marker theme. 0 Bubble 1 Pin 2 HERE style pin If no theme is available, system default theme 2 (HERE style pin) will be used.
poitxc	Color	Default text color for POI markers. This can used to define common default text color for all POI markers. If no default text color is available, system default white text color will be used.
poitxs	Integer	Default text font size for POI markers, valid range is between 8-30. This can used to define common default text font size for all POI markers. If no default text font size is available, system default text font size `10` will be used.
poix0,poix1,...	Fields	Single extended POI marker characteristics as fields. Fields that can be provided are (in following order): Geo coordinate (mandatory) Latitude and longitude in Geo Coordinate parameter type format. If no value is provided default will be used. Fill color (optional) POI marker fill color in Color parameter type format. If not provided, requested default POI marker fill color (defined via parameter `poifc`) is used. If default not requested, system default POI marker fill color is used. Text color (optional) POI marker text color in Color parameter type format. If not provided, requested default POI marker text color (defined via parameter `poitxc`) is used. If default not requested, system default POI marker text color is used. Text font size (optional) POI marker text font size as integer. Valid range is between 8 and 30. If not provided, requested default POI marker text size (defined via parameter `poitxs`) is used. If default not requested, system default POI marker text font size is used. Custom text (optional) Custom text for POI marker. The text must be first UTF-8 encoded and then URL-encoded. New line can be given as URL-encoded by using "%0D%0A" or "%0A". If the text contains the field separator characters, those must be escaped by using preceding backslash '\'. If not provided, extended POI marker will get automatic alphabetical or numerical text depending on the requested POI labeling type i.e. parameter `poilbl`. For multiple extended POIs consecutive numbering is necessary in indexes and a gap in sequential numbering leads to ignoring of all the subsequent index parameters. Points are shown on map with markers only if flag nomrk is not used. The overlapping markers are not merged into a single marker, which causes the markers to be drawn on top of each other in given order. Note: For Basic Map: When extended POI parameters are used, parameters ctr,ectr, pip, txN (where N means index 0..n) and poi will be ignored. Also parameter I is ignored if extended POI parameters are used without nomrk flag. And extended POI parameters themselves are ignored if HTML container is requested (parameter `hc`). Note: For Route: POI markers are always shown, but only if they are near enough the route area i.e. POI markers do not affect the automatic zoom level calculation or shown bounding box and can therefore go out of the image. Note: This parameter can not be mixed with parameter poi.
ppi	Integer	[Public] Resolution to be used. Only allows below mentioned four values: 72 (default) 250 (mobile) 320 (hi-res) 500 . Invalid values are ignored. Only works with t=0 normal.day t=2 terrain.day t=3 hybrid.day t=4 normal.day.transit t=5 normal.day.grey t=13 pedestrian.day t=14 pedestrian.night Note: When using this parameter the size of the logo will be adjusted to match the resolution. Note: Please note that mobile schemes can only be used with 250 ppi value, as mixing mobile and non mobile parameters is not allowed.
pview	String	Geopolitical View to be used. Use this parameter to render the map with boundaries based on international or local country views. Not specifying the parameter results in a default view of boundaries. If the parameter is specified and the view is supported, boundaries of the selected country view are being shown. The list includes but is not limited to: arg (Argentinian View) ind (Indian View) MAR (Morocco View) PAK (Pakistani View)
q	Integer	Image compression quality in percentage between 1-100, default is 85 if not specified. The parameter takes effect only if JPEG image format is used.
r,r0,r1,...	Geo Coordinate List	The route waypoints, given as list of geo coordinates. Note: For Route: Routes have to be distinguished by indexes in the parameter name when showing multiple routes on same map i.e. `r0, r1` etc. Consecutive numbering is necessary in indexes and a gap in sequential numbering leads to ignoring of all the subsequent index parameters. When presenting only a single route, the index 0 of the parameter is not required i.e. plain `r` can be used. Note: For Turning Point: Only fixed index 0 i.e. `r0` is currently supported.
sc,sc0,sc1,...	Color	Shadow/border color. Note: For Turning Point use parameter `sc` without index for the arrow border color. Note: For Route: The border colors have to be distinguished by indexes when showing multiple routes. The index number is used for linking the border color to similarly indexed route. Consecutive numbering is necessary in indexes and a gap in sequential numbering leads to ignoring of all the subsequent index parameters and those will get the color of the last available indexed border color parameter before the gap. When presenting only a single route, the index 0 of the parameter is not required i.e. plain `sc` can be used. Note: For Routing: Since only one route is supported only one value will be used. Therefore `sc` or `sc0` might be used, but only one of them. The rest of the values provided will be ignored.
scp	String	ID of service owner specific copyright. Shows service specific additional copyright information together with map data copyright. The value must be a valid ID/key of a pre-configured service specific copyright i.e. the parameter value itself is not shown on map. Note: This parameter is ignored if flag parameter `nocp` is requested. The service specific copyright is not shown if it does not properly fit to the image.
style	String	Map style type. All available styles are defined by Map view server of the Map Image API. The list includes but is not limited to: alps daisy dreamworks flame fleet mini
t	Integer	Map scheme type. All available schemes are defined by Map view server of the Map Image API API. Currently this API supports the following set of schemes: 0 (normal.day) Normal map view in day light mode. 1 (satellite.day) Satellite map view in day light mode. 2 (terrain.day) Terrain map view in day light mode. 3 (hybrid.day) Satellite map view with streets in day light mode. 4 (normal.day.transit) Normal grey map view with public transit in day light mode. 5 (normal.day.grey) Normal grey map view in day light mode (used for background maps). 6 (normal.day.mobile) Normal map view for small screen devices in day light mode. 7 (normal.night.mobile) Normal map view for small screen devices in night mode. 8 (terrain.day.mobile) Terrain map view for small screen devices in day light mode. 9 (hybrid.day.mobile) Satellite map view with streets for small screen devices in day light mode. 10 (normal.day.transit.mobile) Normal grey map view with public transit for small screen devices in day light mode. 11 (normal.day.grey.mobile) 12 (carnav.day.grey) Map view designed for navigation devices. 13 (pedestrian.day) Map view designed for pedestrians walking by day. 14 (pedestrian.night) Map view designed for pedestrians walking by night. Normal grey map view for small screen devices in day light mode (used for background maps). By default normal map view in day light mode (0) is used for non-mobile clients. For mobile clients the default is normal map view for small screen devices in day light mode (6).
w	Integer	Result image width in pixels, maximum 2048. Height and width parameter can be provided independently, i.e. there is no need to enter both to resize the image. Note: For Roadsign and Companylogo: minimum is 24, maximum is 256.
z	Float	Zoom level for the map. Available levels are defined by Map View server of the Map Image API API, value between 0-20. Dafault zoom level is 10. Note: When the request contains parameters having geo coordinate lists or multiple parameters having single geo coordinate pair as value, the zoom level is automatically calculated. In these cases the requested zoom level is applied only if it happens to be smaller than the automatically calculated one i.e. zooming out is desired. Note: For Route: When the request contains also center point (`ctr` or `ectr`), the requested zoom level is applied always. Note: For levels below 5, the width and height cannot be 1024 or higher. Note: For Tilt Maps: For zoom levels over 5, the ceiling of `h/cos(ta)` cannot be 2048 or higher. Zoom level is not automatically calculated.