Flow Segment Data

Service version: 4
Last edit: 2021.07.20

On this page

Purpose

This service provides information about the speeds and travel times of the road fragment closest to the given coordinates.

• It is designed to work alongside the Flow Tiles to support clickable flow data visualizations.
• With this API, the client side can connect any place in the map with flow data on the closest road and present it to the user.

Run this endpoint

You can easily run this and other endpoints.

1. Go to the TomTom API Explorer page.
2. Click an endpoint.
   1. Click Try it out.
   2. Enter/select all required parameter values and any optional parameter values.
   3. At the bottom of the form, click Execute.
3. Review the response.

Request data

HTTPS method: GET

URL format

For ease of viewing and identification:

• Required constants and parameters are shown in bold text.
• Optional parameters are shown in plain text.

https://baseURL/traffic/services/versionNumber/flowSegmentData/style/zoom/format?key=Your_API_Key&point=point&unit=unit&thickness=thickness&openLr=boolean&jsonp=jsonp

Example

https://api.tomtom.com/traffic/services/4/flowSegmentData/absolute/10/xml?key=Your_API_Key&point=52.41072,4.84239

curl command

curl 'https://api.tomtom.com/traffic/services/4/flowSegmentData/absolute/10/xml?key=Your_API_Key&point=52.41072,4.84239'

Request parameters

The following table describes the parameters that can be used in a request.

• Required parameters must be used or the call will fail.
• Parameters and values are case-sensitive.
• Optional parameters may be used.

▲ Return to top

HTTP request headers

The following data table lists HTTP request headers of particular interest to clients of the Flow Segment Data API endpoint.

▲ Return to top

Response data

Successful response

The Flow Segment Data API endpoint for a valid single request returns a response in XML or JSON format.

XML response body example

An XSD schema is available for download. The XML response of the preceding sample request would look like this:

<flowSegmentData xmlns="http://lbs.tomtom.com/services" version="traffic-service 2.0.004">
    <frc>FRC2</frc>
    <currentSpeed>41</currentSpeed>
    <freeFlowSpeed>70</freeFlowSpeed>
    <currentTravelTime>153</currentTravelTime>
    <freeFlowTravelTime>90</freeFlowTravelTime>
    <confidence>0.59</confidence>
    <roadClosure>true</roadClosure>
    <coordinates>
        <coordinate>
            <latitude>52.40476</latitude>
            <longitude>4.844318</longitude>
        </coordinate>
        <coordinate>
            <latitude>52.411312</latitude>
            <longitude>4.8299975</longitude>
        </coordinate>
        <coordinate>
            <latitude>52.415073</latitude>
            <longitude>4.827327</longitude>
        </coordinate>
    </coordinates>
</flowSegmentData>

JSON response body example

{
  "flowSegmentData": {
    "-xmlns": "http://lbs.tomtom.com/services",
    "-version": "traffic-service 2.0.004",
    "frc": "FRC2",
    "currentSpeed": 41,
    "freeFlowSpeed": 70,
    "currentTravelTime": 153,
    "freeFlowTravelTime": 90,
    "confidence": 0.59,
    "roadClosure": true,
    "coordinates": {
      "coordinate": [
        {
          "latitude":  52.40476,
          "longitude": 4.844318
        },
        {
          "latitude":  52.411312,
          "longitude": 4.8299975
        },
        {
          "latitude":  52.415073,
          "longitude": 4.827327
        }
      ]
    }
  }
}

▲ Return to top

Successful response field structure

The following table describes XML or JSON element fields that can appear in a successful response. The types of the fields refer to a JSON response.

▲ Return to top

Error response

The Flow Segment Data API endpoint for an invalid single request returns a response body in JSON format.

Error response field structure

Error response example

{
  "error" : "Missing point parameter.",
  "httpStatusCode" : 400,
  "detailedError" : {
    "code" : "INVALID_REQUEST",
    "message" : "Missing point parameter."
  }
}

▲ Return to top

HTTP response codes

▲ Return to top

HTTP response headers

The following data table lists HTTP response headers of particular interest to clients of the Flow Segment Data API endpoint.

▲ Return to top