Incident Details

The base URL for calling the API.
Values:

• api.tomtom.com: The default global API endpoint.

• kr-api.tomtom.com: The region-specific endpoint for South Korea. See the region-specific content documentation.

The service version number.
Value: The current value is 5.

The corners of the area to report on, expressed in the EPSG:4326 projection. These are two longitude-latitude pairs describing the corners of the bounding box. The first pair is for the lower-left corner and the second pair for the upper-right corner. All values should be separated by a comma. The maximum area of a bounding box is 10,000 km ².

• This parameter is mutually exclusive with the ids parameter.

• This parameter is available only for GET requests.

Values: minLon,minLat,maxLon,maxLat

Comma separated list of incidents IDs. The maximum number of incidents IDs is 5 for GET requests.

• This parameter is mutually exclusive with the bbox parameter.

• This parameter is available only for GET requests.

Values: comma separated string

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

The fields to be included in the response, nested as in the response schema. In order to obtain all data, it is necessary to place the whole object in the query.

1{
2  incidents
3    {
4      type,
5      geometry{
6        type,coordinates
7      },
8      properties{
9        iconCategory
10      }
11    }
12}

1{
2  incidents{
3    type,
4    geometry{
5      type,
6      coordinates
7    },
8    properties{
9      id,
10      iconCategory,
11      magnitudeOfDelay,
12      events{
13        description,
14        code,
15        iconCategory
16      },
17      startTime,
18      endTime,
19      from,
20      to,
21      length,
22      delay,
23      roadNumbers,
24      timeValidity,
25      probabilityOfOccurrence,
26      numberOfReports,
27      lastReportTime
28      tmc{
29        countryCode,
30        tableNumber,
31        tableVersion,
32        direction,
33        points{
34          location,
35          offset
36        }
37      }
38    }
39  }
40}

The language code for the output language. Affects the description fields in the response. When an incident description does not have a translation, an English description is returned.
Default value: en-GB
Allowed values:

• ar

• ca-ES

• cs-CZ

• da-DK

• de-DE

• el-GR

• en-GB

• en-US

• es-ES

• et-EE

• fi-FI

• fr-FR

• he-IL

• hu-HU

• id-ID

• it-IT

• ko-KR

• lt-LT

• lv-LV

• nb-NO

• nl-NL

• pl-PL

• pt-PT

• ro-RO

• ru-RU

• sk-SK

• sv-SE

• th-TH

• tr-TR

• zh-TW

The Traffic Model ID is the reference value for the state of traffic at a particular time. It is updated every minute, and is valid for two minutes before it times out. See the HTTP response headers section and Traffic Model ID page for more information.
Default value: current Traffic Model ID
Allowed value: Traffic_Model_ID

This filter allows the choice of types of incidents and future incidents to be included in the response. Filtering takes into account the main icon category of the incident. Both value types can be used: numeric and descriptive strings. Multiple values are supported and should be separated by a comma.
Default values: 0,1,2,3,4,5,6,7,8,9,10,11,14
Allowed values:

• 0: Unknown

• 1: Accident

• 2: Fog

• 3: DangerousConditions

• 4: Rain

• 5: Ice

• 6: Jam

• 7: LaneClosed

• 8: RoadClosed

• 9: RoadWorks

• 10: Wind

• 11: Flooding

• 14: BrokenDownVehicle

This filter allows the choice of incidents based on their occurrence in time. Multiple values are supported and they should be separated by a comma.
Default value: present
Allowed values:

• present

• future

Contains the content encoding (usually a compression algorithm), that the client is able to understand. It is strongly recommended using this header in order to limit bandwidth usage.
Value: gzip

Specifies an identifier for the request. It can be used to trace a call. The value must match the regular expression '^[a-zA-Z0-9-]{1,100}$'. An example of the format that matches this regular expression is a UUID (e.g., 9ac68072-c7a4-11e8-a8d5-f2801f1b9fd1 ). For details check RFC 4122. If specified, it is replicated in the Tracking-ID response header. It is only meant to be used for support and does not involve tracking of you or your users in any form.
Value: <string>

The value is set as Feature ( GeoJSON feature object).

A GeoJSON feature of type Point or Linestring (depending on the incident). It always contains the type and coordinates fields.

The ID of the traffic incident, common among Traffic Incident API services where it is available.

The main icon category associated with this incident. This is an icon category associated with the first event in the events list describing the incident. The values meaning:

• 0: Unknown

• 1: Accident

• 2: Fog

• 3: Dangerous Conditions

• 4: Rain

• 5: Ice

• 6: Jam

• 7: Lane Closed

• 8: Road Closed

• 9: Road Works

• 10: Wind

• 11: Flooding

• 14: Broken Down Vehicle

The magnitude of delay associated with an incident. The values meaning:

• 0: Unknown

• 1: Minor

• 2: Moderate

• 3: Major

• 4: Undefined (used for road closures and other indefinite delays)

The list of events describing the details of the incident in the language requested. Traffic incident can be described with more than one Event object.

Start time of the incident, if available. The date is described in the ISO8601 format.

End time of the incident, if available. The date is described in the ISO8601 format.

The name of the location where the traffic due to the incident starts.

The name of the location where the traffic due to the incident ends.

The delay in seconds caused by the incident (except road closures). It is calculated against free-flow travel time (the travel time when the traffic is minimal, e.g., night traffic).

Enumeration string describing if the incident occurrence is now or in the future.

TMC (Traffic Message Channel) data of the traffic incident, needed to determine its location.

Enumeration string specifying the likelihood of the occurring incident.
Allowed values:

• certain

• probable

• risk_of

• improbable

The date in ISO8601 format, when the last time the incident was reported. Gives the user confidence that the incident is fresh.

The description of the event (being part of incident) in the requested language.

The predefined alert code, describing the event (part of incident).

The icon category associated with the event. The icon category from the first event in the list is replicated in the iconCategory field in the IncidentProperties object.

Enumeration string specifying the likelihood of the occurring incident.
Allowed values:

• certain

• probable

• risk_of

• improbable

The date in ISO8601 format, when the last time the incident was reported. Gives the user confidence that the incident is fresh.

OK

Bad request, usually due to a malformed syntax or incorrect format of the Traffic Model ID.

Forbidden: The supplied API Key is not valid for this request.

Method Not Allowed: The provided HTTP request method is known by the server, but is not supported by the target resource.

Too Many Requests: Too many requests were sent in a given amount of time for the supplied API Key.

Internal Server Error

Indicates that cross-origin resource sharing (CORS) is allowed.
Value: *

Lists the set of supported HTTP methods. The header is sent in case a 405 HTTP response code is returned.
Value: GET, POST, HEAD

Indicates which encodings were applied to the response body.
Value: gzip

Contains information about the size of the response body.
Value: <decimal number>

Indicates the media type of the resource returned.
Value: <application/json; charset=utf-8>

Contains the date and time when the message was originated.
Value: <http-date>

Contains the reference value for the state of traffic at a particular time. If the request contains a valid Traffic Model ID, its value is replicated here. If the request does not contain a Traffic Model ID, or it contains outdated data, then the most recent one is returned.
Value: <numeric>

An identifier for the request. If the Tracking-ID header was specified in the request, it is replicated in the response. Otherwise, it is generated automatically by the service. For details check RFC 4122. It is only meant to be used for support and does not involve tracking of you or your users in any form.
Value: <string>