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

Copyrights

Copyrights API is designed to serve copyright information for Maps Raster Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries which are written in JSON, JSONP or XML format.

Request

The user may request copyright information for three contexts: for a specific tile, for a stated bounding box, or for the whole world.

Tile

To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid).

Bounding box

Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates.

Whole world

To obtain the default copyright information for the whole world, do not specify a tile or bounding box.

Schema

The generic copyrights call schemas are as follows:

Whole world

<http|https>://<baseURL>/map/<versionNumber>/copyrights.<format>?key=<apiKey>

Tile

<http|https>://<baseURL>/map/<versionNumber>/copyrights/<zoom>/<X>/<Y>[.<format>]?key=<apiKey>

Bounding box

<http|https>://<baseURL>/map/<versionNumber>/copyrights/<minLon>/<minLat>/<maxLon>/<maxLat>[.<format>]?key=<apiKey>

Communication through both HTTP and HTTPS is supported.

Parameters

These elements are used in calls to generate files with copyrights.

Parameter Description Req'd? Type / Values Default Value
baseURL base URL for calling TomTom services Yes

api.tomtom.com

/versionNumber Version of the service to call. The current version is 1 Yes 1
/zoom Zoom level of tile to be rendered. Only used for tile-level copyright calls. No 0 .. 18
/X X coordinate of the tile on zoom grid. Only used for tile-level copyright calls. No 0..2 zoom -1
/Y Y coordinate of the tile on zoom grid. Only used for tile-level copyright calls. No 0..2 zoom -1
/minLon Minimum longitude coordinate of bounding box in latitude longitude coordinate system. Only used for bounding box copyright calls. No -180 .. 180
/minLat Minimum latitude coordinate of bounding box in latitude longitude coordinate system. Only used for bounding box copyright calls. No -90 .. 90
/maxLon Maximum longitude coordinate of bounding box in latitude longitude coordinate system. Only used for bounding box copyright calls. No -180 .. 180
/maxLat Maximum latitude coordinate of bounding box in latitude longitude coordinate system. Only used for bounding box copyright calls. No -90 .. 90
[format] Format of the response. Note that this is required when doing a whole-world call. No / Yes
  • json
  • jsonp
  • xml
xml
key= API Key valid for requested service Yes API Key
text= Boolean to exclude textual data from response. Only images and country names will be in response. No yes/no yes

Examples

To get the global copyrights in json format:

http://api.tomtom.com/map/1/copyrights.json?key=<apiKey>

To get copyrights in jsonp format for Albuquerque in United States, using tile coordinate parameters:

http://api.tomtom.com/map/1/copyrights/8/48/102.jsonp?key=<apiKey>

To get copyrights in xml format for Albuquerque in United States, using bounding box parameters:

http://api.tomtom.com/map/1/copyrights/-106.8224/34.9246/-106.4008/35.3234.xml?key=<apiKey>

Response

For each request, the Copyrights API returns a file in JSON, JSONP or XML format that contains all copyrights for the specified area, ordered by country code (ISO3). The file contains the copyright applied to all countries (generalCopyrights) and any separate ones for the specific region requested.

Where a map data provider provides copyright information in the form of an image file, it will be returned in base64 format for presentation as an embedded picture.

An example code embedding a base64 picture in the HTML page:

<html><body> <img src="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEA3ADcAAD/(...)//Z" /> </body></html>

Example JSON file:

{
    "formatVersion": "0.0.1",
    "generalCopyrights": [
        "\u00a9 1992 \u2013 2015 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection, database right protection and other intellectual property rights owned by TomTom or its suppliers. The use of this material is subject to the terms of a license agreement. Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.",
        "Data Source \u00a9 2015 TomTom"
    ],
    "regions": [
        {
            "country": {
                "ISO3": "USA",
                "label": "United States"
            },
            "copyrights": [
                "\u00a9 2006 \u2013 2015 TomTom. All rights reserved. Portions of the POI database contained in Premium Points of Interest North America have been provided by Neustar Localeze.",
                "\u00a9 2006 \u2013 2015 TomTom. Truck Attribute Data \u00a9 2004 - 2015 ProMiles Software Development Corporation. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom. The product includes information copied with permission from Canadian authorities, including \u00a9 Canada Post Corporation and Department of Natural Resources Canada, All rights reserved. The use of this material is subject to the terms of a License Agreement. You will be held liable for any unauthorized copying or disclosure of this material. Adapted from Statistics Canada: Boundary Files, 2011 Census; and Census Population and Dwelling Count Highlight Tables, 2011. This does not constitute an endorsement by Statistics Canada of this product.",
                "\u00a9 2015 Pitney Bowes. All rights reserved.",
                "This product contains information and/or data of Telcordia Technologies, Inc. (Telcordia) licensed to be included herein.",
                "Portions of the data have been provided by Clear Channel Broadcasting \u00a9 2015. Clear Channel Broadcasting, Inc. All rights reserved.",
                "\u00a9 United States Postal Service 2015"
            ],
            "copyrightImages": [
                "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEA3ADcAAD/(...)//Z"
            ]
        }
    ]
}

Example JSONP file:

({
   "formatVersion": "0.0.1", 
   "generalCopyrights": [
      "\u00a9 1992 \u2013 2015 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection, database right protection and other intellectual property rights owned by TomTom or its suppliers. The use of this material is subject to the terms of a license agreement. Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.", 
      "Data Source \u00a9 2015 TomTom"
   ], 
   "regions": [
      {
         "copyrightImages": [
            "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEA3ADcAAD/(...)//Z"
         ], 
         "copyrights": [
            "\u00a9 2006 \u2013 2015 TomTom. All rights reserved. Portions of the POI database contained in Premium Points of Interest North America have been provided by Neustar Localeze.", 
            "\u00a9 2006 \u2013 2015 TomTom. Truck Attribute Data \u00a9 2004 - 2015 ProMiles Software Development Corporation. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom. The product includes information copied with permission from Canadian authorities, including \u00a9 Canada Post Corporation and Department of Natural Resources Canada, All rights reserved. The use of this material is subject to the terms of a License Agreement. You will be held liable for any unauthorized copying or disclosure of this material. Adapted from Statistics Canada: Boundary Files, 2011 Census; and Census Population and Dwelling Count Highlight Tables, 2011. This does not constitute an endorsement by Statistics Canada of this product.", 
            "\u00a9 2015 Pitney Bowes. All rights reserved.", 
            "This product contains information and/or data of Telcordia Technologies, Inc. (Telcordia) licensed to be included herein.", 
            "Portions of the data have been provided by Clear Channel Broadcasting \u00a9 2015. Clear Channel Broadcasting, Inc. All rights reserved.", 
            "\u00a9 United States Postal Service 2015"
         ], 
         "country": {
            "ISO3": "USA", 
            "label": "United States"
         }
      }
   ]
});

Example XML file:

<copyrightsResponse xmlns="http://api.tomtom.com/map/1/copyrights" formatVersion="0.0.1">
  <generalCopyrights>
    <copyright>
      © 1992 – 2015 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection, database right protection and other intellectual property rights owned by TomTom or its suppliers. The use of this material is subject to the terms of a license agreement. Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.
    </copyright>
    <copyright>
      Data Source © 2015 TomTom
    </copyright>
  </generalCopyrights>
  <regions>
    <region>
      <country>
        <ISO3>
          USA
        </ISO3>
        <label>
          United States
        </label>
      </country>
      <copyrights>
        <copyright>
          © 2006 – 2015 TomTom. All rights reserved. Portions of the POI database contained in Premium Points of Interest North America have been provided by Neustar Localeze.
        </copyright>
        <copyright>
          © 2006 – 2015 TomTom. Truck Attribute Data © 2004 - 2015 ProMiles Software Development Corporation. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom. The product includes information copied with permission from Canadian authorities, including © Canada Post Corporation and Department of Natural Resources Canada, All rights reserved. The use of this material is subject to the terms of a License Agreement. You will be held liable for any unauthorized copying or disclosure of this material. Adapted from Statistics Canada: Boundary Files, 2011 Census; and Census Population and Dwelling Count Highlight Tables, 2011. This does not constitute an endorsement by Statistics Canada of this product.
        </copyright>
        <copyright>
          © 2015 Pitney Bowes. All rights reserved.
        </copyright>
        <copyright>
          This product contains information and/or data of Telcordia Technologies, Inc. (Telcordia) licensed to be included herein.
        </copyright>
        <copyright>
          Portions of the data have been provided by Clear Channel Broadcasting © 2015. Clear Channel Broadcasting, Inc. All rights reserved.
        </copyright>
        <copyright>
          © United States Postal Service 2015
        </copyright>
      </copyrights>
      <copyrightImages>
        <copyrightImage>
          data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEA3ADcAAD/(...)//Z
        </copyrightImage>
      </copyrightImages>
    </region>
  </regions>
</copyrightsResponse>

Country names and images request

Optionally you can get as a response only a list of countries and images, without their copyright text. To achieve this text=no parameter has to be added to the request.

To get copyrights with only country names and images in jsonp format for Albuquerque in United States, using tile coordinate parameters:

http://api.tomtom.com/map/1/copyrights/8/48/102.jsonp?text=no&key=<apiKey>

Example JSON file:

{
   "formatVersion": "0.0.1", 
   "generalCopyrights": [], 
   "regions": [
      {
         "copyrightImages": [
            "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEA3ADcAAD/(...)//Z"
         ], 
         "country": {
            "ISO3": "USA"
         }
      }
   ]
}

 

Captions request

As an alternative to copyrights for map request, one can receive copyrights for the map service.

To get captions in xml:

http://api.tomtom.com/map/1/copyrights/caption.xml?key=<apiKey>

To get captions in json:

http://api.tomtom.com/map/1/copyrights/caption.json?key=<apiKey> 

To get captions in jsonp:

http://api.tomtom.com/map/1/copyrights/caption.jsonp?key=<apiKey>

Example xml response:

<copyrightsCaptionResponse formatVersion="0.0.1" xmlns="http://api.tomtom.com/map/1/copyrights/caption"><copyrightsCaption>© 1992 - 2016 TomTom.</copyrightsCaption></copyrightsCaptionResponse>

Example json response:

{
   "formatVersion": "0.0.1", 
   "copyrightsCaption": "\u00a9 1992 - 2016 TomTom."
}

Example jsonp response:

({
   "formatVersion": "0.0.1", 
   "copyrightsCaption": "\u00a9 1992 - 2016 TomTom."
});

Http Response Codes

Code Meaning and Possible Causes
200 OK
304 Not Modified
400 Malformed request: malformed syntax. Possible causes include:

  • requested syntax is not available
400 Bad request: Parameters out of range. Possible causes include:

  • zoom n is out of range 0 <= zoom < 19: the requested zoom level is out of the possible range
  • x n is out of range [0,m]: the requested x coordinate is out of the possible range (the value of m will vary depending on zoom level)
  • y n is out of range [0,m]: the requested y coordinate is out of the possible range (the value of m will vary depending on zoom level)
  • minLon n is out of range [-180,180]: the requested minimum longitude coordinate is out of possible range
  • minLat n is out of range [-90,90]: the requested minimum latitude coordinate is out of possible range
  • maxLon n is out of range [-180,180]: the requested maximum longitude coordinate is out of possible range
  • maxLat n is out of range [-90,90]: the requested minimum latitude coordinate is out of possible range
403 Forbidden: Supplied API key is not valid for this request
410 Gone: Request for unsupported format
500 Internal Server Error: There is a problem with the TomTom Copyrights API service

Response Headers

The table below lists HTTP response headers of particular interest to clients of the Maps Copyrights API.

Header Description Values
Access-Control-Allow-Origin The Maps Copyrights API allows cross-origin resource sharing (CORS). *
ETag The Maps Copyrights API provides ETag and supports If-None-Match header. *