Service version: 2
Last edit: 2021.06.01

On this page

Purpose

The Copyrights API is designed to serve copyright information for the Map Display services. As an alternative to copyrights for map request, you can receive copyrights for the map service called captions.

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.

Map Copyrights

Request data

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.

The schema for the map copyrights request

https://baseURL/map/versionNumber/copyrights?key=API_key

Examples

https://api.tomtom.com/map/2/copyrights?key=Your_API_Key

curl command

curl 'https://api.tomtom.com/map/2/copyrights?key=Your_API_Key'

Request parameters

▲ Return to top

Response data

Map Copyrights

The response body will contain copyrights in a plain text format.

Example

© 1992 - 2021 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 © 2021 TomTom,
based on https://www.tomtom.com/en_gb/thirdpartyproductterms/

▲ Return to top

Map Service Copyrights

Request data

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.

The schema for the map service copyrights

https://baseURL/map/versionNumber/copyrights/caption.json?key=API_key

Examples

https://api.tomtom.com/map/2/copyrights/caption.json?key=API_key

curl command

curl 'https://baseURL/map/versionNumber/copyrights/caption.json?key=API_key'

Request parameters

▲ Return to top

Response data

For the map service copyright request, the response body will contain a copyrights caption in JSON format.

Examples

JSON response

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

▲ Return to top

Error response

The Map Display API Copyrights service for an invalid request returns a response body in XML or JSON format. The XML format is returned by default.
To have an error response returned in JSON format, application/json has to be specified in the Accept HTTP request header.

Error response field structure

Error response example

JSON format

{
  "detailedError" : {
    "code" : "BAD_REQUEST",
    "message" : "Bad Request"
  }
}

XML format

<errorResponse description="Bad Request" errorCode="400" version="1.0.54-mascoma">
  <detailedError>
    <code>BAD_REQUEST</code>
    <message>Bad Request</message>
  </detailedError>
</errorResponse>

▲ Return to top

HTTP response codes

HTTP response headers

▲ Return to top