Developer

Copyrights (Deprecated)

Service version: 1
Last edit: 2023.08.01

Deprecation notice

June 1, 2021


Version 1 of the Copyrights API is deprecated.

  • The Copyrights API v1 will be withdrawn following a 12 month deprecation period.

  • The planned withdrawal date is June 1, 2022.

  • Following withdrawal, requests to the Copyrights API v1 will receive an HTTP 400 error in the response.

  • To see documentation for the new version of the Copyrights API please visit the Copyrights API
    documentation.

Purpose

The Copyrights API is designed to serve copyright information for the Map Display services. 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 formats.

Run this endpoint

You can easily run this and other endpoints. Go to the TomTom API Explorer page and follow the directions.

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.

Schema

The generic copyrights call schemas are as follows.

  • Constants and parameters enclosed in curly brackets { } must be replaced with their values.
  • Please see the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.

Whole world

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

get
Request URL
https://{baseURL}/map/{versionNumber}/copyrights.{format}?key={Your_API_Key}

Tile

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

get
Request URL
https://{baseURL}/map/{versionNumber}/copyrights/{zoom}/{X}/{Y}.{format}?key={Your_API_Key}

Bounding box

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

get
Request URL
https://{baseURL}/map/{versionNumber}/copyrights/{minLon}/{minLat}/{maxLon}/{maxLat}.{format}?key={Your_API_Key}

HTTPS method: GET

  • Constants and parameters enclosed in curly brackets { } must be replaced with their values.
  • Please see the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.

URL format

get
Request URL
https://{baseURL}/map/{versionNumber}/copyrights/{minLon}/{minLat}/{maxLon}/{maxLat}.{format}?key={Your_API_Key}

curl command format

get
Request curl command
curl 'https://{baseURL}/map/{versionNumber}/copyrights/{minLon}/{minLat}/{maxLon}/{maxLat}.{format}?key={Your_API_Key}'

Request parameters

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

Required parameters

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

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.


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:

get
Get global copyrights in JSON
https://api.tomtom.com/map/1/copyrights.json?key={Your_API_Key}

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

get
Get copyrights in JSONP using tile coordinate parameters
https://api.tomtom.com/map/1/copyrights/8/48/102.jsonp?key={Your_API_Key}

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

get
Get copyrights in XML using bounding box parameters
https://api.tomtom.com/map/1/copyrights/-106.8224/34.9246/-106.4008/35.3234.xml?key={Your_API_Key}

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:

Response body - HTML
1<html>
2  <body>
3    <img src="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEA3ADcAAD/(...)//Z" />
4  </body>
5</html>
Example JSON file
1{
2  "formatVersion":"0.0.1",
3  "generalCopyrights":[
4    "\u00a9 1992 \u2013 2019 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.",
5    "Data Source \u00a9 2019 TomTom"
6  ],
7  "regions":[
8    {
9      "copyrights":[
10        "The following copyright notice applies to the use of Points of Interest: \u00A9 2006 \u2013 2018 TomTom. All rights reserved. Portions of the POI database contained in Points of Interest North America have been provided by Neustar Localeze",
11        "The following copyright notice applies to the use of Telecommunications: \u00A9 2017 Pitney Bowes. All rights reserved. In addition, for the following product layers Wire Center Boundaries, ILEC Boundaries, and Rate Center Boundaries, the following also applies: This product contains information and\/or data of Telcordia Technologies, Inc. (Telcordia) licensed to be included herein.",
12        "The following copyright notice applies to the use of TomTom Traffic: Portions of the data have been provided by Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. \u00A9 2017. Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. All rights reserved.",
13        "\u00A9 United States Postal Service 2017",
14        "Contains data made available by the Rhode Island Geographic Information System (RIGIS) consortium, the State of Rhode Island, and the University of Rhode Island. For specifics, please reference: http:\/\/www.rigis.org\/information""Contains Address Points data made available by State of Maryland and MD iMAP. For specifics, please reference: http:\/\/imap.maryland.gov."
15      ],
16      "country":{
17        "ISO3":"USA",
18        "label":"United States"
19      }
20    }
21  ]
22}{
23  "formatVersion":"0.0.1",
24  "generalCopyrights":[
25    "\u00a9 1992 \u2013 2019 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.",
26    "Data Source \u00a9 2019 TomTom"
27  ],
28  "regions":[
29    {
30      "copyrights":[
31        "The following copyright notice applies to the use of Points of Interest: \u00A9 2006 \u2013 2018 TomTom. All rights reserved. Portions of the POI database contained in Points of Interest North America have been provided by Neustar Localeze",
32        "The following copyright notice applies to the use of Telecommunications: \u00A9 2017 Pitney Bowes. All rights reserved. In addition, for the following product layers Wire Center Boundaries, ILEC Boundaries, and Rate Center Boundaries, the following also applies: This product contains information and\/or data of Telcordia Technologies, Inc. (Telcordia) licensed to be included herein.",
33        "The following copyright notice applies to the use of TomTom Traffic: Portions of the data have been provided by Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. \u00A9 2017. Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. All rights reserved.",
34        "\u00A9 United States Postal Service 2017",
35        "Contains data made available by the Rhode Island Geographic Information System (RIGIS) consortium, the State of Rhode Island, and the University of Rhode Island. For specifics, please reference: http:\/\/www.rigis.org\/information""Contains Address Points data made available by State of Maryland and MD iMAP. For specifics, please reference: http:\/\/imap.maryland.gov."
36      ],
37      "country":{
38        "ISO3":"USA",
39        "label":"United States"
40      }
41    }
42  ]
43}
Example JSONP file
1({
2  "formatVersion":"0.0.1",
3  "generalCopyrights":[
4    "\u00a9 1992 \u2013 2019 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.",
5    "Data Source \u00a9 2019 TomTom""based on"
6  ],
7  "regions":[
8    {
9      "copyrights":[
10        "The following copyright notice applies to the use of Points of Interest: \u00A9 2006 \u2013 2018 TomTom. All rights reserved. Portions of the POI database contained in Points of Interest North America have been provided by Neustar Localeze",
11        "The following copyright notice applies to the use of Telecommunications: \u00A9 2017 Pitney Bowes. All rights reserved. In addition, for the following product layers Wire Center Boundaries, ILEC Boundaries, and Rate Center Boundaries, the following also applies: This product contains information and\/or data of Telcordia Technologies, Inc. (Telcordia) licensed to be included herein.",
12        "The following copyright notice applies to the use of TomTom Traffic: Portions of the data have been provided by Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. \u00A9 2017. Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. All rights reserved.",
13        "\u00A9 United States Postal Service 2017",
14        "Contains data made available by the Rhode Island Geographic Information System (RIGIS) consortium, the State of Rhode Island, and the University of Rhode Island. For specifics, please reference: http:\/\/www.rigis.org\/information""Contains Address Points data made available by State of Maryland and MD iMAP. For specifics, please reference: http:\/\/imap.maryland.gov."
15      ],
16      "country":{
17        "ISO3":"USA",
18        "label":"United States"
19      }
20    }
21  ]
22});
Example XML file
1<copyrightsResponse
2	xmlns="http://api.tomtom.com/map/1/copyrights" formatVersion="0.0.1">
3	<generalCopyrights>
4		<copyright>
5          © 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.
6        </copyright>
7		<copyright>
8          Data Source © 2015 TomTom
9        </copyright>
10	</generalCopyrights>
11	<regions>
12		<region>
13			<country>
14				<ISO3>
15              USA
16            </ISO3>
17				<label>
18              United States
19            </label>
20			</country>
21			<copyrights>
22				<copyright>
23              The following copyright notice applies to the use of Points of Interest: © 2006 – 2018 TomTom. All rights reserved. Portions of the POI database contained in Points of Interest North America have been provided by Neustar Localeze
24            </copyright>
25				<copyright>
26              The following copyright notice applies to the use of Telecommunications: © 2017 Pitney Bowes. All rights reserved. In addition, for the following product layers Wire Center Boundaries, ILEC Boundaries, and Rate Center Boundaries, the following also applies: This product contains information and/or data of Telcordia Technologies, Inc. (Telcordia) licensed to be included herein.
27            </copyright>
28				<copyright>
29              The following copyright notice applies to the use of TomTom Traffic: Portions of the data have been provided by Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. © 2017. Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. All rights reserved.
30            </copyright>
31				<copyright>
32              © United States Postal Service 2017
33            </copyright>
34				<copyright>
35              Contains data made available by the Rhode Island Geographic Information System (RIGIS) consortium, the State of Rhode Island, and the University of Rhode Island. For specifics, please reference: http://www.rigis.org/information
36            </copyright>
37				<copyright>
38              Contains Address Points data made available by State of Maryland and MD iMAP. For specifics, please reference: http://imap.maryland.gov.
39            </copyright>
40			</copyrights>
41		</region>
42	</regions>
43</copyrightsResponse>

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:

get
Request URL
http://api.tomtom.com/map/1/copyrights/8/48/102.jsonp?text=no&key={Your_API_Key}

Example JSON file

get
Example - JSON
1{
2  "formatVersion": "0.0.1",
3  "regions": [
4    {
5      "country": {
6        "ISO3": "USA"
7      }
8    }
9  ]
10}

Captions request

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

To get captions in XML:

get
Request URL for captions in XML
http://api.tomtom.com/map/1/copyrights/caption.xml?key={Your_API_Key}

To get captions in JSON:

get
Request URL for captions in JSON
http://api.tomtom.com/map/1/copyrights/caption.json?key={Your_API_Key}

To get captions in JSONP:

get
Request URL for captions in JSONP
http://api.tomtom.com/map/1/copyrights/caption.jsonp?key={Your_API_Key}

Responses

XML response
1<copyrightsCaptionResponse formatVersion="0.0.1" xmlns="http://api.tomtom.com/map/1/copyrights/caption">
2  <copyrightsCaption>©TomTom</copyrightsCaption>
3</copyrightsCaptionResponse>
JSON response
1{
2  "formatVersion": "0.0.1",
3  "copyrightsCaption": "©TomTom"
4}
JSONP response
1({
2  "formatVersion": "0.0.1",
3  "copyrightsCaption": "©TomTom"
4});