Sorry, you need to enable JavaScript to visit this website.

Static Images

This endpoint will return custom street images according to the size, resolution and style settings indicated.

Setting Resolutions Night Support? Transparent Support?
global-decarta mdpi, hdpi, xhdpi, xxhdpi Yes Yes
global-tomtom mdpi, hdpi, xhdpi, xxhdpi Yes Yes

Request

Format

GET <http|https>://<baseURL>/map/<versionNumber>/staticImage/<top_left>/<bottom_right>.<ext>?key=<apiKey>[&height=<height>][&width=<width>][&settings=<settings>][&res=<res>][&night=<night>][&transparent=<transparent>]

Communication through both HTTP and HTTPS is supported.

Parameters

The table below describes all of the parameters that can be used in a request. Required parameters must be used or the call will fail. Optional parameters, which are highlighted with [square brackets], may be used. If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table. The order of request parameters is not important.

Parameter Description Req'd? Type / Values Default value Max value
baseURL Base URL for calling the API. Yes api.tomtom.com
versionNumber Service version number. The current value is 0. Yes 0
apiKey Your TomTom API Key. Yes String
top_left Top left position of the bounding box. This is specified as a comma separated string composed by lat., lon. (e.g.: 37.553,-122.453). Yes Position
bottom_right Bottom right position of the bounding box. This is specified as a comma separated string composed by lat., lon. (e.g.: 37.553,-122.453). Yes Position
ext Valid response formats are PNG, GIF, JPG. Yes String
[height] The height in pixels. No Integer 256 1024
[width] The width in pixels. No Integer 256 1024
[settings] String specifying the deCarta configuration file to use for the rendering. No String global-decarta
[res] String specifying the resolution to be used.
Please refer to the table at the top of the page for supported resolutions.
Resolutions: mdpi [1X / 160dpi], hdpi [1.5X / 240dpi], xhdpi [2X / 320dpi], xxhdpi [3X / 480dpi].
No String mdpi
[night] Whether or not to use the night setting. Please double check that your settings support the night configuration. This is mutually exclusive with the transparent configuration. No Boolean
[transparent] Returns transparent tiles when it is set to true. Please double check that your settings support the transparent configuration. This is mutually exclusive with the night configuration. No Boolean

Response

Format

The response will be an raster image in the format / size specified in the request.

You are here