Skip to main content
GET
Snap a GPS trace to the road network

Authorizations

Authorization
string
header
required

API key created in the JustRouting dashboard.

Path Parameters

profile
enum<string>
required
Available options:
driving,
motorcycle
coordinates
string
required

Trace points {lng},{lat};... in time order.

Query Parameters

timestamps
string
required

UNIX timestamps (seconds) for each point, monotonically increasing, one per coordinate.

radiuses
string

GPS accuracy in meters per point (standard deviation). Use device-reported accuracy when available.

steps
boolean
default:false

Return turn-by-turn steps.

geometries
enum<string>
default:polyline

Geometry encoding of the response.

Available options:
polyline,
polyline6,
geojson
overview
enum<string>
default:simplified

How much route geometry to return.

Available options:
full,
simplified,
false,
by_legs
gaps
enum<string>
default:split

Whether large timestamp gaps split the trace into multiple matchings.

Available options:
split,
ignore
tidy
boolean
default:false

Allow removing noisy points to improve matching quality.

bearings
string

{bearing},{range};... per coordinate, e.g. 0,20 = north ±20°.

hints
string

Base64 hints from a previous response to speed up snapping.

approaches
string

Restrict the road direction at each waypoint: curb / opposite / unrestricted (default), e.g. curb;opposite.

exclude
string

Road classes to avoid (additive list), e.g. motorway.

snapping
enum<string>
default:default

default avoids edges that cannot be used as start/end points; any snaps to any edge in the graph.

Available options:
default,
any
generate_hints
boolean
default:true

Add a hint to response waypoints for reuse in later requests.

skip_waypoints
boolean
default:false

Remove waypoints from the response (still calculated, not serialized).

annotations
string

Per-coordinate metadata: true, or a comma list of distance, duration, speed, weight, nodes, datasources.

waypoints
string

Indices of input coordinates to treat as waypoints in the response, e.g. 0;3. Default is all input coordinates.

Response

Trace matched

code
enum<string>
Available options:
Ok
tracepoints
(object | null)[]

One entry per input point; null for dropped outliers.

matchings
object[]