Skip to main content
POST
roads.traffic.flow

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
area
object
required

Area to search.

functionalClasses
integer[]

Road classes, 1 major to 5 local.

Required array length: 1 - 5 elements
Required range: 1 <= x <= 5
minJamFactor
number
default:0

Minimum congestion.

Required range: 0 <= x <= 10
maxJamFactor
number
default:10

Maximum congestion.

Required range: 0 <= x <= 10
includeAdvanced
boolean
default:false

Opt in to deeper coverage; worst case $0.00875.

includeLanes
boolean
default:false

Opt in to lane details; worst case $0.00875.

Response

The result

results
object[]
required

Traffic for the roads in the area.

Maximum array length: 10000
updatedAt
string<date-time>

Time with a timezone, ISO 8601.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$