Copyrights

Service version: 1
Last edit: 2019.02.22

Purpose

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

Run this endpoint

You can easily run this and other endpoints.

Go to the TomTom API Explorer page.
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.
Review the Response.

Request data

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 the: Zoom Levels and Tile Grid page.
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.

▲ Return to top

Schema

The generic copyrights call schemas are as follows.

Required constants and parameters are shown in bold text.
Optional parameters are shown in plain text.

Whole world

In the following Whole world Request, the format parameter is required.

http|https://baseURL/map/versionNumber/copyrights.format?key=*****

Tile

In the following Tile Request, the zoom, X, and Y parameters are required.

http|https://baseURL/map/versionNumber/copyrights/zoom/X/Y.format?key=*****

Bounding box

In the following Bounding box Request, the minLon, minLat, maxLon, and maxLat parameters are required.

http|https://baseURL/map/versionNumber/copyrights/minLon/minLat/maxLon/maxLat.format?key=*****

HTTPS method: GET

URL format

For ease of viewing and identification:

Required constants and parameters are shown in bold text.
Optional parameters are shown in plain text.

https://baseURL/map/versionNumber/copyrights/minLon/minLat/maxLon/maxLat.format?key=*****

curl command

curl -XGET 'https://baseURL/map/versionNumber/copyrights/minLon/minLat/maxLon/maxLat.format?key=*****'

Request parameters

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

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`.
`key` string	An API Key valid for the requested service. Value: Your valid API Key.
Optional parameters
Parameter	Description
`zoom` integer	Zoom level of the tile to be rendered. Only used for tile-level copyright calls. Value: `0..22`
`X` integer	The X coordinate of the tile on zoom grid. Only used for tile-level copyright calls. Value: `0..2 ^zoom -1`
`Y` integer	The Y coordinate of the tile on zoom grid. Only used for tile-level copyright calls. Value: `0..2 ^zoom -1`
`minLon` float	The minimum longitude coordinate of bounding box in a latitude longitude coordinate system. Only used for bounding box copyright calls. Value: `-180..180`
`minLat` float	The minimum latitude coordinate of bounding box in a latitude longitude coordinate system. Only used for bounding box copyright calls. Value: `-90..90`
`maxLon` float	The maximum longitude coordinate of bounding box in a latitude longitude coordinate system. Only used for bounding box copyright calls. Value: `-180..180`
`maxLat` float	The maximum latitude coordinate of bounding box in a latitude longitude coordinate system. Only used for bounding box copyright calls. Value: `-90..90`
`format` string	Format of the response. Note that this is required when doing a whole world call. Default value: `xml` Other values: `json` `jsonp`
`text` boolean	A boolean to exclude textual data from the Response. Only images and country names will be in the Response. Default value: `yes` Other value: `no`

Examples

To get the global copyrights in JSON format:

https://api.tomtom.com/map/1/copyrights.json?key=*****

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

https://api.tomtom.com/map/1/copyrights/8/48/102.jsonp?key=*****

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

https://api.tomtom.com/map/1/copyrights/-106.8224/34.9246/-106.4008/35.3234.xml?key=*****

▲ Return to top

Response data

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.

The following is 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"
            ]
        }
    ]
}

▲ Return to top

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"
         }
      }
   ]
});

▲ Return to top

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>

▲ Return to top

Country names and images request

Optionally, you can get a Response with only a list of countries and images without their copyright text. To achieve this, the 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=*****

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, you can receive copyrights for the map service.

To get captions in XML:

http://api.tomtom.com/map/1/copyrights/caption.xml?key=*****

To get captions in JSON:

http://api.tomtom.com/map/1/copyrights/caption.json?key=*****

To get captions in JSONP:

http://api.tomtom.com/map/1/copyrights/caption.jsonp?key=*****

XML Response

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

JSON Response

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

JSONP Response

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

▲ Return to top

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 <= 22: 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 the 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 the 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: The 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.

HTTP Response headers

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

▲ Return to top

Copyrights

On this page

Purpose

Run this endpoint

Request data

Schema

Whole world

Tile

Bounding box

HTTPS method: GET

URL format

curl command

Request parameters

Examples

Response data

Example JSON file:

Example JSONP file:

Example XML file:

Country names and images request

Example JSON file:

Captions request

XML Response

JSON Response

JSONP Response

HTTP Response codes

HTTP Response headers