Download prepared data

Service version: 1
Last edit: 2019.10.15

Purpose

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

For ease of viewing and identification:

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

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

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.
If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.
The order of Request parameters is not important.

Required parameters
Parameter	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.
Optional parameters
This endpoint does not have any optional parameters.

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

{
  "url": "<string>"
}

The following table describes all of the Response fields.

Primary fields
Field	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.

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.

Get an archive of the historical positions.

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

File download will begin.