Copyrights

Service version: 2
Last edit: 2022.08.15

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. Go to the TomTom API Explorer page and follow the directions.

Map Copyrights

Request data

HTTPS method: GET

Please see the following Request parameters section with the required parameters table for these values. The generic URL format is as follows.

URL format

The schema for the map copyrights request:

GET
Request URL
https://{baseURL}/map/{versionNumber}/copyrights?key={Your_API_key}

Example

GET
Request example
https://<b>api.tomtom.com/map/2/copyrights?key={Your_API_Key}

curl command format

GET
Request curl command
curl 'https://api.tomtom.com/map/2/copyrights?key={Your_API_Key}'

Request parameters (Map Copyrights)

Required parametersDescription
baseURL
string
The base URL for calling TomTom services.
Value: api.tomtom.com
versionNumber
string
The version of the service to call.
Value: The current version is 2.
key
string
An API Key valid for the requested service.
Value: Your valid API Key.

Response data

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

TEXT
Copyrights in plain text format
1© 1992 - 2022 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection,
2database right protection and other intellectual property rights owned by TomTom or its suppliers.
3The use of this material is subject to the terms of a license agreement.
4Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.
5Data Source © 2022 TomTom,
6based on https://www.tomtom.com/en_gb/thirdpartyproductterms/

Map Service Copyrights

Request data

HTTPS method: GET

Please see the following Request parameters section with the required and optional parameters tables for these values. The generic URL format is as follows.

URL format

The schema for the map service copyrights:

GET
Request URL
https://{baseURL}/map/{versionNumber}/copyrights/caption.json?key={Your_API_Key}

Example

GET
Request URL example
https://api.tomtom.com/map/2/copyrights/caption.json?key={Your_API_Key}

curl command format

GET
Request curl command
curl 'https://{baseURL}/map/{versionNumber}/copyrights/caption.json?key={Your_API_Key}'

Request parameters (Map Service Copyrights)

Required parametersDescription
baseURL
string
The base URL for calling TomTom services.
Value: api.tomtom.com
versionNumber
string
The version of the service to call.
Value: The current version is 2.
key
string
An API Key valid for the requested service.
Value: Your valid API Key.

Response data

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

JSON response example
1{
2 "formatVersion": "0.0.1",
3 "copyrightsCaption": "\u00a9 1992 - 2022 TomTom."
4}

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

FieldDescription
detailedError
object
Main object of the error response.
code
string
One of a server-defined set of error codes.
message
string
A human-readable description of the error code.

Error response example

Error response - JSON format
1{
2 "detailedError" : {
3 "code" : "BAD_REQUEST",
4 "message" : "Bad Request"
5 }
6}
Error response - XML format
1<errorResponse description="Bad Request" errorCode="400" version="1.0.54-mascoma">
2 <detailedError>
3 <code>BAD_REQUEST</code>
4 <message>Bad Request</message>
5 </detailedError>
6</errorResponse>

Response codes

CodeMeaning & possible causes
200OK
304Not Modified: The response has not been modified. This code is returned when the If-None-Match request header is used and its value matches the ETag of the requested copyrights.
400Bad Request: Requested syntax is not available.
403Forbidden: The supplied API Key is not valid for this request.
429Too Many Requests: Too many requests were sent in a given amount of time for the supplied API Key.
500Internal Server Error: There is a problem with the TomTom Copyrights API service.
503Service Unavailable: TomTom Copyrights API service is unable to receive any request.
596Service Not Found: Unknown version of the service.

Response headers

HeaderDescription
Access-Control-Allow-OriginThe Maps Copyrights API allows cross-origin resource sharing (CORS).
Value: *
ETagThe Maps Copyrights API provides ETag and supports the If-None-Match header.
Value: *
Tracking-IDAn identifier for the request. If the Tracking-ID header was specified in the request, it is replicated in the response. Otherwise, it is generated automatically by the service. For details check RFC 4122.
Value: <string>