Developer

Copyrights

Service version: 1
Last edit: 2024.11.18
TomTom Orbis Maps

Important notes:

Purpose

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

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}/maps/orbis/copyrights?key={Your_API_Key}

Example

get
Request example
https://api.tomtom.com/maps/orbis/copyrights?key={Your_API_Key}

curl command format

get
Request curl command
curl 'https://{baseURL}/maps/orbis/copyrights?apiVersion=1&key={Your_API_Key}'

Request parameters (Map Copyrights)

Required parametersDescription

baseURL
string

The base URL for calling TomTom services. Value: api.tomtom.com

key
string

An API Key valid for the requested service. Value: Your valid API Key.

Optional parametersDescription

apiVersion
integer

A version of the api to call. If the parameter is set it will overwrite the value stored in TomTom-Api-Version header. Value: The current version is 1.

HTTP request headers (Map Copyrights)

Required headersDescription

TomTom-Api-Version
integer

Contains a version of the API to call. Value: The current version is 1.

Response data

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

text
Copyrights in plain text format
1© OpenStreetMap contributors. This data is licensed under the terms of the Open Database License (ODbL) available at https://opendatacommons.org/licenses/odbl/1-0/. More information can be found here: https://www.openstreetmap.org/copyright/en. To the extent that you create a browsable electronic map using this product, you are further required to comply with the provisions of https://www.openstreetmap.org/copyright/en
2

3© 1992 - 2023 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.
4

5Data Source © 2023 TomTom
6

7Based 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.

The schema for the map service copyrights:

get
Request URL
https://{baseURL}/maps/orbis/copyrights/caption.json?key={Your_API_Key}

Example

get
Request URL example
https://api.tomtom.com/maps/orbis/copyrights/caption.json?key={Your_API_Key}

curl command format

get
Request curl command
curl 'https://{baseURL}/maps/orbis/copyrights/caption.json?apiVersion=1&key={Your_API_Key}'

Request parameters (Map Service Copyrights)

Required parametersDescription

baseURL
string

The base URL for calling TomTom services. Value: api.tomtom.com

key
string

An API Key valid for the requested service. Value: Your valid API Key.

Optional parametersDescription

apiVersion
integer

A version of the api to call. If the parameter is set, it will overwrite the value stored in TomTom-Api-Version header. Value: The current version is 1.

HTTP request headers (Map Service Copyrights)

Required headersDescription
TomTom-Api-Version

Contains a version of the API to call. Value: The current version is 1.

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": "©TomTom, ©OpenStreetMap"
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
200

OK

304

Not 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.

400

Bad Request: Requested syntax is not available.

403

Forbidden: The supplied API Key is not valid for this request.

429

Too Many Requests: Too many requests were sent in a given amount of time for the supplied API Key.

500

Internal Server Error: There is a problem with the TomTom Copyrights API service.

503

Service Unavailable: TomTom Copyrights API service is unable to receive any request.

596

Service Not Found: Unknown version of the service.

Response headers

HeaderDescription
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: *

Tracking-ID

An 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>