Intermediate Traffic API - Traffic Incidents – Intermediate Service – DATEX II

Last edit: 2024.05.31
TomTom Orbis Maps

Important notes:


The TomTom Traffic Incidents - Intermediate Service – DATEX II (hereafter called ‘Service’) is based on DATEX II v1.0. DATEX II is a standard for information exchange between traffic control centers, service providers, and application developers.

The Service provides the latest real-time information about traffic incidents, their causes and impacts on travelers. Typical traffic incidents include accidents, road construction projects, traffic jams, travel weather warnings, road closures, and any other road-related situation that could potentially cause a delay.

In this document, we discuss how to access the service and the features that are included.


TomTom only supports the Intermediate Service with the use of the TomTom customized DATEX II schema, available for download from our website (linked previously and later in this document). Using the Service with the standard DATEX II schema will disable the functionality that is included with the Service. Therefore, the standard DATEX II schema is not supported.


This document gives basic information on the Service and shows how to configure it to work with your environment. The fields are described in two sets of tables. One that defines them in a logical way, and the other describes in detail how they are represented in DATEX II format. Basic knowledge of installing and using XML-based schemas is necessary.

Intended audience

This information is intended to be used by TomTom partners and customers (decision makers and developers).


TomTom offers traffic incident data to customers. In the basic configuration, TomTom provides customers information on traffic congestion and other roadwork-related traffic events.

Each traffic incident is represented in a DATEX II event, and we add an Alert-C event code with the same meaning. This Alert-C event code allows the user to customize the content at their own discretion. This information is organized by country-based datasets. The product is static. This means that the included regions and features are fixed once the product is configured. Products are customer-specific.

Detailed information about the default enabled features and their representation in DATEX II can be found in the section Default enabled information.

The Service provides users traffic incident data with a highly customizable optional configuration, in addition to the features enabled by default. The section Optionally activatable features provides detailed information about these configurations and their representation ub DATEX II.

Request data

The Service uses RESTful API (Representation State Transfer) technology. Since you only need to use one URL, the service is relatively uncomplicated to use.

'Simple HTTP server' profile

The interface supports the client pull method, also known as the simple HTTP server profile. The profile is described in the Software Developers Guide and Exchange Platform Specific Model (see the DATEX II payload specification for the links to the documents). TomTom does not support the SOAP envelope as described in the Software Developers Guide.


To use this service, ensure that all prerequisites are met as described in the section, A secure connection or at Authentication for client certificate access.

How do you make a request?

To make a request, the URL should be constructed as shown in the following sections.


For ease of viewing and identification:

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

The sample URL is formatted as follows:

URL request format

The following is an example URL:

URL request example{Your_API_Key}/content.xml

Request parameters

The following table provides a detailed explanation of the available fields that were previously shown in the HTTPS Method: GET section.

Required parameters




Base URL for calling the API.




Name of the product (feed) you are requesting. These will be indicated to you as part of the provisioning process. Typically, it explains the country (country code), and the location referencing method (see Location or Identifier-based location referencing using OSM way IDs).




Authorization key for access to the API.

Value: Your valid API Key.

Request headers

Since incident feeds can be very large, TomTom recommends optimizing the information transmission as much as possible. By doing this, the client receives more up-to-date information.




TomTom recommends using the standard HTTP header If-Modified-Since with the last value of Last-Modified received. When this header is used properly, you avoid unnecessarily downloading identical content. For details, see the HTTP/1.1 standard (RFC2616 section 14.25).

Value: Example: Wed, 21 Oct 2015 07:28:00 GMT


The TomTom Traffic Incidents bulk feed supports gzip compression of all response types. However, responses are compressed only when the requester states gzip support. This should be specified through the standard HTTP header Accept-Encoding. TomTom recommends using this header type as it significantly reduces the payload size.

Value: gzip

Response data

Response example

This is a response you receive after a request is made. If you make the following request:

URL request example{Your_API_Key}/content.xml

You can expect the following response:

Response example - XML
1<?xml version="1.0" encoding="UTF-8"?>
2<d2LogicalModel xmlns="" modelBaseVersion="1.0">
3 <exchange>
4 <supplierIdentification>
5 <country>nl</country>
6 <nationalIdentifier>TomTom Traffic Service</nationalIdentifier>
7 </supplierIdentification>
8 </exchange>
9 <payloadPublication xmlns:xsi="" xsi:type="SituationPublication" lang="en">
10 <publicationTime>2023-10-10T12:44:30Z</publicationTime>
11 <publicationCreator>
12 <country>other</country>
13 <nationalIdentifier>71553ccb-728e-4ee3-9717-4afd308ce0f3</nationalIdentifier>
14 </publicationCreator>
15 <situation id="TTI-71553ccb-728e-4ee3-9717-4afd308ce0f3-TTL25838637712020000">
16 <headerInformation>
17 <confidentiality>internalUse</confidentiality>
18 <informationStatus>real</informationStatus>
19 <urgency>urgent</urgency>
20 </headerInformation>
21 <situationRecord xmlns:xsi="" xsi:type="AbnormalTraffic" id="TTI-71553ccb-728e-4ee3-9717-4afd308ce0f3-TTL25838637712020000-1">
22 <situationRecordCreationTime>2023-10-10T12:44:13Z</situationRecordCreationTime>
23 <situationRecordVersion>7</situationRecordVersion>
24 <situationRecordVersionTime>2023-10-10T12:44:30Z</situationRecordVersionTime>
25 <situationRecordFirstSupplierVersionTime>2023-10-10T12:44:30Z</situationRecordFirstSupplierVersionTime>
26 <probabilityOfOccurrence>certain</probabilityOfOccurrence>
27 <validity>
28 <validityStatus>definedByValidityTimeSpec</validityStatus>
29 <validityTimeSpecification>
30 <overallStartTime>2023-10-10T12:44:13Z</overallStartTime>
31 </validityTimeSpecification>
32 </validity>
33 <impact>
34 <delays>
35 <delayTimeValue>131.0</delayTimeValue>
36 </delays>
37 </impact>
38 <groupOfLocations>
39 <locationContainedInGroup xsi:type="Linear">
40 <locationExtension>
41 <openlr>
42 <binary version="3">C81gjx4aeyOABwEMAWEjEw==</binary>
43 </openlr>
44 </locationExtension>
45 </locationContainedInGroup>
46 </groupOfLocations>
47 <situationRecordExtension>
48 <alertCEventCode>108</alertCEventCode>
49 </situationRecordExtension>
50 <abnormalTrafficType>queueingTraffic</abnormalTrafficType>
51 <abnormalTrafficExtension>
52 <averageSpeed>9.1</averageSpeed>
53 </abnormalTrafficExtension>
54 </situationRecord>
55 </situation>
59 </payloadPublication>

Response – DATEX II payload specification (analysis of the received output)

The payload in the output is formatted as DATEX II, which is a European standard for the exchange of Traffic and Travel Information. TomTom supports version 1. Recommended documents are:

The Elaborated Data Publication, used by TomTom, is described in more detail in section 4.11 of the DATEX II User Guide version 1.0.

Important: XSD schema

TomTom extended the data model with additional fields; the full XSD schema including extensions can be downloaded by clicking this Level B extension. It is a "Level B" extension of the standard XML schema: DATEXIISchema_1_0_1_0.xsd. Such an extension is interoperable with the "Level A" data model (see section 2.2.3 in the DATEX II User Guide version 1.0 for more information).

How the data is organized

Situation publication

The traffic information is provided as a SituationPublication. A SituationPublication is the snapshot of the latest traffic data. A SituationPublication can contain several different situations.

The service does not support a delta mechanism. Therefore, incremental updates are not possible.


A situation represents a traffic or travel incident comprising one or more traffic or travel circumstances. These are linked by one or more causal relationships and apply to related locations. Each traffic or travel circumstance is represented by a SituationRecord.

Situation record

A SituationRecord is one element of a situation. It is characterized by values at a given time, defining one version of this element. When these values change, a new version is created. One SituationRecord can be:

  • a road or traffic related event (traffic element)
  • an operator action
  • a piece of information that is based on a non-road event

and can contain:

  • an advisory
  • details that impact the estimated time of arrival

Unique identifier

Each Situation has a unique identifier. Additionally, every SituationRecord also has a unique identifier. This identifier is established when the Situation or SituationRecord is first created in the DATEX II system database. As long as the situation exists, this identifier will always be present within the system. The unique identifier has a fixed prefix "TT", followed by a string. No further assumptions should be made about the identifier.

The identifier is unique across all supported countries.


If the current delay is available for a SituationRecord, the delayTimeValue is provided in the Impact. If there is information about closed lanes, because of an accident or other incident, it can be populated in ImpactDetails.

In some cases, there are multiple SituationRecords that are related to each other. For instance, there can be a traffic jam that is caused by an accident. If the locations of these SituationRecords overlap or are connected AND they occur in the same direction, then the SituationRecords are contained in the same Situation. In that case, a single Situation contains more than one SituationRecord.

Sometimes, it is possible that two SituationRecords are related to each other, but do not overlap. For instance, one SituationRecord contains a diversion advice, located at a highway intersection. Since the road is blocked farther along the segment, that is described in a different SituationRecord. In that case, the SituationPublication does not contain a reference from one SituationRecord to the other.

For the first example, consider combining the information from the SituationRecords in your end application to let the end-user know there is a delay due to an accident. In the second example, there is a diversion due to a road closure.

Default enabled information

The DATEX II data model has been extended to allow additional parameters. Some of these extensions are needed for the standard feed information and are explained in the following sections.

Validity period


validity (SituationRecord)


Specifies the validity of a SituationRecord. The validity status and the start time of the event as part of the validity time specification are provided. A SituationRecord has a validity period that is comprised of:

  • a mandatory validityStatus,

  • a mandatory overallStartTime, which indicates the start of the SituationRecord, if it is in the past, or an expected start date, if it is in the future.

The Incident end time and Future incidents are optional features and not part of the standard information.

1<situationRecord [...]>
2 [...]
3 <validity>
4 <validityStatus>active</validityStatus>
5 <validityTimeSpecification>
6 <overallStartTime>2022-10-10T08:00:00Z</overallStartTime>
7 </validityTimeSpecification>
8 </validity>
9 [...]



groupOfLocations (SituationRecord)


Every SituationRecord contains a groupOfLocations, which describes the involved location. The Location is defined in section 4.16 of the DATEX II User Guide. OpenLR (binary version 3) are the location referencing methods supported by the Service.

OpenLR (see is a dynamic location referencing method that allows referencing of any road on the complete digital map. Because of its flexibility, it is possible to describe traffic events on high-level and lower-level road classes. The method is available free of charge. The service uses binary format version 3, as described in the OpenLR whitepaper. The whitepaper, software developer kit, and open source reference implementations are available for download from the OpenLR website. TomTom offers support for third parties to implement and test their own implementations.

2 <locationContainedInGroup xsi:type="Linear">
3 <locationExtension>
4 <openlr>
5 <binary version="3">CwkmCSJZIRtmJQiDBE4bEg==</binary>
6 </openlr>
7 </locationExtension>
8 </locationContainedInGroup>

See section Identifier-based location referencing using OSM way IDs for a location referencing specific for OSM maps.

Average speed for jams


averageSpeed (AbnormalTrafficExtensionType)

Description:The average speed for congestion events, in km/h.
1<situationRecord xsi:type="AbnormalTraffic" [...]>
2 [...]
3 <abnormalTrafficExtension>
4 <averageSpeed>18.0</averageSpeed>
5 </abnormalTrafficExtension>

Delay for jams


impact (SituationRecord)


The impact provides information on the delay of congestion events in seconds. Delay information for journalistic events is offered as part of the optional feature Average speed for journalistic events.

1<situationRecord xsi:type="AbnormalTraffic" [...]>
2 [...]
3 <impact>
4 <delays>
5 <delayTimeValue>64.0</delayTimeValue>
6 </delays>
7 </impact>
8 [...]

Alert-C event codes


alertCEventCode (SituationRecordExtensionType)


The Alert-C event code describing the SituationRecord. There can be zero or more codes. It is highly recommended to use alertCEventCode to classify the incident and map it to a list of categories that are to be supported (e.g., traffic jams, road closures, road works, lane closures, accidents, etc.)

1<situationRecord [...]>
2 [...]
3 <situationRecordExtension>
4 <alertCEventCode>115</alertCEventCode>
5 </situationRecordExtension>

Refer to ISO TS 14819-2 at for Alert-C codes and conventions.

Language specific texts


generalPublicComment (SituationRecord)


A SituationRecord may contain language-specific text. For example, this can be a diversion advice, provided by the network manager, or some other free text. Typically, this text is available only in the language of the country. The information is reported as a (list of) generalPublicComment element(s).

1<situationRecord [...]>
2 [...]
3 <generalPublicComment>
4 <comment>
5 <value lang="en">The pass is free in both directions.</value>
6 <comment>
7 </generalPublicComment>

Probability of occurrence


probabilityOfOccurrence (SituationRecord)


The semantics of this field are deprecated and will be removed in the future. Do not use. The reason why this attribute is used at all is that in DATEX II v1.0 it is a mandatory field.

1<situationRecord [...]>
2 [...]
3 <probabilityOfOccurrence>probable</probabilityOfOccurrence>
4 [...]

Optionally activatable features

The DATEX II data model has been extended to allow additional parameters. The Service has the following possible extensions.

Identifier-based location referencing using OSM way IDs


idlr (LocationExtensionType)


Identifier-based location referencing OSM way IDs (hereafter called 'IDLR-OSM') is offered as an alternative method of location referencing besides OpenLR.

The IDLR-OSM is identified by the value osm for the attribute method.

The ID list can contain a list of OSM way IDs in the format [D + wayid + [# + start_offset] + [# + end_offset]] ... where:

  • D: The OSM way ID direction (required). It can take two different values:
    • F: Forward direction.
    • R: Reverse / Backwards direction.
  • wayid: The OSM way ID. (required)
  • #: The offset separator. (required if offsets are used)
    • start_offset: The start-offset in meters on the OSM way ID. (optional)
    • end_offset: The end-offset in meters on the OSM way ID. (optional) When the end-offset is provided, a start-offset needs to be provided, too.

The following example shows a locationExtension element with an IDLR-OSM in the idlr element indicated by the attribute method=osm that is composed of three OSM way IDs. All IDs use the forward direction, the first ID uses a start-offset, the second doesn't have offsets, and the third uses an end-offset. Since the end-offset is the second offset in the list of offsets, it always requires an explicit mention of the start-offset with 0 meters if the ID does not use a start-offset. The affected location is the concatenation of all IDs minus the offset information.

Example of a locationExtension providing OpenLR and IDLR
1<situation [...]>
2 <situationRecord [...]>
3 [...]
4 <groupOfLocations>
5 <locationContainedInGroup xsi:type="Linear">
6 <locationExtension>
7 <openlr>
8 <binary version="3">[...]</binary>
9 </openlr>
10 <idlr method="OSM">"F491249694#300 F568042661 F116413004#0#203"</idlr>
11 </locationExtension>
12 </locationContainedInGroup>
13 </groupOfLocations>
14 [...]
15 </situationRecord>

Incident end time


overallEndTime (OverallPeriod)


This option predicts the expected ending time for the traffic incident such as the expected end time of a jam or a closure.

This field is expressed as a UTC time (e.g., 14:22 UTC). These end times may be created by TomTom or originate from local road authorities (for journalistic events).

1<situationRecord [...]>
2 [...]
3 <validity>
4 <validityStatus>definedByValidityTimeSpec</validityStatus>
5 <validityTimeSpecification>
6 <overallStartTime>2023-10-10T08:00:00Z</overallStartTime>
7 <overallEndTime>2023-11-13T00:00:00Z</overallEndTime>
8 </validityTimeSpecification>
9 </validity>
10 [...]

Jam tendency


trafficTrendType (AbnormalTraffic)


This feature indicates whether a jam is improving, remaining stable, or becoming worse.

The feature is supported for the situation record type AbnormalTraffic. The following values may be present:

  • trafficBuildingUp
  • trafficEasing
  • trafficStable
  • unknown
1<situationRecord [...] xsi:type="AbnormalTraffic" [...]>
2 [...]
3 <trafficTrendType>trafficBuildingUp</trafficTrendType>
4 [...]

poorEnvironmentType (PoorEnvironmentConditions)


This feature reports messages for road segments that could be impacted by severe weather.

Snow or heavy rain conditions use suitable Alert-C event codes and DATEX II classifications. The following Alert-C event codes and weather conditions are used:

  • Alert-C event code 1101 (snow), poor environment condition heavySnowfall
  • Alert-C event code 1106 (hail), poor environment condition hail
  • Alert-C event code 1107 (sleet), poor environment condition sleet
  • Alert-C event code 1109 (heavy rain), poor environment condition heavyRain

Jam ahead warnings

  • openlr (LocationExtensionType)

  • averageSpeed (AbnormalTrafficExtensionType)


Selecting this option generates special warning messages when a location registers high-speed differences. Specifically, when the tail end of the jam is projected to intercept oncoming traffic, creating a potentially dangerous situation. The user can enable messages for only jam-ahead warnings or have them delivered next to all regular messages.

An OpenLR point along line reference is used for this message. The jam ahead warning is recognized by a locationContainedInGroup with type Point in combination with the presence of an averageSpeed.

1<situationRecord [...] xsi:type="AbnormalTraffic" [...]>
2 [...]
3 <groupOfLocations>
4 <locationContainedInGroup xsi:type="Point">
5 <locationExtension>
6 <openlr>
7 <binary version="3">KwchAiYFHQEfGf8LBSABUEc=</binary>
8 </openlr>
9 </locationExtension>
10 </locationContainedInGroup>
11 </groupOfLocations>
12 [...]
13 <abnormalTrafficExtension>
14 <averageSpeed>29.0</averageSpeed>
15 </abnormalTrafficExtension>

Average speed for journalistic events

  • averageSpeed (AccidentExtensionType , ConditionsExtensionType, EnvironmentalObstructionExtensionType, EquipmentDamageObstructionExtensionType, GeneralObstructionExtensionType, OperatorActionExtensionType, PoorRoadInfraStructureExtensionType)

  • impact (SituationRecord)


Selecting this option adds the average speed values for journalistic messages (for example, road works, or lane restrictions). This is the average speed as measured by TomTom.

We created DATEX II extensions for each journalistic event type that supports speeds (also see Fields above). In addition to the speed information the delay is indicated as part of the impact.

Example: A GeneralObstruction element with an averageSpeed
1<situationRecord [...] xsi:type="GeneralObstruction" [...]>
2 [...]
3 <impact>
4 <delays>
5 <delayTimeValue>34.0</delayTimeValue>
6 </delays>
7 </impact>
8 [...]
9 <generalObstructionExtension>
10 <averageSpeed>59.6</averageSpeed>
11 </generalObstructionExtension>

All other extension types listed under Field work the same way as GeneralObstruction.

Turn-dependent jams


conditionalOffset (SituationRecordExtensionType)


Selecting this option provides the user with turn-dependent jams information. The user receives messages when a portion of the jam is projected to affect travel only if following in the direction of the jam. Common use cases include: congestion on exit ramps, entry ramps, turn-lanes, and so on.

To find the actual affected location, the (conditional) offset must be applied from the end of the location.

1<situationRecord [...]>
4 <alertCEventCode>115</alertCEventCode>
5 <conditionalOffset>151</conditionalOffset>

HOV jams


lanes (SupplementaryPositionalDescription)


Selecting this option provides the user with high-occupancy vehicle (HOV) jams information. This feature is only available in combination with the location referencing method OpenLR. The lanes indicator carPoolLanes identifies HOV lanes.

1<situationRecord [...]>
2 [...]
3 <groupOfLocations>
4 <locationContainedInGroup xsi:type="Linear">
5 <locationExtension>
6 <openlr>
7 <binary version="3">KwSSoyRHmAEVCP18/zsBRds=</binary>
8 </openlr>
9 </locationExtension>
10 <supplementaryPositionalDescription>
11 <lanes>carPoolLane</lanes>
12 </supplementaryPositionalDescription>
13 </locationContainedInGroup>
14 </groupOfLocations>
15 [...]

Incident node name

  • fromNodeName (LocationExtensionType)
  • toNodeName (LocationExtensionType)

Selecting this option provides node names for cross-streets at the beginning and end of the road segment.

1<situationRecord [...]>
2 [...]
3 <groupOfLocations>
4 <locationContainedInGroup xsi:type="Linear">
5 <locationExtension>
6 [...]
7 <fromNodeName>
8 <name>Globe St/S Main St (Broadway St/MA-138)</name>
9 </fromNodeName>
10 <toNodeName>
11 <name>I-195 (Broadway St/MA-138)</name>
12 </toNodeName>
13 [...]
14 </locationExtension>
15 </locationContainedInGroup>
16 </groupOfLocations>
17 [...]

Road number


roadNumber (LocationExtensionType)


Selecting this option provides the road identifier or road number of the affected location.

Example: Road number of the German freeway (Autobahn) A3
1<situationRecord [...]>
2 [...]
3 <groupOfLocations>
4 <locationContainedInGroup xsi:type="Linear">
5 <locationExtension>
6 [...]
7 <roadNumber>A3</roadNumber>
8 </locationExtension>
9 </locationContainedInGroup>
10 </groupOfLocations>
11 [...]

Future incidents

  • overallStartTime (OverallPeriod)

  • validityStatus (Validity)


Selecting this option includes incidents whose start time is in the future (for example, planned roadworks, or road closures). The field is expressed as a UTC time (e.g., 14:22 UTC). The start time of future incidents is after the publication time. The validityStatus of the message is set to suspended.

1<?xml version="1.0" ?>
3 xmlns=""
4 modelBaseVersion="1.0">
5 [...]
6 <payloadPublication
7 xmlns:xsi=""
8 xsi:type="SituationPublication" lang="en">
9 <!-- time when snapshot was created -->
10 <publicationTime>2023-10-10T00:00:00Z</publicationTime>
11 <situation [...]>
12 <situationRecord [...]>
13 [...]
14 <validity>
15 <validityStatus>suspended</validityStatus>
16 <validityTimeSpecification>
17 <!-- start time of the incident -->
18 <overallStartTime>2023-10-15T00:00:00Z</overallStartTime>
19 </validityTimeSpecification>
20 </validity>
21 [...]
22 </situationRecord>
23 </situation>
24 </payloadPublication>

Map version


mapVersion (PayloadPublicationExtensionType)


This option provides the names and versions of the maps that were used to create the content.

1<?xml version="1.0" encoding="UTF-8"?>
2<d2LogicalModel xmlns="" modelBaseVersion="1.0">
3 [...]
4 <payloadPublication
5 xmlns:xsi=""
6 xsi:type="SituationPublication" lang="en">
7 [...]
8 <payloadPublicationExtension>
9 <mapVersion>nam2023.06.060</mapVersion>
10 </payloadPublicationExtension>
11 <!-- list of situation elements follows -->
12 [...]
13 </payloadPublication>