Street routing

Match a GPS trace to a route

Match a sequence of coordinates to the road network and return the matched route with turn-by-turn directions.

post/valhalla/trace_route

Request

  • Base URL: https://transit.land/api/v2/routing
  • URL: https://transit.land/api/v2/routing/valhalla/trace_route
  • Auth: one of:
    • API key in header apikey
    • API key in query parameter apikey

Request body

costing'auto' | 'bicycle' | 'pedestrian' | 'truck' | 'bus' | 'taxi' | 'motor_scooter' | 'motorcycle' | 'bikeshare' | 'auto_pedestrian' required

multimodal is not available. The street graph has no transit; use transit routing at /api/v2/routing/otp/plan.

format'json' | 'gpx' | 'osrm' | 'pbf' | 'geotiff' | 'mvt'

Not all formats are supported by all endpoints, e.g. geotiff is isochrone-only.

idstring

Arbitrary request identifier echoed in the response.

languagestring

BCP47 locale for narrative output. See locales/ for supported values.

units'km' | 'miles' | 'mi'
elevation_intervalnumber

Elevation sample interval in meters along the matched path. 0 = disabled.

encoded_polylinestring

Polyline6-encoded trace shape. Mutually exclusive with shape.

shape_format'polyline6' | 'polyline5' | 'geojson' | 'no_shape'

Not all formats are supported by all endpoints, e.g. no_shape is not valid for isochrone.

shape_match'map_snap' | 'edge_walk' | 'walk_or_snap'
alternatesinteger

Number of alternative matched routes to return.

begin_timeinteger

Epoch start timestamp (seconds) for the trace. Used with durations to assign timestamps to encoded_polyline input.

directions_type'none' | 'maneuvers' | 'instructions'
durationsnumber[]

Elapsed seconds between each successive pair of trace points. Used with begin_time to derive per-point timestamps from an encoded_polyline input.

linear_referencesboolean

Include base64-encoded OpenLR location references for each matched graph edge.

use_timestampsboolean

When true, use per-point time values (or derived timestamps) for elapsed time calculation instead of internal costing.

Example request

{
  "costing": "auto",
  "exclude_locations": [
    {
      "preferred_side": "opposite",
      "search_filter": {
        "max_road_class": "primary",
        "min_road_class": "primary"
      },
      "street_side_cutoff": "primary",
      "type": "break"
    }
  ],
  "format": "json",
  "shape": [
    {
      "preferred_side": "opposite",
      "search_filter": {
        "max_road_class": "primary",
        "min_road_class": "primary"
      },
      "street_side_cutoff": "primary",
      "type": "break"
    }
  ],
  "shape_format": "polyline6",
  "shape_match": "walk_or_snap"
}

Response

Successful response

idstring

The request's id, echoed back. Absent when the request has none.

Changes

No recorded changes to this operation across all 1 revision of this API.