Traffic area analytics

Go to TomTom MOVE

Important note Traffic Area Analytics is unavailable on a Freemium or Pay As You Grow (PAYG) basis, because it takes a TomTom MOVE Portal API key, not a Maps API key. A MOVE account comes with a 30-day free trial. Start your trial, or click the Go to TomTom MOVE button above to sign in to an account you already have. Your API key is in the MOVE Portal menu. Read more in the Area Analytics introduction.

trafficAreaAnalytics runs a historical traffic report for a polygon or multi-polygon region. Give it the region, a date range or a list of dates, and the metrics you want. One call returns the aggregates, their time series and per-tile values, without polling.

Introduction

• Any region, from a neighbourhood to a country, as a GeoJSON Polygon or MultiPolygon.
• Any period, as a continuous range of up to 31 days or a list of separate days.
• Several metrics in one call: speed, free-flow speed, congestion level, travel time and network length.
• Aggregates for the whole period, time series from hourly to yearly, and per-tile values that the Traffic Area Analytics Module draws as grids or a heatmap.
• For planners measuring an infrastructure or policy change, consultants benchmarking areas, analysts and researchers reporting on mobility.

Core concepts

You describe a report with:

• geometry - The region, one per call, as a GeoJSON Polygon or MultiPolygon.
• A date selection, one of:
  • startDate and optional endDate - A continuous range.
  • days - A list of dates, consecutive or not.
• metrics - The metrics to compute, or 'all'.
• functionalRoadClasses - The road classes to include, or 'all'.
• hours - The hours of the day in UTC (0–23) to include, or 'all'.

Basic usage

Traffic Area Analytics is a TomTom MOVE Portal product, so it takes a MOVE Portal API key, not the Maps API key the rest of the SDK uses. Keep your Maps key in TomTomConfig and pass the MOVE Portal key per call (per-call overrides):

import { TomTomConfig } from '@tomtom-org/maps-sdk/core';
import { trafficAreaAnalytics } from '@tomtom-org/maps-sdk/services';

TomTomConfig.instance.put({ apiKey: 'YOUR_API_KEY' }); // Maps API key, for everything else

const result = await trafficAreaAnalytics({
    apiKey: 'YOUR_MOVE_PORTAL_KEY', // this service only
    startDate: '2024-08-06',        // YYYY-MM-DD string or Date
    endDate: '2024-08-12',          // optional: defaults to three days ago
    metrics: ['speed', 'congestionLevel'],
    functionalRoadClasses: ['MOTORWAY', 'MAJOR_ROAD', 'OTHER_MAJOR_ROAD', 'SECONDARY_ROAD'],
    hours: [5, 6, 7, 15, 16],       // UTC: Amsterdam's rush hours in summer time (UTC+2)
    geometry: {
        type: 'Polygon',
        coordinates: [
            [[4.896128, 52.382402], [4.875701, 52.368459], [4.923611, 52.36341], [4.896128, 52.382402]],
        ],
    },
});

const region = result.features[0];
console.log(region.properties.baseData.speed);           // km/h
console.log(region.properties.baseData.congestionLevel); // %

If this service returns 401 or 403, the call usually went out with your Maps API key.

Available metrics

areaAnalyticsMetricKeys lists them:

Parameters

Date selection

Give either startDate, with an optional endDate, or days. Both take Date objects or 'YYYY-MM-DD' strings, read as UTC calendar days.

Continuous range (startDate / endDate)

• endDate must be 1 to 31 days after startDate, so equal dates fail validation.
• The latest date the API accepts is two days ago, but it publishes a day 24 to 48 hours after it ends. By default, endDate is three days ago, the latest date that always has data.

// The last week with data: endDate defaults to three days ago
const startDate = new Date();
startDate.setUTCDate(startDate.getUTCDate() - 9);
const lastWeek = await trafficAreaAnalytics({ startDate, /* ... */ });

const firstWeekOfAugust = await trafficAreaAnalytics({ startDate: '2024-08-01', endDate: '2024-08-07', /* ... */ });

Specific dates (days)

All days must be two days ago or earlier.

// Every Monday of August 2024
const result = await trafficAreaAnalytics({
    days: ['2024-08-05', '2024-08-12', '2024-08-19', '2024-08-26'],
    metrics: ['speed', 'congestionLevel'],
    functionalRoadClasses: 'all',
    hours: [7, 8, 9, 17, 18],
    geometry: { /* ... */ },
});

Functional road classes

functionalRoadClasses selects the road classes, or 'all'. The importable functionalRoadClasses catalogue lists them, most important first:

Region geometry

geometry takes one GeoJSON Polygon or MultiPolygon, in [longitude, latitude] order. Each ring must be closed, with equal first and last positions:

const geometry = {
    type: 'MultiPolygon',
    coordinates: [
        [[[4.89, 52.37], [4.91, 52.37], [4.91, 52.39], [4.89, 52.39], [4.89, 52.37]]],
        [[[4.95, 52.40], [4.97, 52.40], [4.97, 52.42], [4.95, 52.42], [4.95, 52.40]]],
    ],
};

A city's boundary comes from geocodeOne and geometryData:

import { geocodeOne, geometryData, trafficAreaAnalytics } from '@tomtom-org/maps-sdk/services';

const place = await geocodeOne('Amsterdam, Netherlands');
const boundaries = await geometryData({ geometries: [place] });

const result = await trafficAreaAnalytics({
    startDate: '2024-08-06',
    endDate: '2024-08-12',
    metrics: ['speed', 'congestionLevel'],
    functionalRoadClasses: 'all',
    hours: [7, 8, 9, 17, 18],
    geometry: boundaries.features[0].geometry,
});

Set name to name the report. Otherwise, the SDK names it.

Response structure

The result is a TrafficAreaAnalytics FeatureCollection with one feature, the submitted region.

Top-level properties

const { startDate, endDate, metrics, frcs, ranges } = result.properties;

• startDate and endDate are the first and last analysed days, as Dates at midnight UTC.
• frcs holds the road classes as the API's numeric indices, 0 (MOTORWAY) to 8 (OTHER_ROAD).
• ranges holds each metric's minimum and maximum over the tiles, such as ranges.congestionLevel.

Feature properties

const region = result.features[0];
const { baseData, timedData, tiledData, anomalies } = region.properties;

Base data

baseData aggregates each requested metric over the whole period. Metrics you didn't request are absent:

const { speed, freeFlowSpeed, congestionLevel, travelTime, networkLength } = region.properties.baseData;

Timed data

timedData breaks the metrics down by granularity. Each has its own entry type, with the metric fields of baseData and its time identifiers always set:

const { daily, hourly, average } = region.properties.timedData;

daily?.forEach((entry) => {
    console.log(entry.date.toISOString().slice(0, 10), entry.speed, entry.congestionLevel);
});

// hourly spans every day of the range, so read the day with the hour
hourly?.forEach((entry) => {
    console.log(`${entry.date.toISOString().slice(0, 10)} ${entry.hour}:00: ${entry.speed} km/h`);
});

average?.forEach((entry) => {
    console.log(`Day ${entry.day}, ${entry.hour}:00: ${entry.congestionLevel}%`);
});

• Which granularities come back depends on the date range and the hours.
• Every time identifier is in UTC, like hours.
• average holds one entry per day of the week and hour with data, Monday first. A range shorter than a week, or an hours filter, gives fewer than 168. Read day and hour, not the index.
• A weekly entry's year is the ISO 8601 year its week counts in. The week from Monday, December 30, 2024, is week 1 of 2025.

Tiled data

tiledData holds per-tile values, if the response has them. Each tile has its tileCentre ([longitude, latitude]) and the requested metrics, where networkLength is the road length within that tile.

region.properties.tiledData?.tiles.forEach((tile) => {
    const [lon, lat] = tile.tileCentre;
    console.log(`Tile at [${lon}, ${lat}]: congestion=${tile.congestionLevel}%`);
});

To draw them, pass the whole response to the Traffic Area Analytics Module.

Anomalies

anomalies maps a metric to its anomalies. Each anomaly is a run of UTC hours, labelled with the public holidays it overlaps. It is currently always empty, because the service detects anomalies only over 35 days or more, beyond a request's 31-day limit.

const speedAnomalies = region.properties.anomalies?.speed ?? [];
speedAnomalies.forEach((anomaly) => {
    console.log(anomaly.startDate, anomaly.endDate, anomaly.labels);
});

Error handling

A failed call rejects with an SDKError whose code says what went wrong. If the API answered with an error, it is an SDKServiceError, which also carries the HTTP status. A request breaking the date rules rejects before it is sent (Error handling).

API reference

• trafficAreaAnalytics
• TrafficAreaAnalyticsParams – Request parameters
• TrafficAreaAnalytics – Response type
• Area Analytics API – API documentation

Related guides and examples

Related examples

• Traffic area analytics NodeJS – Server-side analytics for a geocoded city
• Traffic area analytics – The response drawn as extruded hexagons

Related guides

• Traffic area analytics module – Draw the response on a map
• Traffic incident details – Live incidents of an area
• Geometry data – A place's boundary, for the region