Map Image API Developer's Guide

The Turnpoint Resource

The Turnpoint resource returns turning points represented by an arrow drawn on top of the map image. The orientation of the turning point starting position by default is northwards. The zoom level for the map image is determined automatically based on the waypoints and display size (width and height parameters).

The service always turns the map even without parameter ra, therefore a compass is always displayed.

It also supports different map schemes, image sizes, image formats as well as showing a compass and customizing the color and thickness of the drawn arrow.

Resource URI

/turnpoint?[lc=...]...

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. 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. See Acquiring Credentials.

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 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 line widths are 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.
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.
nocmp Flag
Flag for hiding the compass on the map.
Note: The compass is automatically hidden if the image is smaller than 240. The compass size is calculated determining the final map image width and height. The size is 40 if image is 240, otherwise is 0.1 times the size of the image minus 100.
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.
ppi Integer

[Public]

Resolution to be used. Only allows three 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
Geopolotical 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.
ra Floating point number
The rotation angle of the map in degrees between 0-360. If given angle is 0, the image is not rotated at all and the compass is not displayed. If angle is greater than 360 or less than 0, the value is normalized (e.g. 380 to 20, -10 to 350).
Note: If this parameter is not requested or the value is empty or invalid, an automatic northward orientation (determined by the first two coordinate pairs of the given route points with parameter r0) is performed for the map.
Note: This parameter is disabled for zoom level less than 3, it will ignore the value .
Note: After rotation, it may happen that pois, circles, custom texts or other artifacts on the image may get outside the picture.
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.
strict Flag

Flag for validating in strict mode the request or not, if the server is already on strict mode it will make no effect.

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

token String
An URL-encoded Base64 string of typically, but not guaranteed to be 24 bytes generated based on the user's app ID and received after the registration process of the application.


The usage of token is deprecated and app_code should be used instead.

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.