Skip to main content
POST
routes.stops.sequence

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
stops
object[]
required

Input stops; their positions may be private.

Required array length: 2 - 12 elements
profile
enum<string>
default:driving

Travel mode.

Available options:
driving,
walking,
cycling,
driving-traffic
roundTrip
boolean
default:true

Return to the starting stop.

start
enum<string>
default:any

Choose the first input stop as start, or allow any.

Available options:
any,
first
end
enum<string>
default:any

Choose the last input stop as end, or allow any.

Available options:
any,
last
pickupBeforeDropoff
tuple[]

Pickup and dropoff input index pairs.

Maximum array length: 6
radii
(number | string)[]

Maximum road-snapping distance per stop.

Required array length: 2 - 12 elements
Required range: 0 < x <= 100000
bearings
(object | null)[]

Bearing and tolerance per stop; null skips one.

Required array length: 2 - 12 elements
approaches
(enum<string> | null)[]

Road side per stop; null skips one.

Required array length: 2 - 12 elements
Available options:
unrestricted,
curb
overview
enum<string>
default:simplified

Overview detail.

Available options:
full,
simplified,
none
steps
boolean
default:false

Return turn instructions.

language
string
default:en

Turn instruction language.

Pattern: ^[a-z]{2,3}(?:-[A-Za-z]{2,4})?$
annotations
enum<string>[]

Segment measurements; requires full overview.

Maximum array length: 3
Available options:
distance,
duration,
speed

Response

The result

trips
object[]
required

Ordered trips.

Maximum array length: 12
stops
object[]
required

Every input stop, with visit order.

Maximum array length: 12