Skip to main content
POST
roads.path.snap

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

Up to 100 path points, personal travel data.

Required array length: 1 - 100 elements
interpolate
boolean
default:false

Add intermediate road points.

Response

The result

results
object[]
required

Snapped and interpolated points in route order.

Maximum array length: 10000