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

WMTS

 

Service version: 4.0
Last edit: 2019.02.01

On this page

Purpose

The Web Map Tile Service (WMTS) is the Open Geospatial Consortium (OGC)'s standard for delivering rectangular map tiles via RESTful web services. It consists of two key service calls: GetCapabilities and GetTile.

GetCapabilities

The "GetCapabilities" call documented here implements the 1.0.0 version of the WMTS standard. It returns an XML structure containing metadata on both the company hosting the service (in this case, TomTom) and the various layers that the service offers. That metadata is sufficient to allow calling systems to construct calls to Tomtom's Maps Tile API that retrieves individual raster map tiles for a given geographic extent, zoom level, and layer type.

GetTile

Because the TomTom WMTS services follow the OGC WMTS specification, it is then easy to use these services via third party tools such as Esri's ArcGIS Online. While less flexible than the WMS API, WMTS "GetTile" calls are tailored for speed. They retrieve single map tiles and do not aggregate tiles in order to deliver a single composited map image.

Run this endpoint

You can easily run this and other endpoints.

  1. Go to the TomTom API Explorer page.
  2. Click an endpoint.
    1. Click Try it out.
    2. Enter/select all required parameter values and any optional parameter values.
    3. At the bottom of the form, click Execute.
  3. Review the Response.

▲ Return to top

Request data

HTTPS method: GET

Communication through both HTTP and HTTPS is supported.

URL format

For ease of viewing and identification:

  • Required constants and parameters are shown in bold text.
  • Optional parameters are shown in plain text.
http|https://baseURL/map/versionNumber/wmts/apiKey/wmtsVersion/WMTSCapabilities.xml

Example

https://api.tomtom.com/map/1/wmts/apiKey/1.0.0/WMTSCapabilities.xml

curl command

curl -XGET 'https://api.tomtom.com/map/1/wmts/apiKey/1.0.0/WMTSCapabilities.xml'

▲ Return to top

Request parameters

The following table describes all the parameters that can be used in a Request.

  • Required parameters must be used or the call will fail.
  • Optional parameters 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.
Required parameters
Parameter Description
baseURL
string
The base URL for calling TomTom services.
Value: api.tomtom.com
versionNumber
integer
The version of the service to call.
Value: The current version is 1.
apiKey
string
The authorization key for access to the API.
Value: Your valid API Key.
wmtsVersion
float
The version of the WMTS service.
Value: 1.0.0
Optional parameters
Note: There are no optional parameters in this endpoint.

▲ Return to top

Response data

A full schema (XSD) for the Response is available from openGIS. The following XML code block is a partial example of a successful Response. For the meanings and use of the different elements, please refer to the schema.

Response body (XML)

<?xml version="1.0" encoding="UTF-8"?>
<Capabilities xmlns="http://www.opengis.net/wmts/1.0" xmlns:ows="http://www.opengis.net/ows/1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:gml="http://www.opengis.net/gml" xsi:schemaLocation="http://www.opengis.net/wmts/1.0 http://schemas.opengis.net/wmts/1.0/wmtsGetCapabilities_response.xsd" version="1.0.0">
  <ows:ServiceIdentification>
    <ows:Title>TomTom Web Map Tile Service</ows:Title>
    <ows:ServiceType>OGC WMTS</ows:ServiceType>
    <ows:ServiceTypeVersion>1.0.0</ows:ServiceTypeVersion>
    <ows:Fees>none</ows:Fees>
    <ows:AccessConstraints>none</ows:AccessConstraints>
  </ows:ServiceIdentification>

  <ows:ServiceProvider>
    <ows:ProviderName>TomTom International B.V.</ows:ProviderName>
    <ows:ProviderSite xlink:href="http://www.tomtom.com"/>
    <ows:ServiceContact>
      (...contact information for support of the service...)
    </ows:ServiceContact>
  </ows:ServiceProvider>

  <ows:OperationsMetadata>
    <ows:Operation name="GetCapabilities">
      (...metadata on the GetCapabilities call)
    </ows:Operation>
    <ows:Operation name="GetTile">
      (...metadata on the GetTile call)
    </ows:Operation>
  </ows:OperationsMetadata>

  <Contents>
    <!-- Basic Map -->
    <Layer>
      <ows:Title>TomTom Map — Standard</ows:Title>
      <ows:WGS84BoundingBox crs="urn:ogc:def:crs:OGC:2:84">
        <ows:LowerCorner>-180 -85</ows:LowerCorner>
        <ows:UpperCorner>180 85</ows:UpperCorner>
      </ows:WGS84BoundingBox>
      <ows:Identifier>ttms</ows:Identifier>
      <Style isDefault="true">
        <ows:Identifier>map/1/tile/basic/main</ows:Identifier>
      </Style>
      <Format>image/png</Format>
      <TileMatrixSetLink>
        <TileMatrixSet>google900913</TileMatrixSet>
      </TileMatrixSetLink>
      <ResourceURL format="image/png" template="http://a.api.tomtom.com/{Style}/{TileMatrix}/{TileCol}/{TileRow}.png?key=apiKey" resourceType="tile"/>
      <ResourceURL format="image/png" template="http://b.api.tomtom.com/{Style}/{TileMatrix}/{TileCol}/{TileRow}.png?key=apiKey" resourceType="tile"/>
      <ResourceURL format="image/png" template="http://c.api.tomtom.com/{Style}/{TileMatrix}/{TileCol}/{TileRow}.png?key=apiKey" resourceType="tile"/>
      <ResourceURL format="image/png" template="http://d.api.tomtom.com/{Style}/{TileMatrix}/{TileCol}/{TileRow}.png?key=apiKey" resourceType="tile"/>
    </Layer>
    <Layer>
      (...metadata on additional layers...)
      <Layer>

        <TileMatrixSet>
          <ows:Identifier>google900913</ows:Identifier>
          <ows:BoundingBox crs="urn:ogc:def:crs:EPSG:6.18:3:3857">
            <ows:LowerCorner>20037508.3428 -20037508.3428</ows:LowerCorner>
            <ows:UpperCorner>-20037508.3428 20037508.3428</ows:UpperCorner>
          </ows:BoundingBox>
          <ows:SupportedCRS>urn:ogc:def:crs:EPSG:6.18:3:3857</ows:SupportedCRS>
          <WellKnownScaleSet>urn:ogc:def:wkss:OGC:1.0:GoogleMapsCompatible</WellKnownScaleSet>
          <TileMatrix>
            <ows:Identifier>0</ows:Identifier>
            <ScaleDenominator>559082264.029</ScaleDenominator>
            <TopLeftCorner>-20037508.3428 20037508.3428</TopLeftCorner>
            <TileWidth>256</TileWidth>
            <TileHeight>256</TileHeight>
            <MatrixWidth>1</MatrixWidth>
            <MatrixHeight>1</MatrixHeight>
          </TileMatrix>
          (...metadata on further matrixes...)
        </TileMatrixSet>
      </Contents>

  <ServiceMetadataURL xlink:href="http://api.tomtom.com/map/1/wmts/apiKey/1.0.0/GetCapabilities.xml"/>
</Capabilities>

▲ Return to top

HTTP Response codes

Code Meaning and Possible Causes
200 OK
400 Bad request: Probably malformed syntax.
401 Unauthorized: The supplied API Key is not valid for this Request.
500 Internal Server Error: There is a problem with the TomTom WMTS service.

HTTP Response headers

Header Description
Access-Control-Allow-Origin The Maps WMTS API allows cross-origin resource sharing (CORS).
Value: * (universal)

▲ Return to top