Street routing

Calculate a route

Calculate a route between locations with turn-by-turn directions, across auto, pedestrian, bicycle, and related travel modes. For transit, use transit routing at /api/v2/routing/otp/plan.

post/valhalla/route

Request

  • Base URL: https://transit.land/api/v2/routing
  • URL: https://transit.land/api/v2/routing/valhalla/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'
admin_crossingsboolean

When true, the route summary includes admins (array of administrative regions the route passes through) and admin_crossings (array of objects with from_admin_index, to_admin_index, from_shape_index, and to_shape_index indicating where and along which edge an administrative boundary is crossed).

alternatesinteger

Number of alternative routes to return. Forced to 0 for more than 2 waypoints.

banner_instructionsboolean

Include OSRM-format banner instructions, if format = osrm.

directions_type'none' | 'maneuvers' | 'instructions'
elevation_intervalnumber

Elevation sample interval in meters along the path. 0 = no elevation.

linear_referencesboolean

Include base64-encoded OpenLR references per edge in the response..

prioritize_bidirectionalboolean

Prefer bidirectional A* even when date_time.type={depart_at,arrive_by,current} in /route, or prefer CostMatrix over TDMatrix when calling /sources_to_targets

roundabout_exitsboolean

When true, exit instructions at roundabouts are added to the output.

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

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

turn_lanesboolean

When true, each maneuver may include a lanes array describing lane-level guidance: possible directions and which lanes are valid or active for following the maneuver.

voice_instructionsboolean

Include OSRM-format voice instructions, if format = osrm.

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",
  "locations": [
    {
      "preferred_side": "opposite",
      "search_filter": {
        "max_road_class": "primary",
        "min_road_class": "primary"
      },
      "street_side_cutoff": "primary",
      "type": "break"
    }
  ],
  "shape_format": "polyline6"
}

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.