Download prepared data

Service version: 1
Last edit: 2022.08.31

Purpose

This endpoint requests a url to download prepared, archived data.

Request data

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 request format

https://{baseURL}/locationHistory/{versionNumber}/download/{token}?key={Your_API_Key}&adminKey={Your_Admin_Key}

curl command request format

curl 'https://{baseURL}/locationHistory/{versionNumber}/download/{token}?key={Your_API_Key}&adminKey={Your_Admin_Key}'

Request parameters

The following table describes the parameters that can be used in a request.

  • Required parameters must be used or the call will fail.
  • Optional parameters may be used.
  • The order of request parameters is not important.

Note: There are no optional parameters in this endpoint.

Required parameters

Description

baseURL


string

The base URL for calling the API.


Value: api.tomtom.com

versionNumber


string

Service version.


Value: 1

key


string

An API Key valid for the requested service.


Value: Your valid API Key.

adminKey


string

An Admin Key valid for the provided API Key.


Value: Your valid Admin Key.

token


string

Token that represents the data to download.


Value: Generated token.

Response data

Response body

The following JSON code block demonstrates a successful response from the API server.

1{
2 "url": "<string>"
3}

Response fields

The following table describes all of the response fields.

Primary fields

Description

url


string

The URL that links to the file which will include all data that should be collected with the provided token.

  • As long as data is collected the URL will respond with a 202 HTTP Code.

  • When the File is prepared the URL will respond with a 200 HTTP Code.

Response codes

Code

Meaning & possible causes

200

OK : Data is ready.

202

Accepted : Data is being collected.

400

Bad request : Token not found.

403

Forbidden:

  • Provided Admin Key is invalid.
  • Admin Key missing.

Example

Get an archive of the historical positions.

URL request example

https://api.tomtom.com/locationHistory/1/download/6ac07430-4874-4dfb-bcbd-36a589972a7f?key={Your_API_Key}&adminKey={Your_Admin_Key}

Response body example

The file download will begin.