### TomTom WMS GetCapabilities Example Request
Source: https://developer.tomtom.com/map-display-api/documentation/raster/wms
An example of a GET request URL for the GetCapabilities endpoint, demonstrating how to specify parameters for accessing service descriptions.
```text
https://api.tomtom.com/map/1/wms/?key={Your_API_Key}&service=WMS&request=GetCapabilities&version=1.1.1
```
--------------------------------
### TomTom WMS GIS Software URL Example
Source: https://developer.tomtom.com/map-display-api/documentation/raster/wms
An example of a GET request URL for the GIS Software URL endpoint, showing the base structure for interacting with TomTom map services.
```text
https://api.tomtom.com/map/1/wms/?key={Your_API_Key}
```
--------------------------------
### Map Display API - GET Request Example
Source: https://developer.tomtom.com/map-display-api/documentation/raster/static-image
Demonstrates a correct GET request for the TomTom Map Display API, utilizing the 'bbox' parameter for defining the map view.
```APIDOC
## GET /map/1/staticimage
### Description
This endpoint retrieves a static map image based on specified parameters.
### Method
GET
### Endpoint
`/map/1/staticimage`
### Parameters
#### Query Parameters
- **key** (string) - Required - Your TomTom API key.
- **zoom** (integer) - Required - The zoom level for the map.
- **bbox** (string) - Required - The bounding box coordinates (-180,-85,180,85).
- **format** (string) - Optional - The image format (e.g., jpg, png).
- **layer** (string) - Optional - The map layer to display (e.g., basic, traffic).
- **style** (string) - Optional - The map style (e.g., main, monochrome).
- **view** (string) - Optional - The regional view to apply.
### Request Example
```json
{
"example": "https://api.tomtom.com/map/1/staticimage?key={Your_API_Key}&zoom=5&bbox=-180,-85,0,0&format=jpg&layer=basic&style=main&view=Unified"
}
```
### Response
#### Success Response (200)
- **image** (binary) - The static map image.
#### Response Example
(Binary image data)
```
--------------------------------
### Example Request URL for Map Copyrights
Source: https://developer.tomtom.com/map-display-api/documentation/copyrights
An example of a GET request URL to retrieve map copyrights from the TomTom API.
```http
https://api.tomtom.com/map/2/copyrights?key={Your_API_Key}
```
--------------------------------
### TomTom Map Display API GetMap Request Example
Source: https://developer.tomtom.com/map-display-api/documentation/raster/wms
This is a concrete example of a GET request to the TomTom Map Display API's GetMap endpoint. It demonstrates how to populate the URL with specific parameters to retrieve a map image in PNG format.
```url
https://api.tomtom.com/map/1/wms/?key={Your_API_Key}&service=WMS&version=1.1.1&request=GetMap&bbox=1.355233,42.982261,24.980233,56.526017&srs=EPSG:4326&width=1305&height=748&layers=basic&styles=&format=image/png
```
--------------------------------
### TomTom Map Display API Style Method Examples
Source: https://developer.tomtom.com/map-display-api/documentation/mapstyles/map-styles
Provides example request URLs for the TomTom Map Display API's Style method. These examples demonstrate different combinations of parameters for map styles, traffic incidents, and traffic flow.
```URL
https://api.tomtom.com/style/1/style/20.3.4-6?key={Your_API_Key}&map=basic_main&traffic_incidents=incidents_night&traffic_flow=flow_absolute&poi=poi_main
```
```URL
https://api.tomtom.com/style/1/style/20.3.2-3?key={Your_API_Key}&map=basic_night&traffic_incidents=incidents_night
```
```URL
https://api.tomtom.com/style/1/style/20.3.2-3?key={Your_API_Key}&traffic_incidents=incidents_s0&traffic_flow=flow_relative0
```
--------------------------------
### Example Static Image API Request (JPG)
Source: https://developer.tomtom.com/map-display-api/documentation/raster/static-image
An example of a GET request to the Static Image API to retrieve a map image in JPG format. This example specifies zoom level, center coordinates, layer, style, dimensions, and geopolitical view.
```http
https://api.tomtom.com/map/1/staticimage?key={Your_API_Key}&zoom=9¢er=13.567893,46.112341&format=jpg&layer=basic&style=main&width=1305&height=748&view=Unified&language=en-GB
```
--------------------------------
### Example Request URL for Map Service Copyrights (JSON)
Source: https://developer.tomtom.com/map-display-api/documentation/copyrights
An example GET request URL to retrieve map service copyrights in JSON format.
```http
https://api.tomtom.com/map/2/copyrights/caption.json?key={Your_API_Key}
```
--------------------------------
### Example Static Image API Request (PNG)
Source: https://developer.tomtom.com/map-display-api/documentation/raster/static-image
An example of a GET request to the Static Image API to retrieve a map image in PNG format, focusing on labels with a night style. This demonstrates using a bounding box for defining the map area and specifying a particular geopolitical view.
```http
https://api.tomtom.com/map/1/staticimage?key={Your_API_Key}&zoom=9&bbox=23.355233,55.982261,24.980233,56.526017&format=png&layer=labels&style=night&view=IN&language=en-GB
```
--------------------------------
### TomTom Map Styles Metadata Examples
Source: https://developer.tomtom.com/map-display-api/documentation/mapstyles/map-styles
Examples of request URLs for retrieving metadata for styles, sprites, and glyphs using the TomTom Map Display API. These examples demonstrate different resource types and formats.
```http
https://api.tomtom.com/map/1/style/metadata.xml?key={Your_API_Key}
```
```http
https://api.tomtom.com/map/1/sprite/20.0.0-8/metadata.json?key={Your_API_Key}
```
```http
https://api.tomtom.com/map/1/glyph/20.0.0-8/metadata.jsonp?key={Your_API_Key}
```
--------------------------------
### WMTS GetCapabilities Request Example
Source: https://developer.tomtom.com/map-display-api/documentation/raster/wmts
An example of a complete WMTS GetCapabilities request URL using TomTom's API. This shows how to substitute the placeholders with concrete values.
```HTTP
https://api.tomtom.com/map/1/wmts/apiKey={Your_API_Key}/1.0.0/WMTSCapabilities.xml
```
--------------------------------
### Example Hillshade Tile Request
Source: https://developer.tomtom.com/map-display-api/documentation/tomtom-orbis-maps/hillshade-tile
An example of a GET request to the TomTom Hillshade Tile API, specifying the layer, zoom level, tile coordinates, image format, and API key.
```http
https://api.tomtom.com/maps/orbis/map-display/tile/hillshade/8/68/120.png?key={Your_API_Key}&apiVersion=1
```
--------------------------------
### Example Hillshade Tile Request
Source: https://developer.tomtom.com/map-display-api/documentation/raster/hillshade-tile
A concrete example of a request to the Hillshade Tile API for zoom level 8. This shows how to structure the URL with specific parameters.
```plaintext
https://api.tomtom.com/map/1/tile/hill/main/8/68/120.png?key={Your_API_Key}
```
--------------------------------
### Example: Whole world at zoom level 0 (Basic Main)
Source: https://developer.tomtom.com/map-display-api/documentation/raster/map-tile
Provides an example of a request URL for fetching the entire world map at zoom level 0 using the 'basic' layer and 'main' style. It also shows the corresponding URL for the 'night' style.
```HTTP
https://api.tomtom.com/map/1/tile/basic/main/0/0/0.png?key={Your_API_Key}
```
```HTTP
https://api.tomtom.com/map/1/tile/basic/night/0/0/0.png?key={Your_API_Key}
```
--------------------------------
### Copyrights API - Bounding Box Curl Command
Source: https://developer.tomtom.com/map-display-api/documentation/copyrights-deprecated
This is an example of a curl command to request copyright information for a specified bounding box. It demonstrates how to make a GET request with the necessary parameters including bounding box coordinates, format, and API key.
```shell
curl 'https://{baseURL}/map/{versionNumber}/copyrights/{minLon}/{minLat}/{maxLon}/{maxLat}.{format}?key={Your_API_Key}'
```
--------------------------------
### TomTom Map Resource Examples
Source: https://developer.tomtom.com/map-display-api/documentation/mapstyles/map-styles
Examples of request URLs for retrieving specific map resources, including a style file and a sprite image, from the TomTom Map Display API. These showcase how to specify resource versions and names.
```http
https://api.tomtom.com/map/1/style/20.0.0-8/basic_main.json?key={Your_API_Key}
```
```http
https://api.tomtom.com/map/1/sprite/20.0.0-8/lite/sprite.png?key={Your_API_Key}
```
--------------------------------
### Example Hillshade Tile Request
Source: https://developer.tomtom.com/map-display-api/documentation/raster/hillshade-tile
An example GET request to retrieve a hillshade tile from the TomTom Maps Raster Tile API for zoom level 13. Replace {Your_API_Key} with your actual API key.
```HTTP
https://api.tomtom.com/map/1/tile/hill/main/13/2196/3879.png?key={Your_API_Key}
```
--------------------------------
### TomTom Maps Raster Tile API Curl Command Example
Source: https://developer.tomtom.com/map-display-api/documentation/tomtom-orbis-maps/raster-tile
This is an example of a curl command to request map tiles from the TomTom Maps Raster Tile API. It demonstrates how to construct the command with necessary parameters.
```bash
curl 'https://{baseURL}/maps/orbis/map-display/tile/{zoom}/{X}/{Y}.{format}?apiVersion=1&key={Your_API_Key}&style={style}&tileSize={tileSize}&view={view}&language={language}'
```
--------------------------------
### Curl Command for Static Image API Request
Source: https://developer.tomtom.com/map-display-api/documentation/raster/static-image
A curl command demonstrating how to request a static map image from the TomTom API. This example mirrors one of the provided GET request URLs, showing how to pass parameters for zoom, center, format, layer, style, dimensions, view, and language.
```bash
curl 'https://api.tomtom.com/map/1/staticimage?key={Your_API_Key}&zoom=9¢er=13.567893,46.112341&format=jpg&layer=basic&style=main&width=1305&height=748 &view=Unified &language=en-GB'
```
--------------------------------
### Error Response Example (XML)
Source: https://developer.tomtom.com/map-display-api/documentation/tomtom-orbis-maps/tile
An example of an error response from the Map Display API when an invalid request is made, formatted in XML. It includes a description, error code, and detailed error information.
```XML
BAD_REQUEST
Invalid tile position arguments
```
--------------------------------
### Get Map Copyrights Example - TomTom Orbis Maps API
Source: https://developer.tomtom.com/map-display-api/documentation/tomtom-orbis-maps/copyrights
An example of a specific URL to retrieve map copyrights from the TomTom Orbis Maps API, using a placeholder for the API key. This demonstrates how to construct a valid request.
```plaintext
https://api.tomtom.com/maps/orbis/copyrights?key={Your_API_Key}
```
--------------------------------
### TomTom API Example Request URLs
Source: https://developer.tomtom.com/map-display-api/documentation/mapstyles/map-styles
Examples of actual request URLs for the TomTom Map Display API using the Merged Sprite method. These demonstrate different style combinations and output formats (PNG and JSON) with specific version numbers and style parameters.
```url
https://api.tomtom.com/style/1/sprite/20.3.4-6/sprite.png?key={Your_API_Key}&map=basic_main&traffic_incidents=incidents_s0&traffic_flow=flow_relative0&poi=poi_main
```
```url
https://api.tomtom.com/style/1/sprite/20.3.2-3/sprite@2x.json?key={Your_API_Key}&map=basic_night&traffic_incidents=incidents_s0-dark
```
```url
https://api.tomtom.com/style/1/sprite/20.3.2-3/sprite@2x.png?key={Your_API_Key}&traffic_incidents=incidents_s1&traffic_flow=flow_relative0-dark
```
--------------------------------
### Get Map Service Copyrights Example - TomTom Orbis Maps API
Source: https://developer.tomtom.com/map-display-api/documentation/tomtom-orbis-maps/copyrights
An example URL to retrieve map service copyrights (captions) in JSON format from the TomTom Orbis Maps API. It includes a placeholder for the API key, demonstrating a practical request.
```plaintext
https://api.tomtom.com/maps/orbis/copyrights/caption.json?key={Your_API_Key}
```
--------------------------------
### Example: Decoding LINESTRING Geometry
Source: https://developer.tomtom.com/map-display-api/documentation/vector/content-v2
Provides an example of decoding a LINESTRING type feature's geometry. It includes the input geometry array and highlights the different commands and coordinate pairs involved in constructing the line.
```plaintext
layer: 0
feature: 0
type: LINESTRING
geometry: [9, 846, 2312, 10, 652, 1938]
```
--------------------------------
### TomTom Map Display API - Basic Layer Example
Source: https://developer.tomtom.com/map-display-api/documentation/vector/tile-v2
Example request and response for retrieving the whole world at zoom level 0 for the basic map layer. The response includes details about layers, water, land cover, boundaries, and carto labels.
```HTTP
Request: https://api.tomtom.com/map/2/tile/basic/0/0/0.pbf?key={Your_API_Key}
Response: layers:4 water: version: 2 extent: 4096 features: 1069 keys: 2 values: 3 land_cover: version: 2 extent: 4096 features: 2983 keys: 2 values: 6 boundaries: version: 2 extent: 4096 features: 4 keys: 4 values: 3 carto_labels: version: 2 extent: 4096 features: 5 keys: 4 values: 8
```
--------------------------------
### Error Response Example - XML
Source: https://developer.tomtom.com/map-display-api/documentation/raster/map-tile
An example of an error response from the Map Display API when a request is malformed. This XML structure includes error details like a description, error code, and a message.
```xml
BAD_REQUEST
Invalid tile position arguments
```
--------------------------------
### TomTom Map Display API Host Name Cycling Example (b.api.tomtom.com)
Source: https://developer.tomtom.com/map-display-api/documentation/raster/wms
This example shows another host name in the cycling sequence, 'b.api.tomtom.com', for requesting traffic map tiles. This technique helps improve map rendering performance by allowing concurrent tile downloads.
```url
https://b.api.tomtom.com/traffic/map/4/tile/flow/relative/1/0/0.pbf?key={Your_API_Key}
```
--------------------------------
### TomTom Map Display API - Labels Layer Example
Source: https://developer.tomtom.com/map-display-api/documentation/vector/tile-v2
Example request and response for retrieving map tiles at zoom level 4 for the labels layer. The response details the 'boundaries', 'places', and 'carto_labels' layers present in the data.
```HTTP
Request: https://api.tomtom.com/map/2/tile/labels/4/9/5.pbf?key=Your_API_Key
Response: layers: 3 boundaries: version: 2 extent: 4096 features: 3 keys: 2 values: 3 places: version: 2 extent: 4096 features: 50 keys: 10 values: 110 carto_labels: version: 2 extent: 4096 features: 1 keys: 4 values: 4
```
--------------------------------
### TomTom Map Display API - Hybrid Layer Example
Source: https://developer.tomtom.com/map-display-api/documentation/vector/tile-v2
Example request and response for retrieving map tiles at zoom level 5 for the hybrid layer. The response indicates the presence of boundaries within the requested tile.
```HTTP
Request: https://api.tomtom.com/map/2/tile/hybrid/5/4/8.pbf?key={Your_API_Key}
Response: layers: 1 boundaries: version: 2 extent: 4096 features: 1 keys: 1 values: 1
```
--------------------------------
### Example Request: Whole World at Zoom 0
Source: https://developer.tomtom.com/map-display-api/documentation/raster/satellite-tile
An example request for the TomTom Maps Raster Tile API to fetch the whole world map at zoom level 0. The response will be a single satellite tile in JPG format.
```HTTP
https://api.tomtom.com/map/1/tile/sat/main/0/0/0.jpg?key={Your_API_Key}
```
--------------------------------
### Example Hillshade Tile Requests
Source: https://developer.tomtom.com/map-display-api/documentation/tomtom-orbis-maps/hillshade-tile
Examples of GET requests to retrieve hillshade map tiles from the TomTom Maps Raster Tile API for different zoom levels.
```HTTP
https://api.tomtom.com/maps/orbis/map-display/tile/hillshade/8/68/120.png?key={Your_API_Key}&apiVersion=1
```
```HTTP
https://api.tomtom.com/maps/orbis/map-display/tile/hillshade/13/2196/3879.png?key={Your_API_Key}&apiVersion=1
```
--------------------------------
### Example 1: Whole world at zoom 0 (basic-main style)
Source: https://developer.tomtom.com/map-display-api/documentation/vector/tile
Demonstrates an API request for the whole world at zoom level 0 with the basic-main style, and provides a textual representation of the response data including layer details.
```url
https://api.tomtom.com/map/1/tile/basic/main/0/0/0.pbf?key={Your_API_Key}
```
```text
Copylayers:3 lake: version: 2 extent: 255 features: 371 keys: 0 values: 0 geometry summary: total: 3339 commands: 1113 move_to: 371 line_to: 742 close: 371 degenerate polygons: 371 empty geoms: 0 ocean: version: 2 extent: 255 features: 5313 keys: 0 values: 0 geometry summary: total: 47817 commands: 15939 move_to: 5313 line_to: 10626 close: 5313 degenerate polygons: 5313 empty geoms: 0 country border: version: 2 extent: 255 features: 199 keys: 1 values: 0 geometry summary: total: 3162 commands: 398 move_to: 199 line_to: 1183 close: 0 degenerate polygons: 73 empty geoms: 0
```
--------------------------------
### Example: Decoding POINT Geometry
Source: https://developer.tomtom.com/map-display-api/documentation/vector/content
Illustrates the process of decoding a POINT geometry from a vector tile feature, showing how to extract command, count, and coordinates.
```plaintext
Input:
layer: 0
feature: 0
type: POINT
geometry: [9, 1136, 6564]
Decoding:
geometry:
command_and_count = 9
command = 9 & 0x7 = 1 (MoveTo)
count = 9 >> 0x3 = 1
x0 = 1136, y0 = 6564
decode(x0) = ((1136 >> 1) ^ -(1136 & 1)) = 568
decode(y0) = ((6564 >> 1) ^ -(6564 & 1)) = 3282
Output:
layer: 0
feature: 0
geometry: POINT(568, 3282)
```
--------------------------------
### Map Tile Request Example
Source: https://developer.tomtom.com/map-display-api/documentation/vector/tile
Demonstrates how to request map tiles by cycling through host names.
```APIDOC
## GET /map/{version}/tile/{layer}/{layerStyle}/{zoom}/{x}/{y}.png
### Description
Requests a map tile for display. By cycling through hostnames like `a.api.tomtom.com`, `b.api.tomtom.com`, etc., you can increase the number of concurrent tile downloads, improving rendering performance.
### Method
GET
### Endpoint
`https://{host_alias}.api.tomtom.com/map/1/tile/basic/main/{zoom}/{x}/{y}.png?key={Your_API_Key}`
### Parameters
#### Path Parameters
- **version** (integer) - The API version, typically `1`.
- **layer** (string) - The map layer, e.g., `basic`.
- **layerStyle** (string) - The style of the map layer, e.g., `main`.
- **zoom** (integer) - The zoom level of the map tile.
- **x** (integer) - The x-coordinate of the map tile.
- **y** (integer) - The y-coordinate of the map tile.
#### Query Parameters
- **key** (string) - Your TomTom API key.
#### Host Aliases
To improve performance, cycle through the following host aliases:
- `a.api.tomtom.com`
- `b.api.tomtom.com`
- `c.api.tomtom.com`
- `d.api.tomtom.com`
### Request Example
```json
{
"example": "https://a.api.tomtom.com/map/1/tile/basic/main/1/0/0.png?key={Your_API_Key}"
}
```
### Response
#### Success Response (200)
Returns a binary response body containing the map tile data (e.g., PNG format for raster tiles, PBF for vector tiles).
#### Response Example
(Binary data representing a map tile)
```
--------------------------------
### Get Global Copyrights in JSON
Source: https://developer.tomtom.com/map-display-api/documentation/copyrights-deprecated
Fetches global copyright information in JSON format from the TomTom Map Display API. This example uses the base URL and requires an API key.
```HTTP
https://api.tomtom.com/map/1/copyrights.json?key={Your_API_Key}
```
--------------------------------
### TomTom Map Display API Style Method Curl Command
Source: https://developer.tomtom.com/map-display-api/documentation/mapstyles/map-styles-v2
This snippet provides a practical example of how to execute a request to the TomTom Map Display API's Style method using a curl command. It demonstrates making a GET request with specific parameters for traffic incidents and traffic flow.
```bash
curl 'https://api.tomtom.com/style/1/style/22.2.1-9?key={Your_API_Key}&traffic_incidents=2/incidents_light&traffic_flow=2/flow_relative-light'
```
--------------------------------
### Request URL using b.api.tomtom.com
Source: https://developer.tomtom.com/map-display-api/documentation/vector/tile
Example of requesting a map tile using the 'b.api.tomtom.com' hostname. This demonstrates the host name cycling technique to improve map loading performance.
```url
https://b.api.tomtom.com/map/1/tile/basic/main/1/0/0.png?key={Your_API_Key}
```
--------------------------------
### Example: Decoding POINT Geometry
Source: https://developer.tomtom.com/map-display-api/documentation/vector/content-v2
Demonstrates the decoding of a POINT type feature's geometry. It shows the input array, the step-by-step decoding of command, count, and coordinates, and the final output coordinate.
```plaintext
layer: 0
feature: 0
type: POINT
geometry: [9, 1136, 6564]
geometry:
command_and_count = 9
command = 9 & 0x7 = 1
count = 9 >> 0x3 = 1
x= 1136, y0 = 6564
decode(x0) = ((1136 >> 0x1) ^ (-(1136 & 0x1))) = 568
decode(y0) = ((6564 >> 0x1) ^ (-(6564 & 0x1))) = 3282
layer: 0
feature: 0
geometry: POINT(561, 3282)
```
--------------------------------
### JSON Error Response Example
Source: https://developer.tomtom.com/map-display-api/documentation/raster/satellite-tile
An example of an error response returned by the API in JSON format. It includes a detailed error object with a code and a human-readable message.
```json
{
"detailedError": {
"code": "BAD_REQUEST",
"message": "Invalid tile position arguments"
}
}
```
--------------------------------
### Example Satellite Tile Request
Source: https://developer.tomtom.com/map-display-api/documentation/tomtom-orbis-maps/satellite-tile
This is an example of a request URL to fetch a satellite map tile at a specific zoom level. It requires a TomTom API key for authentication.
```HTTP
https://api.tomtom.com/maps/orbis/map-display/tile/satellite/17/67296/43062.jpg?key={Your_API_Key}
```
--------------------------------
### TomTom Map Resource cURL Command
Source: https://developer.tomtom.com/map-display-api/documentation/mapstyles/map-styles
A cURL command example for fetching a specific map style resource from the TomTom Map Display API. This illustrates how to construct the request for a particular style file.
```bash
curl 'https://api.tomtom.com/map/1/style/20.0.0-8/basic_main.json?key={Your_API_Key}'
```
--------------------------------
### JSON Error Response Example
Source: https://developer.tomtom.com/map-display-api/documentation/vector/tile-v2
An example of a typical error response in JSON format. It includes a detailed error object with a specific error code and a human-readable message.
```json
{
"detailedError": {
"code": "BAD_REQUEST",
"message": "Invalid tile position arguments"
}
}
```
--------------------------------
### TomTom Map Display API Style Method Example Requests
Source: https://developer.tomtom.com/map-display-api/documentation/mapstyles/map-styles-v2
These examples demonstrate various ways to call the TomTom Map Display API's Style method with different combinations of optional parameters. They showcase how to request specific map styles, traffic incident data, traffic flow information, POIs, restrictions, and hillshade.
```plaintext
https://api.tomtom.com/style/1/style/22.2.1-9?key={Your_API_Key}&map=2/basic_street-light&traffic_incidents=2/incidents_light&traffic_flow=2/flow_relative-light&poi=2/poi_light
```
```plaintext
https://api.tomtom.com/style/1/style/22.2.1-9?key={Your_API_Key}&map=2/basic_street-light&traffic_incidents=2/incidents_light
```
```plaintext
https://api.tomtom.com/style/1/style/22.2.1-9?key={Your_API_Key}&traffic_incidents=2/incidents_light&traffic_flow=2/flow_relative-light
```
```plaintext
https://api.tomtom.com/style/1/style/24.2.0-3?key={Your_API_Key}&map=2/basic_street-light&hillshade=2/hillshade_light
```
--------------------------------
### Error Response Example - JSON
Source: https://developer.tomtom.com/map-display-api/documentation/raster/map-tile
An example of an error response from the Map Display API when a request is malformed. This JSON structure includes a detailed error object with a code and a human-readable message.
```json
{ "detailedError": { "code": "BAD_REQUEST", "message": "Invalid tile position arguments" } }
```
--------------------------------
### Map Display API - Example Travel Mode Profile
Source: https://developer.tomtom.com/map-display-api/documentation/vector/tile-v2
Provides examples of how to format the travel mode profile string, including vehicle type and dimensions, for use with the Map Display API.
```text
Example 1: `0,1500,,,5.5,,2.2,,,,,,`| Car, weight 1500kg, length 5.5m, height 2.2m.
Example 2: `1,,,3,,3.1,,,,,,,`| Truck, 3 axles, width 3.1m.
```
--------------------------------
### Example 2: Zoom level 5 (hybrid-main style)
Source: https://developer.tomtom.com/map-display-api/documentation/vector/tile
Shows an API request for map tiles at zoom level 5 with the hybrid-main style, and presents a textual representation of the response, detailing state borders and geometry summaries.
```url
https://api.tomtom.com/map/1/tile/hybrid/main/5/4/8.pbf?key={Your_API_Key}
```
```text
Copylayers: 1 state border: version: 2 extent: 16384 features: 200 keys: 3 values: 0 geometry summary: total: 8384 commands: 400 move_to: 200 line_to: 3792 close: 0 degenerate polygons: 23 empty geoms: 0
```
--------------------------------
### Example JSON Response for Country Data
Source: https://developer.tomtom.com/map-display-api/documentation/copyrights-deprecated
An example of a JSON response containing country information, specifically highlighting the ISO3 code for a country within a regions array. This format is used when requesting country data from the API.
```JSON
{
"formatVersion": "0.0.1",
"regions": [
{
"country": {
"ISO3": "USA"
}
}
]
}
```
--------------------------------
### Map Display API - HTTP Request Headers
Source: https://developer.tomtom.com/map-display-api/documentation/vector/tile-v2
Lists optional HTTP request headers for the Map Display API Vector Tile service. Includes Accept-Encoding for compression, If-None-Match for version control, and Tracking-ID for request tracing.
```text
Optional headers:
`Accept-Encoding` - Contains the content encoding (e.g., `gzip`) that the client is able to understand.
`If-None-Match` - Contains an identifier for a specific version of a resource. Value: ``.
`Tracking-ID` - Specifies an identifier for the request, matching regex `'^[a-zA-Z0-9-]{1,100}$'`. Example: `9ac68072-c7a4-11e8-a8d5-f2801f1b9fd1`. Value: ``.
```
--------------------------------
### Example Vector Tile Response (Textual Representation)
Source: https://developer.tomtom.com/map-display-api/documentation/tomtom-orbis-maps/tile
A simplified textual representation of a successful vector tile response from the Map Display API. It outlines the layers and their associated data like version, extent, and feature counts.
```Text
layers:4 water: version: 2 extent: 4096 features: 1069 keys: 2 values: 3 land_cover: version: 2 extent: 4096 features: 2983 keys: 2 values: 6 boundaries: version: 2 extent: 4096 features: 4 keys: 4 values: 3 carto_labels: version: 2 extent: 4096 features: 5 keys: 4 values: 8
```
--------------------------------
### Error Response Examples (JSON and XML)
Source: https://developer.tomtom.com/map-display-api/documentation/raster/hillshade-tile
Examples of error responses from the Hillshade service. The default is XML, but JSON can be requested by setting the 'Accept' header to 'application/json'. Both formats detail the error code and a descriptive message.
```JSON
{
"detailedError" : {
"code" : "BAD_REQUEST",
"message" : "Invalid tile position arguments"
}
}
```
```XML
BAD_REQUEST
Invalid tile position arguments
```
--------------------------------
### XML Error Response Example
Source: https://developer.tomtom.com/map-display-api/documentation/raster/satellite-tile
An example of an error response returned by the API in XML format. This structure includes error details like description, error code, and message within an errorResponse element.
```xml
BAD_REQUEST
Invalid tile position arguments
```