HERE Map Image API
Map Image API Developer's Guide

# The Tilt Maps Resource

The Tilt Map resource returns a tilted map image.

## Resource URI

/tiltmap?[i=...]...

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

c Geo Coordinate

Position geo coordinate. The position marker dot is shown in this location if nodot parameter is not present. Used also as map center point if ctr,ectr, POIs (parameter poi) or custom text labels (parameter tx0,tx1,...) are not requested. Ignored if parameter e is specified. Ignored if a geo search is also requested.

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.
e Encoded Geo Coordinate

Encoded equivalent of position geo coordinate parameter c. Parameter c is ignored if this parameter is specified.

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.

i Boolean
Flag for showing address or position information box inside the map image (if address is available or position is allowed to be shown).
Note: If geo search parameters such as co are provided, then the information shown is related to those parameter's values, if valid.
lat Latitude
Latitude. Used together with longitude parameter lon.
Note: For Basic Map: The latitude parameter takes no effect if position with parameter c or e is requested.
lon Longitude
Longitude. Used together with latitude parameter lat.
Note: For Basic Map: The longitude parameter takes no effect if position with parameter c is requested.
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)
• 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.
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.
nodot Flag

Flag for hiding position marker dot on the map. This has an effect only if position is requested.

pip Integer
Shows small Picture-in-Picture map from the same location as the actual requested map on bottom right corner of the map image, using the given value as zoom level for the PiP-map. Positive value is used as absolute zoom level for the PiP-map and a negative value is interpreted as the number of levels to zoom out from main map's zoom level. If the parameter is provided, but no value or no valid value for the parameter is specified, the main map's zoom level zoomed out by 5 levels is used for the PiP-map. The PiP-map size is related to the requested map size (1/3 of the map's width and height). However, the PiP-map maximum size is 150x150px and the minimum size is 50x50px.
Note: When the PiP zoom level is below 3 and fractional, then the value is rounded down.
Note: When the PiP zoom level (either auto calculated or given) is equal or greater than the map zoom then the green area will not be shown.
Note: The PiP-map is not shown if POIs (parameter poi) without nomrk flag are requested .
Note: When the parameter ra is used, the PiP-map is not rotated if the PiP-map zoom level is below 3.
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.

Note: Basic Map: Radius of the surrounding area to be shown on map around the map center point. Indexing in parameter name is not supported i.e. plain rad must be used. This parameter will be ignored if the zoom level parameter z is provided or POIs (with parameter poi) or text labels with parameter txN (where N means index 0..n) are requested.
Note: Region and Heat Map: Radius of a circular area. Radii have to be distinguished by indexes in parameter name when showing multiple circular areas/regions. The index number is used for linking the radius to similarly indexed area/region having only one geo coordinate pair. When presenting only a single circular area/region, the index 0 of the parameter is not required i.e. plain rad can be used. Parameter will be ignored if the corresponding area/region parameter aN (where N means index 0..n) value consists of more than one geo coordinate pair (i.e. it is incorrectly defined). Please be aware that this is not applied when only one area/region exists, since they can have multiple geo coordinate values.
sb String
Scale bars to show at bottom right corner of the map. The scale bar won't be drawn if it does not properly fit in the image. Value defines whether to show scale bar in kilometers/meters and/or in miles/feet.
• k: Shows scale bar in kilometers/meters.
• m: Shows scale bar in miles/feet.
• km or mk: Shows two scale bars, one in kilometers/meters and one in miles/feet.
Note: The scale bar won't be drawn if it does not properly fit in the image.
strict Flag

Flag for validating the request in strict mode. If the flag is provided request will be validated in strict mode. If the server is already running in strict mode, then it will supercede this parameter.

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

ta Double
Tilt Angle between 0 and 60 degrees.
Note: For Tilt: When using this parameter the resulting w and h of the image might not be exactly the same as the ones requested in the url due to the distortion of the image caused by the rotation plus the tilting.
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 apiKey should be used instead.

u Distance
Radius of uncertain area around the requested position.

Draws color filled circle having given value as radius around the position marker dot.

Note: For Basic Map: For it to be shown, it is required that the position is also requested.
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.