INRIX documentation logo

The INRIX Traffic and Road Speed Service gives users relevant information to help them save time, reduce frustration, and give them the critical insights to make better decisions while on the road.

Overview

The INRIX Traffic Service provides information on road speed, both current and predicted. It can also provide a combination of both road speed and incident information.

Although INRIX provides functionality such as traffic tiles and routing, you may decide that you need to create that functionality yourself so that you can display it however you like. The main usage scenarios for road speeds are:


Description: Retrieves road speed and congestion data for a specified region.

/?Action=GetSegmentSpeedinBox

GET Get roadspeed and congestion data for specified rectangular region

Parameters

  = required
Name Located In Type Description
action Query String Use getSegmentSpeedinBox
token Query String A valid authorization token returned in response to a GetSecurityToken request.
corner1 Path String The first corner of the region in which to get data. This parameter must be specified as a pair of latitude and longitude values separated by a pipe character (|), in the form Corner1=latitude|longitude. The latitude and longitude values are expressed using the WGS 84 datum. Northern latitudes are positive and southern latitudes are negative. Eastern hemisphere longitudes are positive and western hemisphere longitudes are negative. Longitudes in North America are negative. The corner specified by the Corner1 parameter can be any of the four corners of the bounding rectangle.
corner2 Path String The second corner of the region in which to get data. The Corner2 parameter is the geometric opposite of Corner1.
SpeedOutputFields Query String The traffic speed fields to be returned in the response. This parameter can specify a single field, or multiple fields in a comma-separated list such as “Reference,Speed”. If this SpeedOutputFields is not specified, all the fields are returned.
Value Description
All (default) Return all fields
Reference Reference speed field only
Speed Measured speed field only
Average Historical average speed field only
TTM Time required to travel across the segment
SpeedBucket Speed bucket or the the level of congestion
SpeedFilter Query Integer This parameter specifies the only speeds that should be shown are those speeds where the change is more or less than the percentage difference specified from the average speed. For example, SpeedFilter=10 returns speeds that are 10% +/- the Average speed. A negative value has the same result as a positive value (e.g. SpeedFilter=-10 is the same as SpeedFilter=10). If this parameter is not specified, no filter is applied.
StartTime Query Datetime The expected traffic at this time. The default is the current time. All times should be in UTC or have the timezone offset as specified in DateTime Values.
Duration Query String The duration, in minutes, for which to return traffic data in the specified intervals. Duration should be specified as a multiple of 5. For example, a Duration parameter of 120 and an Interval parameter of 30 will return results for the current time, as well as forecasts on the hour and half-hour, for up to 120 minutes from the current time. The default value is 0, which means real-time traffic data only.
Interval Query Integer The period of time in minutes between reports when the duration parameter is non-zero. The first set of data in the response will have the real-time timestamp. The timestamp for subsequent sets will have a minute value that is a multiple of the interval value. For example, an interval value of 30 specifies data sets on the hour and 30 minutes past the hour. The interval parameter is used in conjunction with the duration parameter.
Value Description
5 Return data for 5 minute periods
15 (default) Return data for 15 minute periods
30 Return data for 30 minute periods
60 Return data for 60 minute periods
FRCLevel Query String The Federal Road Classification code of the Segments to report. Multiple codes can be specified in a comma-delimited list.
Value Description
All (default) Report all road types.
1 First class roads, such as national highway network roads.
2 Second class roads, such as state highway network roads.
3 Third class roads, such as state interconnecting network roads.
4 Fourth class roads, such as major connecting roads.
5 Fifth class roads, such as minor roads connecting suburbs.
6 Sixth class roads, such as destination and destination collector roads.
7 Seventh class roads, such as destination dead-end roads.
Units Query Integer Use 0 for English units, 1 for metric. Default is 0.
Resolution Query Integer If resolution is specified, the speed of sub-segment is returned. The sub-segment is specified in terms of offsets. The length of the sub-segment will be based on the resolution specified. The default is 0, which means "full resolution" or one section per segment. Sub-segments are only returned if the sub-segment speed is more than 5 mph different from the speed on the overall segment.
Coverage Query Integer Indicates the type of coverage to return - core or extended. The default is specified per vendor.
Value Description
1 Real-time core coverage, i.e., roads segments that will always have coverage.
4 Real-time extended coverage, i.e., road segments, other than core, where we have real-time coverage at the given point in time.
8 Real-time core + extended coverage.
32 Reference.
48 Historical.
255 Return all types of coverage.
SpeedBucketID Query Integer A speed bucket is a range of speeds or percentages that is used to categorize Segment data. All speed buckets are identified by a unique number called a speedbucketID. Default is to use the INRIX default speed bucket ID (id=1) which is described in the CreateSpeedBucket api . Custom speed buckets can be defined by using the CreateSpeedBucket API.
Format Query String The format of the response in either XML or JSON. Default is XML.
SpeedBucketOutputFilter Query String A comma-delimited list of bytes specifying which speed bucket numbers to be included in the response. Multiple speed buckets can be specified. The number of speed buckets available to be filtered is dependent on the number of speed buckets returned from calls to CreateSpeedBucket. A value of 255 returns only closures.
Value Description
(empty)(default) Return all speed buckets.
0 Return only speed bucket 0.
1 Return only speed bucket 1.
2 Return only speed bucket 2.
(n) Return only speed bucket (n).
255 Report only closed segments or subsegments.
RoadSegmentType Query String This indicates the type of Segment to return. If RoadSegmentType is not specified, INRIX XD Segments (XDS) are returned. Multiple RoadSegmentTypes can be specified in a call as a comma separated ordered list and the ordering matters. For instance, if “TMC,XDS” is specified, TMCs will be returned for all TMC-defined road segments, and INRIX XD Segments will be returned for additional road segments not defined by the TMC Table and where traffic coverage is available. If “XDS,TMC” is specified then XD Segments will be returned where available, else TMC segments would be returned. However as XD segments in general cover all TMC locations this call would return only XD Segments.
Value Description
XDS (default) INRIX XD Segments
TMC INRIX Default TMC Tables

Requests

Example GetSegmentSpeedInBox request
Query
http://{serverPath}.INRIX.com/traffic/Inrix.ashx?Action=GetSegmentSpeedInBox&token={token}Here&Corner1=47.639|-122.236&Corner2=47.634|-122.232&Duration=0&RoadSegmentType=TMC,XDS&Units=1&Resolution=250&format=json

Responses

200 Success
{ "docType": "GetSegmentSpeedInBox", "copyright": "Copyright INRIX Inc.", "versionNumber": "11.2", "createdDate": "2017-12-12T00:52:43Z", "statusId": 0, "statusText": "OK", "responseId": "dc0963eb-ba0a-4e2b-9b14-871adf197a7e", "result": {
    "segmentSpeeds": [
        {
            "segments": [
                {
                    "subSegments": [
                        {
                            "speed": 42,
                            "offset": "408,612"
                        }
                    ],
                    "code": "114-04231",
                    "type": "TMC",
                    "speed": 29,
                    "average": 53,
                    "reference": 95,
                    "travelTimeMinutes": 1.265,
                    "speedBucket": 0
                    },
                    {
                    "code": "114+04232",
                    "type": "TMC",
                    "speed": 97,
                    "average": 92,
                    "reference": 97,
                    "travelTimeMinutes": 0.442,
                    "speedBucket": 3
                    },
                    {
                    "code": "114N04232",
                    "type": "TMC",
                    "speed": 24,
                    "average": 51,
                    "reference": 97,
                    "travelTimeMinutes": 1.13,
                    "speedBucket": 0
                    },
                    {
                    "code": "114P04232",
                    "type": "TMC",
                    "speed": 100,
                    "average": 93,
                    "reference": 95,
                    "travelTimeMinutes": 0.214,
                    "speedBucket": 3
                    },
                    {
                    "code": "114P14467",
                    "type": "TMC",
                    "speed": 66,
                    "average": 69,
                    "reference": 79,
                    "travelTimeMinutes": 0.276,
                    "speedBucket": 2
                    },
                    {
                    "subSegments": [
                        {
                            "speed": 39,
                            "offset": "236,472"
                        }
                    ],
                    "code": "114P14469",
                    "type": "TMC",
                    "speed": 26,
                    "average": 27,
                    "reference": 76,
                    "travelTimeMinutes": 1.088,
                    "speedBucket": 1
                    }
                    ],
                    "timestamp": "2017-12-12T00:52:43Z"
                }
            ],
        "coverage": 255
    }
} 

Response Elements

Property Type Description
segmentSpeeds Array A collection of traffic data for a specified point in time
Property Type Description
coverage Integer Indicates the type of coverage returned
segments Array The speed on a segment.
Property Type Description
code String Unique identifier for the segment. The value would be the TMC code or the INRIX XD Segment ID. Required
type String Indicates type of segment. Possible values are “TMC” and “XDS”. XDS refers to a segment type of INRIX XD segment. Required
speed Integer Current speed on the segment
average Integer The typical speed on the segment for the given day and time
reference Integer The free flow speed on the segment for the given day and time
travelTimeMinutes Integer Travel time along the segment at current speed in minutes
speedBucket Integer Level of congestion
segmentClosed Boolean Indicates whether the segment is closed or not. Speed data is not returned for a closed segment
subSegmentegments Array The speed on a sub-segment. Sub-segments are only returned if the sub-segment speed is more than 5 mph different from the speed on the overall segment.
Property Type Description
offset String The start and end offsets of the sub-segment on the parent segment in meters
speed String Current speed on the sub-segment

/?Action=GetSegmentSpeedinRadius

GET Get roadspeed and congestion data for specified circular region

Parameters

  = required
Name Located In Type Description
action Query String Use getSegmentSpeedinRAdius
token Query String A valid authorization token returned in response to a GetSecurityToken request.
center Path String The center of the region in which to get data. This parameter must be specified as a pair of latitude and longitude values separated by a pipe character (|), in the form Center=”latitude|longitude”. Northern latitudes are positive and southern latitudes are negative. Eastern hemisphere longitudes are positive and western hemisphere longitudes are negative. Longitudes in North America are negative. The latitude and longitude values are expressed using the WGS 84 datum.
radius Path Double The radius of the circular bounding area from which to return data. Any features that are fully or partially enclosed within the bounding area are selected. If the Units parameter is set to Metric, the radius is measured in kilometers; if Units is set to US (the default), the radius is measured in miles.
SpeedOutputFields Query String The traffic speed fields to be returned in the response. This parameter can specify a single field, or multiple fields in a comma-separated list such as “Reference,Speed”. If this SpeedOutputFields is not specified, all the fields are returned.
Value Description
All (default) Return all fields
Reference Reference speed field only
Speed Measured speed field only
Average Historical average speed field only
TTM Time required to travel across the segment
SpeedBucket Speed bucket or the the level of congestion
SpeedFilter Query Integer This parameter specifies the only speeds that should be shown are those speeds where the change is more or less than the percentage difference specified from the average speed. For example, SpeedFilter=10 returns speeds that are 10% +/- the Average speed. A negative value has the same result as a positive value (e.g. SpeedFilter=-10 is the same as SpeedFilter=10). If this parameter is not specified, no filter is applied.
StartTime Query Datetime The expected traffic at this time. The default is the current time. All times should be in UTC or have the timezone offset as specified in DateTime Values.
Duration Query String The duration, in minutes, for which to return traffic data in the specified intervals. Duration should be specified as a multiple of 5. For example, a Duration parameter of 120 and an Interval parameter of 30 will return results for the current time, as well as forecasts on the hour and half-hour, for up to 120 minutes from the current time. The default value is 0, which means real-time traffic data only.
Interval Query Integer The period of time in minutes between reports when the duration parameter is non-zero. The first set of data in the response will have the real-time timestamp. The timestamp for subsequent sets will have a minute value that is a multiple of the interval value. For example, an interval value of 30 specifies data sets on the hour and 30 minutes past the hour. The interval parameter is used in conjunction with the duration parameter.
Value Description
5 Return data for 5 minute periods
15 (default) Return data for 15 minute periods
30 Return data for 30 minute periods
60 Return data for 60 minute periods
FRCLevel Query String The Federal Road Classification code of the Segments to report. Multiple codes can be specified in a comma-delimited list.
Value Description
All (default) Report all road types.
1 First class roads, such as national highway network roads.
2 Second class roads, such as state highway network roads.
3 Third class roads, such as state interconnecting network roads.
4 Fourth class roads, such as major connecting roads.
5 Fifth class roads, such as minor roads connecting suburbs.
6 Sixth class roads, such as destination and destination collector roads.
7 Seventh class roads, such as destination dead-end roads.
Units Query Integer Use 0 for English units, 1 for metric. Default is 0.
Resolution Query Integer If resolution is specified, the speed of sub-segment is returned. The sub-segment is specified in terms of offsets. The length of the sub-segment will be based on the resolution specified. The default is 0, which means "full resolution" or one section per segment. Sub-segments are only returned if the sub-segment speed is more than 5 mph different from the speed on the overall segment.
Coverage Query Integer Indicates the type of coverage to return - core or extended. The default is specified per vendor.
Value Description
1 Real-time core coverage, i.e., roads segments that will always have coverage.
4 Real-time extended coverage, i.e., road segments, other than core, where we have real-time coverage at the given point in time.
8 Real-time core + extended coverage.
32 Reference.
48 Historical.
255 Return all types of coverage.
SpeedBucketID Query Integer A speed bucket is a range of speeds or percentages that is used to categorize Segment data. All speed buckets are identified by a unique number called a speedbucketID. Default is to use the INRIX default speed bucket ID. Custom speed buckets can be defined by using the CreateSpeedBucket API.
Format Query String The format of the response in either XML or JSON. Default is XML.
SpeedBucketOutputFilter Query String A comma-delimited list of bytes specifying which speed bucket numbers to be included in the response. Multiple speed buckets can be specified. The number of speed buckets available to be filtered is dependent on the number of speed buckets returned from calls to CreateSpeedBucket. A value of 255 returns only closures.
Value Description
(empty)(default) Return all speed buckets.
0 Return only speed bucket 0.
1 Return only speed bucket 1.
2 Return only speed bucket 2.
(n) Return only speed bucket (n).
255 Report only closed segments or subsegments.
RoadSegmentType Query String This indicates the type of Segment to return. If RoadSegmentType is not specified, INRIX XD Segments (XDS) are returned. Multiple RoadSegmentTypes can be specified in a call as a comma separated ordered list and the ordering matters. For instance, if “TMC,XDS” is specified, TMCs will be returned for all TMC-defined road segments, and INRIX XD Segments will be returned for additional road segments not defined by the TMC Table and where traffic coverage is available. If “XDS,TMC” is specified then XD Segments will be returned where available, else TMC segments would be returned. However as XD segments in general cover all TMC locations this call would return only XD Segments.
Value Description
XDS (default) INRIX XD Segments
TMC INRIX Default TMC Tables

Requests

Example GetSegmentSpeedInRadius request
Query
http://{serverPath}.INRIX.com/traffic/Inrix.ashx?Action=GetSegmentSpeedInRadius&token={token}Here&Center=47.60615|-122.35868&Radius=100&Duration=0&RoadSegmentType=TMC,XDS&Units=1&Resolution=250&format=json

Responses

200 Success
{ "docType": "GetSegmentSpeedInRadius", "copyright": "Copyright INRIX Inc.", "versionNumber": "11.2", "createdDate": "2017-12-12T00:52:43Z", "statusId": 0, "statusText": "OK", "responseId": "dc0963eb-ba0a-4e2b-9b14-871adf197a7e", "result": {
    "segmentSpeeds": [
        {
            "segments": [
                {
                    "subSegments": [
                        {
                            "speed": 42,
                            "offset": "408,612"
                        }
                    ],
                    "code": "114-04231",
                    "type": "TMC",
                    "speed": 29,
                    "average": 53,
                    "reference": 95,
                    "travelTimeMinutes": 1.265,
                    "speedBucket": 0
                    },
                    {
                    "code": "114+04232",
                    "type": "TMC",
                    "speed": 97,
                    "average": 92,
                    "reference": 97,
                    "travelTimeMinutes": 0.442,
                    "speedBucket": 3
                    },
                    {
                    "code": "114N04232",
                    "type": "TMC",
                    "speed": 24,
                    "average": 51,
                    "reference": 97,
                    "travelTimeMinutes": 1.13,
                    "speedBucket": 0
                    },
                    {
                    "code": "114P04232",
                    "type": "TMC",
                    "speed": 100,
                    "average": 93,
                    "reference": 95,
                    "travelTimeMinutes": 0.214,
                    "speedBucket": 3
                    },
                    {
                    "code": "114P14467",
                    "type": "TMC",
                    "speed": 66,
                    "average": 69,
                    "reference": 79,
                    "travelTimeMinutes": 0.276,
                    "speedBucket": 2
                    },
                    {
                    "subSegments": [
                        {
                            "speed": 39,
                            "offset": "236,472"
                        }
                    ],
                    "code": "114P14469",
                    "type": "TMC",
                    "speed": 26,
                    "average": 27,
                    "reference": 76,
                    "travelTimeMinutes": 1.088,
                    "speedBucket": 1
                    }
                    ],
                    "timestamp": "2017-12-12T00:52:43Z"
                }
            ],
        "coverage": 255
    }
} 

Response Elements

Property Type Description
segmentSpeeds Array A collection of traffic data for a specified point in time
Property Type Description
coverage Integer Indicates the type of coverage returned
segments Array The speed on a segment.
Property Type Description
code String Unique identifier for the segment. The value would be the TMC code or the INRIX XD Segment ID. Required
type String Indicates type of segment. Possible values are “TMC” and “XDS”. XDS refers to a segment type of INRIX XD segment. Required
speed Integer Current speed on the segment
average Integer The typical speed on the segment for the given day and time
reference Integer The free flow speed on the segment for the given day and time
travelTimeMinutes Integer Travel time along the segment at current speed in minutes
speedBucket Integer Level of congestion
segmentClosed Boolean Indicates whether the segment is closed or not. Speed data is not returned for a closed segment
subSegmentegments Array The speed on a sub-segment. Sub-segments are only returned if the sub-segment speed is more than 5 mph different from the speed on the overall segment.
Property Type Description
offset String The start and end offsets of the sub-segment on the parent segment in meters
speed String Current speed on the sub-segment

/?Action=GetSegmentSpeedinGeography

GET Get roadspeed and congestion data for specified geography.

Parameters

  = required
Name Located In Type Description
action Query String Use GetSegmentSpeedinGeography
token Query String A valid authorization token returned in response to a GetSecurityToken request.
geoid Path String The ID of the specified geography. For more information on how to obtain the ID, see Geographies.
SpeedOutputFields Query String The traffic speed fields to be returned in the response. This parameter can specify a single field, or multiple fields in a comma-separated list such as “Reference,Speed”. If this SpeedOutputFields is not specified, all the fields are returned.
Value Description
All (default) Return all fields
Reference Reference speed field only
Speed Measured speed field only
Average Historical average speed field only
TTM Time required to travel across the segment
SpeedBucket Speed bucket or the the level of congestion
SpeedFilter Query Integer This parameter specifies the only speeds that should be shown are those speeds where the change is more or less than the percentage difference specified from the average speed. For example, SpeedFilter=10 returns speeds that are 10% +/- the Average speed. A negative value has the same result as a positive value (e.g. SpeedFilter=-10 is the same as SpeedFilter=10). If this parameter is not specified, no filter is applied.
StartTime Query Datetime The expected traffic at this time. The default is the current time. All times should be in UTC or have the timezone offset as specified in DateTime Values.
Duration Query String The duration, in minutes, for which to return traffic data in the specified intervals. Duration should be specified as a multiple of 5. For example, a Duration parameter of 120 and an Interval parameter of 30 will return results for the current time, as well as forecasts on the hour and half-hour, for up to 120 minutes from the current time. The default value is 0, which means real-time traffic data only.
Interval Query Integer The period of time in minutes between reports when the duration parameter is non-zero. The first set of data in the response will have the real-time timestamp. The timestamp for subsequent sets will have a minute value that is a multiple of the interval value. For example, an interval value of 30 specifies data sets on the hour and 30 minutes past the hour. The interval parameter is used in conjunction with the duration parameter.
Value Description
5 Return data for 5 minute periods
15 (default) Return data for 15 minute periods
30 Return data for 30 minute periods
60 Return data for 60 minute periods
FRCLevel Query String The Federal Road Classification code of the Segments to report. Multiple codes can be specified in a comma-delimited list.
Value Description
All (default) Report all road types.
1 First class roads, such as national highway network roads.
2 Second class roads, such as state highway network roads.
3 Third class roads, such as state interconnecting network roads.
4 Fourth class roads, such as major connecting roads.
5 Fifth class roads, such as minor roads connecting suburbs
6 Sixth class roads, such as destination and destination collector roads.
7 Seventh class roads, such as destination dead-end roads.
Units Query Integer Use 0 for English units, 1 for metric. Default is 0.
Resolution Query Integer If resolution is specified, the speed of sub-segment is returned. The sub-segment is specified in terms of offsets. The length of the sub-segment will be based on the resolution specified. The default is 0, which means "full resolution" or one section per segment. Sub-segments are only returned if the sub-segment speed is more than 5 mph different from the speed on the overall segment.
Coverage Query Integer Indicates the type of coverage to return - core or extended. The default is specified per vendor.
Value Description
1 Real-time core coverage, i.e., roads segments that will always have coverage.
4 Real-time extended coverage, i.e., road segments, other than core, where we have real-time coverage at the given point in time.
8 Real-time core + extended coverage.
32 Reference.
48 Historical.
255 Return all types of coverage.
SpeedBucketID Query Integer A speed bucket is a range of speeds or percentages that is used to categorize Segment data. All speed buckets are identified by a unique number called a speedbucketID. Default is to use the INRIX default speed bucket ID. Custom speed buckets can be defined by using the CreateSpeedBucket API.
Format Query String The format of the response in either XML or JSON. Default is XML.
SpeedBucketOutputFilter Query String A comma-delimited list of bytes specifying which speed bucket numbers to be included in the response. Multiple speed buckets can be specified. The number of speed buckets available to be filtered is dependent on the number of speed buckets returned from calls to CreateSpeedBucket. A value of 255 returns only closures.
Value Description
(empty)(default) Return all speed buckets.
0 Return only speed bucket 0.
1 Return only speed bucket 1.
2 Return only speed bucket 2.
(n) Return only speed bucket (n).
255 Report only closed segments or subsegments.
RoadSegmentType Query String This indicates the type of Segment to return. If RoadSegmentType is not specified, INRIX XD Segments (XDS) are returned. Multiple RoadSegmentTypes can be specified in a call as a comma separated ordered list and the ordering matters. For instance, if “TMC,XDS” is specified, TMCs will be returned for all TMC-defined road segments, and INRIX XD Segments will be returned for additional road segments not defined by the TMC Table and where traffic coverage is available. If “XDS,TMC” is specified then XD Segments will be returned where available, else TMC segments would be returned. However as XD segments in general cover all TMC locations this call would return only XD Segments.
Value Description
XDS (default) INRIX XD Segments
TMC INRIX Default TMC Tables

Requests

Example GetSegmentSpeedInGeography request
Query
http://{serverPath}.INRIX.com/traffic/Inrix.ashx?Action=GetSegmentSpeedInGeography&token={token}Here&GeoId=207&Duration=0&RoadSegmentType=TMC,XDS&Units=1&Resolution=250&format=json

Responses

200 Success
{ "docType": "GetSegmentSpeedInGeography", "copyright": "Copyright INRIX Inc.", "versionNumber": "11.2", "createdDate": "2017-12-12T00:52:43Z", "statusId": 0, "statusText": "OK", "responseId": "dc0963eb-ba0a-4e2b-9b14-871adf197a7e", "result": {
    "segmentSpeeds": [
        {
            "segments": [
                {
                    "subSegments": [
                        {
                            "speed": 42,
                            "offset": "408,612"
                        }
                    ],
                    "code": "114-04231",
                    "type": "TMC",
                    "speed": 29,
                    "average": 53,
                    "reference": 95,
                    "travelTimeMinutes": 1.265,
                    "speedBucket": 0
                    },
                    {
                    "code": "114+04232",
                    "type": "TMC",
                    "speed": 97,
                    "average": 92,
                    "reference": 97,
                    "travelTimeMinutes": 0.442,
                    "speedBucket": 3
                    },
                    {
                    "code": "114N04232",
                    "type": "TMC",
                    "speed": 24,
                    "average": 51,
                    "reference": 97,
                    "travelTimeMinutes": 1.13,
                    "speedBucket": 0
                    },
                    {
                    "code": "114P04232",
                    "type": "TMC",
                    "speed": 100,
                    "average": 93,
                    "reference": 95,
                    "travelTimeMinutes": 0.214,
                    "speedBucket": 3
                    },
                    {
                    "code": "114P14467",
                    "type": "TMC",
                    "speed": 66,
                    "average": 69,
                    "reference": 79,
                    "travelTimeMinutes": 0.276,
                    "speedBucket": 2
                    },
                    {
                    "subSegments": [
                        {
                            "speed": 39,
                            "offset": "236,472"
                        }
                    ],
                    "code": "114P14469",
                    "type": "TMC",
                    "speed": 26,
                    "average": 27,
                    "reference": 76,
                    "travelTimeMinutes": 1.088,
                    "speedBucket": 1
                    }
                    ],
                    "timestamp": "2017-12-12T00:52:43Z"
                }
            ],
        "coverage": 255
    }
} 

Response Elements

Property Type Description
segmentSpeeds Array A collection of traffic data for a specified point in time
Property Type Description
coverage Integer Indicates the type of coverage returned
segments Array The speed on a segment.
Property Type Description
code String Unique identifier for the segment. The value would be the TMC code or the INRIX XD Segment ID. Required
type String Indicates type of segment. Possible values are “TMC” and “XDS”. XDS refers to a segment type of INRIX XD segment. Required
speed Integer Current speed on the segment
average Integer The typical speed on the segment for the given day and time
reference Integer The free flow speed on the segment for the given day and time
travelTimeMinutes Integer Travel time along the segment at current speed in minutes
speedBucket Integer Level of congestion
segmentClosed Boolean Indicates whether the segment is closed or not. Speed data is not returned for a closed segment
subSegmentegments Array The speed on a sub-segment. Sub-segments are only returned if the sub-segment speed is more than 5 mph different from the speed on the overall segment.
Property Type Description
offset String The start and end offsets of the sub-segment on the parent segment in meters
speed String Current speed on the sub-segment

/?Action=GetSegmentSpeedinSet

GET Get roadspeed and congestion data for specified set of segments.

Parameters

  = required
Name Located In Type Description
action Query String Use GetSegmentSpeedinSet
token Query String A valid authorization token returned in response to a GetSecurityToken request.
segmentSetId Path Integer The predefined Segment set for which to get data. This parameter can be one or more Segment sets; you can specify multiple Segment sets in a comma-delimited list.
SpeedOutputFields Query String The traffic speed fields to be returned in the response. This parameter can specify a single field, or multiple fields in a comma-separated list such as “Reference,Speed”. If this SpeedOutputFields is not specified, all the fields are returned.
Value Description
All (default) Return all fields
Reference Reference speed field only
Speed Measured speed field only
Average Historical average speed field only
TTM Time required to travel across the segment
SpeedBucket Speed bucket or the the level of congestion
SpeedFilter Query Integer This parameter specifies the only speeds that should be shown are those speeds where the change is more or less than the percentage difference specified from the average speed. For example, SpeedFilter=10 returns speeds that are 10% +/- the Average speed. A negative value has the same result as a positive value (e.g. SpeedFilter=-10 is the same as SpeedFilter=10). If this parameter is not specified, no filter is applied.
StartTime Query Datetime The expected traffic at this time. The default is the current time. All times should be in UTC or have the timezone offset as specified in DateTime Values.
Duration Query String The duration, in minutes, for which to return traffic data in the specified intervals. Duration should be specified as a multiple of 5. For example, a Duration parameter of 120 and an Interval parameter of 30 will return results for the current time, as well as forecasts on the hour and half-hour, for up to 120 minutes from the current time. The default value is 0, which means real-time traffic data only.
Interval Query Integer The period of time in minutes between reports when the duration parameter is non-zero. The first set of data in the response will have the real-time timestamp. The timestamp for subsequent sets will have a minute value that is a multiple of the interval value. For example, an interval value of 30 specifies data sets on the hour and 30 minutes past the hour. The interval parameter is used in conjunction with the duration parameter.
Value Description
5 Return data for 5 minute periods
15 (default) Return data for 15 minute periods
30 Return data for 30 minute periods
60 Return data for 60 minute periods
FRCLevel Query String The Federal Road Classification code of the Segments to report. Multiple codes can be specified in a comma-delimited list.
Value Description
All (default) Report all road types.
1 First class roads, such as national highway network roads.
2 Second class roads, such as state highway network roads.
3 Third class roads, such as state interconnecting network roads.
4 Fourth class roads, such as major connecting roads.
5 Fifth class roads, such as minor roads connecting suburbs
6 Sixth class roads, such as destination and destination collector roads.
7 Seventh class roads, such as destination dead-end roads.
Units Query Integer Use 0 for English units, 1 for metric. Default is 0.
Resolution Query Integer If resolution is specified, the speed of sub-segment is returned. The sub-segment is specified in terms of offsets. The length of the sub-segment will be based on the resolution specified. The default is 0, which means "full resolution" or one section per segment. Sub-segments are only returned if the sub-segment speed is more than 5 mph different from the speed on the overall segment.
Coverage Query Integer Indicates the type of coverage to return - core or extended. The default is specified per vendor.
Value Description
1 Real-time core coverage, i.e., roads segments that will always have coverage.
4 Real-time extended coverage, i.e., road segments, other than core, where we have real-time coverage at the given point in time.
8 Real-time core + extended coverage.
32 Reference.
48 Historical.
255 Return all types of coverage.
SpeedBucketID Query Integer A speed bucket is a range of speeds or percentages that is used to categorize Segment data. All speed buckets are identified by a unique number called a speedbucketID. Default is to use the INRIX default speed bucket ID. Custom speed buckets can be defined by using the CreateSpeedBucket API.
Format Query String The format of the response in either XML or JSON. Default is XML.
SpeedBucketOutputFilter Query String A comma-delimited list of bytes specifying which speed bucket numbers to be included in the response. Multiple speed buckets can be specified. The number of speed buckets available to be filtered is dependent on the number of speed buckets returned from calls to CreateSpeedBucket. A value of 255 returns only closures.
Value Description
(empty)(default) Return all speed buckets.
0 Return only speed bucket 0.
1 Return only speed bucket 1.
2 Return only speed bucket 2.
(n) Return only speed bucket (n).
255 Report only closed segments or subsegments.
RoadSegmentType Query String This indicates the type of Segment to return. If RoadSegmentType is not specified, INRIX XD Segments (XDS) are returned. Multiple RoadSegmentTypes can be specified in a call as a comma separated ordered list and the ordering matters. For instance, if “TMC,XDS” is specified, TMCs will be returned for all TMC-defined road segments, and INRIX XD Segments will be returned for additional road segments not defined by the TMC Table and where traffic coverage is available. If “XDS,TMC” is specified then XD Segments will be returned where available, else TMC segments would be returned. However as XD segments in general cover all TMC locations this call would return only XD Segments.
Value Description
XDS (default) INRIX XD Segments
TMC INRIX Default TMC Tables

Requests

Example GetSegmentSpeedInSet request
Query
http://{serverPath}.INRIX.com/traffic/Inrix.ashx?Action=GetSegmentSpeedInSet&token={token}Here&SegmentSetId=353107201&Duration=0&RoadSegmentType=TMC,XDS&Units=1&Resolution=250&format=json

Responses

200 Success
{ "docType": "GetSegmentSpeedInSet", "copyright": "Copyright INRIX Inc.", "versionNumber": "11.2", "createdDate": "2017-12-12T00:52:43Z", "statusId": 0, "statusText": "OK", "responseId": "dc0963eb-ba0a-4e2b-9b14-871adf197a7e", "result": {
    "segmentSpeeds": [
        {
            "segments": [
                {
                    "subSegments": [
                        {
                            "speed": 42,
                            "offset": "408,612"
                        }
                    ],
                    "code": "114-04231",
                    "type": "TMC",
                    "speed": 29,
                    "average": 53,
                    "reference": 95,
                    "travelTimeMinutes": 1.265,
                    "speedBucket": 0
                    },
                    {
                    "code": "114+04232",
                    "type": "TMC",
                    "speed": 97,
                    "average": 92,
                    "reference": 97,
                    "travelTimeMinutes": 0.442,
                    "speedBucket": 3
                    },
                    {
                    "code": "114N04232",
                    "type": "TMC",
                    "speed": 24,
                    "average": 51,
                    "reference": 97,
                    "travelTimeMinutes": 1.13,
                    "speedBucket": 0
                    },
                    {
                    "code": "114P04232",
                    "type": "TMC",
                    "speed": 100,
                    "average": 93,
                    "reference": 95,
                    "travelTimeMinutes": 0.214,
                    "speedBucket": 3
                    },
                    {
                    "code": "114P14467",
                    "type": "TMC",
                    "speed": 66,
                    "average": 69,
                    "reference": 79,
                    "travelTimeMinutes": 0.276,
                    "speedBucket": 2
                    },
                    {
                    "subSegments": [
                        {
                            "speed": 39,
                            "offset": "236,472"
                        }
                    ],
                    "code": "114P14469",
                    "type": "TMC",
                    "speed": 26,
                    "average": 27,
                    "reference": 76,
                    "travelTimeMinutes": 1.088,
                    "speedBucket": 1
                    }
                    ],
                    "timestamp": "2017-12-12T00:52:43Z"
                }
            ],
        "coverage": 255
    }
} 

Response Elements

Property Type Description
segmentSpeeds Array A collection of traffic data for a specified point in time
Property Type Description
coverage Integer Indicates the type of coverage returned
segments Array The speed on a segment.
Property Type Description
code String Unique identifier for the segment. The value would be the TMC code or the INRIX XD Segment ID. Required
type String Indicates type of segment. Possible values are “TMC” and “XDS”. XDS refers to a segment type of INRIX XD segment. Required
speed Integer Current speed on the segment
average Integer The typical speed on the segment for the given day and time
reference Integer The free flow speed on the segment for the given day and time
travelTimeMinutes Integer Travel time along the segment at current speed in minutes
speedBucket Integer Level of congestion
segmentClosed Boolean Indicates whether the segment is closed or not. Speed data is not returned for a closed segment
subSegmentegments Array The speed on a sub-segment. Sub-segments are only returned if the sub-segment speed is more than 5 mph different from the speed on the overall segment.
Property Type Description
offset String The start and end offsets of the sub-segment on the parent segment in meters
speed String Current speed on the sub-segment

/?Action=GetSegmentSpeed

GET Get roadspeed and congestion data for a specified list of INRIX XD Segments.

Parameters

  = required
Name Located In Type Description
action Query String Use GetSegmentSpeed
token Query String A valid authorization token returned in response to a GetSecurityToken request.
segments Path String The predefined comma-delimited list of INRIX XD Segment IDs or TMCs for which to get data. Any duplicate segments are ignored. For XD segments just the segment ID should be specified. For TMC segments the segment should be followed by a pipe character (‘|’) and ‘TMC’. The TMC ‘+’ symbol should be replaced with ‘%2B’. So the TMC ID ’111+11479′ should be represented as ’111%2B11479|TMC’. If TMCs and XD segments are both specified then the XD segments should add ‘|XDS’ to the end (e.g. XD segment ’123456′ would become ’123456|XDS’.
SpeedOutputFields Query String The traffic speed fields to be returned in the response. This parameter can specify a single field, or multiple fields in a comma-separated list such as “Reference,Speed”. If this SpeedOutputFields is not specified, all the fields are returned.
Value Description
All (default) Return all fields
Reference Reference speed field only
Speed Measured speed field only
Average Historical average speed field only
TTM Time required to travel across the segment
SpeedBucket Speed bucket or the the level of congestion
SpeedFilter Query Integer This parameter specifies the only speeds that should be shown are those speeds where the change is more or less than the percentage difference specified from the average speed. For example, SpeedFilter=10 returns speeds that are 10% +/- the Average speed. A negative value has the same result as a positive value (e.g. SpeedFilter=-10 is the same as SpeedFilter=10). If this parameter is not specified, no filter is applied.
StartTime Query Datetime The expected traffic at this time. The default is the current time. All times should be in UTC or have the timezone offset as specified in DateTime Values.
Duration Query String The duration, in minutes, for which to return traffic data in the specified intervals. Duration should be specified as a multiple of 5. For example, a Duration parameter of 120 and an Interval parameter of 30 will return results for the current time, as well as forecasts on the hour and half-hour, for up to 120 minutes from the current time. The default value is 0, which means real-time traffic data only.
Interval Query Integer The period of time in minutes between reports when the duration parameter is non-zero. The first set of data in the response will have the real-time timestamp. The timestamp for subsequent sets will have a minute value that is a multiple of the interval value. For example, an interval value of 30 specifies data sets on the hour and 30 minutes past the hour. The interval parameter is used in conjunction with the duration parameter.
Value Description
5 Return data for 5 minute periods
15 (default) Return data for 15 minute periods
30 Return data for 30 minute periods
60 Return data for 60 minute periods
FRCLevel Query String The Federal Road Classification code of the Segments to report. Multiple codes can be specified in a comma-delimited list.
Value Description
All (default) Report all road types.
1 First class roads, such as national highway network roads.
2 Second class roads, such as state highway network roads.
3 Third class roads, such as state interconnecting network roads.
4 Fourth class roads, such as major connecting roads.
5 Fifth class roads, such as minor roads connecting suburbs
6 Sixth class roads, such as destination and destination collector roads.
7 Seventh class roads, such as destination dead-end roads.
Units Query Integer Use 0 for English units, 1 for metric. Default is 0.
Resolution Query Integer If resolution is specified, the speed of sub-segment is returned. The sub-segment is specified in terms of offsets. The length of the sub-segment will be based on the resolution specified. The default is 0, which means "full resolution" or one section per segment. Sub-segments are only returned if the sub-segment speed is more than 5 mph different from the speed on the overall segment.
Coverage Query Integer Indicates the type of coverage to return - core or extended. The default is specified per vendor.
Value Description
1 Real-time core coverage, i.e., roads segments that will always have coverage.
4 Real-time extended coverage, i.e., road segments, other than core, where we have real-time coverage at the given point in time.
8 Real-time core + extended coverage.
32 Reference.
48 Historical.
255 Return all types of coverage.
SpeedBucketID Query Integer A speed bucket is a range of speeds or percentages that is used to categorize Segment data. All speed buckets are identified by a unique number called a speedbucketID. Default is to use the INRIX default speed bucket ID. Custom speed buckets can be defined by using the CreateSpeedBucket API.
Format Query String The format of the response in either XML or JSON. Default is XML.
SpeedBucketOutputFilter Query String A comma-delimited list of bytes specifying which speed bucket numbers to be included in the response. Multiple speed buckets can be specified. The number of speed buckets available to be filtered is dependent on the number of speed buckets returned from calls to CreateSpeedBucket. A value of 255 returns only closures.
Value Description
(empty)(default) Return all speed buckets.
0 Return only speed bucket 0.
1 Return only speed bucket 1.
2 Return only speed bucket 2.
(n) Return only speed bucket (n).
255 Report only closed segments or subsegments.
RoadSegmentType Query String This indicates the type of Segment to return. If RoadSegmentType is not specified, INRIX XD Segments (XDS) are returned. Multiple RoadSegmentTypes can be specified in a call as a comma separated ordered list and the ordering matters. For instance, if “TMC,XDS” is specified, TMCs will be returned for all TMC-defined road segments, and INRIX XD Segments will be returned for additional road segments not defined by the TMC Table and where traffic coverage is available. If “XDS,TMC” is specified then XD Segments will be returned where available, else TMC segments would be returned. However as XD segments in general cover all TMC locations this call would return only XD Segments.
Value Description
XDS (default) INRIX XD Segments
TMC INRIX Default TMC Tables

Requests

Example GetSegmentSpeed request
Query
http://{serverPath}.INRIX.com/traffic/Inrix.ashx?Action=GetSegmentSpeed&token={token}Here&Segments=5908854|XDS,5898079|XDS,5898012|XDS,111%2B11479|TMC,113-04803|TMC&Duration=0&Units=1&Resolution=250&format=json

Responses

200 Success
{ "docType": "GetSegmentSpeed", "copyright": "Copyright INRIX Inc.", "versionNumber": "11.2", "createdDate": "2017-12-12T00:52:43Z", "statusId": 0, "statusText": "OK", "responseId": "dc0963eb-ba0a-4e2b-9b14-871adf197a7e", "result": {
    "segmentSpeeds": [
        {
            "segments": [
                {
                    "subSegments": [
                        {
                            "speed": 42,
                            "offset": "408,612"
                        }
                    ],
                    "code": "114-04231",
                    "type": "TMC",
                    "speed": 29,
                    "average": 53,
                    "reference": 95,
                    "travelTimeMinutes": 1.265,
                    "speedBucket": 0
                    },
                    {
                    "code": "114+04232",
                    "type": "TMC",
                    "speed": 97,
                    "average": 92,
                    "reference": 97,
                    "travelTimeMinutes": 0.442,
                    "speedBucket": 3
                    },
                    {
                    "code": "114N04232",
                    "type": "TMC",
                    "speed": 24,
                    "average": 51,
                    "reference": 97,
                    "travelTimeMinutes": 1.13,
                    "speedBucket": 0
                    },
                    {
                    "code": "114P04232",
                    "type": "TMC",
                    "speed": 100,
                    "average": 93,
                    "reference": 95,
                    "travelTimeMinutes": 0.214,
                    "speedBucket": 3
                    },
                    {
                    "code": "114P14467",
                    "type": "TMC",
                    "speed": 66,
                    "average": 69,
                    "reference": 79,
                    "travelTimeMinutes": 0.276,
                    "speedBucket": 2
                    },
                    {
                    "subSegments": [
                        {
                            "speed": 39,
                            "offset": "236,472"
                        }
                    ],
                    "code": "114P14469",
                    "type": "TMC",
                    "speed": 26,
                    "average": 27,
                    "reference": 76,
                    "travelTimeMinutes": 1.088,
                    "speedBucket": 1
                    }
                    ],
                    "timestamp": "2017-12-12T00:52:43Z"
                }
            ],
        "coverage": 255
    }
} 

Response Elements

Property Type Description
segmentSpeeds Array A collection of traffic data for a specified point in time
Property Type Description
coverage Integer Indicates the type of coverage returned
segments Array The speed on a segment.
Property Type Description
code String Unique identifier for the segment. The value would be the TMC code or the INRIX XD Segment ID. Required
type String Indicates type of segment. Possible values are “TMC” and “XDS”. XDS refers to a segment type of INRIX XD segment. Required
speed Integer Current speed on the segment
average Integer The typical speed on the segment for the given day and time
reference Integer The free flow speed on the segment for the given day and time
travelTimeMinutes Integer Travel time along the segment at current speed in minutes
speedBucket Integer Level of congestion
segmentClosed Boolean Indicates whether the segment is closed or not. Speed data is not returned for a closed segment
subSegmentegments Array The speed on a sub-segment. Sub-segments are only returned if the sub-segment speed is more than 5 mph different from the speed on the overall segment.
Property Type Description
offset String The start and end offsets of the sub-segment on the parent segment in meters
speed String Current speed on the sub-segment