Street Tiles
This endpoint will return standard street tiles according to the 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
<http|https>://<baseURL>/map/<versionNumber>/tile/<x>/<y>/<z>.<ext>?key=<apiKey>[&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 | — | — |
| x | Horizontal - or "Easting" - value. Relative to the top left point. | Yes | Integer | — | — |
| y | Vertical - or "Northing" - value. Relative to the top left point. | Yes | Integer | — | — |
| z | Zoom value. Valid values are between 0 and 20, with 0 being the most zoomed out. | Yes | Integer | — | 20 |
| ext | Valid response formats are PNG, GIF, JPG. | Yes | String | — | — |
| [settings] | String specifying the configuration to use for the rendering. | No | String | — | — |
| [res] | String specifying the resolution to be used.
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 (256x256) in the format specified in the request.