Skip to main content
POST
routes.compute

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
origin
object
required

Starting point.

destination
object
required

Ending point.

waypoints
object[]

Intermediate stops, at most 25.

Maximum array length: 25
mode
enum<string>
default:drive

Travel mode.

Available options:
drive,
walk,
bicycle,
transit,
two_wheeler
departureTime
string<date-time>

Departure timestamp.

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)))$
arrivalTime
string<date-time>

Arrival timestamp.

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)))$
avoid
object

Avoid options.

alternatives
boolean
default:false

Request alternative routes.

optimizeWaypointOrder
boolean
default:false

Explicitly reorder intermediate stops.

traffic
enum<string>
default:unaware

Traffic routing preference.

Available options:
unaware,
aware,
optimal
geometry
boolean
default:false

Include encoded route geometry.

legs
boolean
default:false

Include route legs.

steps
boolean
default:false

Include turn instructions and transit steps.

tolls
boolean
default:false

Include estimated toll charges.

language
string

Language tag, such as en or en-US.

Required string length: 1 - 35
Pattern: ^[a-zA-Z]{2,8}(?:-[a-zA-Z0-9]{1,8})*$
region
string

Two-letter region code.

Required string length: 1 - 2
Pattern: ^[A-Za-z]{2}$

Response

The result

distanceMeters
number
required

Primary route distance.

Required range: x >= 0
durationSeconds
number
required

Primary route duration.

Required range: x >= 0
routes
object[]

Primary route and requested alternatives.

Maximum array length: 5