Map Image API Developer's Guide

The Roadsign Resource

The Roadsign resource creates an image for road and traffic signs. It supports one image format PNG and several different countries and categories. The size can be customized.

Road sign provides a set of road and traffic signs categorized by country, along with the possibility of using labels.

Resource URI

/roadsign?[region=..]

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.

category Integer
Category for the roadsign. It is possible to request the following categories:
  • 0 OTHER
  • 1 ROADWORKS
  • 2 ACCIDENT
  • 3 CONGESTION
  • 4 FLOW
  • 5 CLOSURE
Note: Mandatory for roadsign
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.

label String
Label for the roadsign. Max is 16 characters. The following examples are used as roadsign labels: label=I-95, label=B96A, label=A144.
Note: Mandatory for Roadsign
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.

region String
Region MARC three-letter language code. There is no default value defined, therefore invalid values will make the request fail.
Note: Mandatory for Roadsign
route_level Integer (range)
This parameter categorizes the route by its priority. The values are from 1 to 6:
  • 1 - international or european road
  • 2 - national
  • 3 - primary road
  • 4 - secondary
  • 5 - minor road
  • 6 - avenue
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.

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.