Service version: 1
Last edit: 2024.03.15

Purpose

Use this endpoint to check what map versions are available in all Traffic Stats APIs. Map versions should be selected based on Date Range(s) and route(s)/network provided in the create report POST request.

Last 2 years

When analysing last two years of data (this is a moving time window), you can pick any available map version you like. We offer variety map versions released each quarter. For example, when asking for a date range between January and February 2022, you can use the 2022.03 map version. However for best performance we suggest selecting map version according to tables presented in the next section.

Data older than 2 years

If you choose to analyse data older than 2 years, there is only one map version assigned to already map-matched data. For details which map version covers given period, see below.

The following data table shows the supported date ranges and used map versions (does not apply for Japan, for Japan see next table).

Date Range Support

Map Version

2008-01-01 - 2019-01-312016.12
2019-02-01 - 2020-12-312018.12
2021-01-01 - 2021-12-312020.12
2022-01-01 - 2022-12-312021.12
2023-01-01 - 2023-12-312022.12
2024-01-01 - 2024-12-312023.12
......

The following data table shows the supported date ranges and used map versions for Japan.

Date Range Support

Map Version

2020-07-16 - 2022-12-312021.09
2023-01-01 - 2023-12-312022.12
2024-01-01 - 2024-12-312023.12
......

Map versions from tables are using data which are already map-matched what:

  • reduces calculation time,
  • delivers results faster,
  • allows bigger scale analyses,
  • offers stable map version across many months in the same year.

General advice

If you are not sure, which map version should be used, you can skip this parameter in request, and we will pick map version which fits best your request.

Request data

HTTPS method: POST

Constants and parameters enclosed in curly brackets { } must be replaced with their values.

URL format

post
URL request format
https://{baseURL}/traffic/trafficstats/maps/{versionNumber}?key={Your_API_Key}

Required headers

Header

Value

Content-Type

application/json

Request parameters

The following table describes all of the parameters that can be used in a request. Required parameters must be used or the call will fail. Optional parameters may be used.

Required parameters

Description

baseURL
string

Base URL for calling the API.
Value: api.tomtom.com

versionNumber
string

Service version number.
Value: The current value is 1.

key
string

Authorization key for access to the API.
Value: Your valid API Key.

Request POST body example - JSON

post
Request POST body - JSON
1{
2 "geometry": {
3 "type": "Polygon",
4 "coordinates": [
5 [
6 [19.433904442477314, 51.817044485417625],
7 [19.407226981038946, 51.784535147052594],
8 [19.42841202394746, 51.7401001934999],
9 [19.471959056587565, 51.72430675993962],
10 [19.500205780461073, 51.73135374291081],
11 [19.500205780461073, 51.75831652893055],
12 [19.493144099496106, 51.80904062983166],
13 [19.44959706685603, 51.8194696155619],
14 [19.433904442477314, 51.817044485417625]
15 ]
16 ]
17 },
18 "dateRange": {
19 "from": "2022-01-01",
20 "to": "2022-12-31"
21 }
22}

Request POST body parameters - JSON

The following JSON parameters refer to the POST request body.

Required parameters

Description

geometry
object

Geometry of the network which will be used in Area Analysis or Traffic Density job or geometry covering all routes which will be used in Route Analysis job in GeoJSON format.
Values: Supported geometry types are Polygon and MultiPolygon. See RFC 7946.

dateRange
object

Range of dates covering all days which will be used in job.
Values: Object with from and to parameters with values in YYYY-MM-DD format.

Response data

Response example - JSON

Response body - JSON
1{
2 "maps":[
3 "2016.12",
4 "2018.03",
5 "2018.06",
6 "2018.09",
7 "2018.12",
8 "2019.03",
9 "2019.06",
10 "2019.09",
11 "2019.12",
12 "2020.03",
13 "2020.06",
14 "2020.09",
15 "2020.12",
16 "2021.03",
17 "2021.06",
18 "2021.09",
19 "2021.12",
20 "2022.03",
21 "2022.06",
22 "2022.09",
23 "2022.12",
24 "2023.03"
25 ]
26}