Street routing

Calculate a time-distance matrix

Calculate a time-distance matrix from multiple source locations to multiple target locations. Useful for solving optimization problems.

post/valhalla/sources_to_targets

Request

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

Maximum path distance in meters for an expansion. Currently this is implemented for the timedistancematrix algorithm. Source-target pairs whose cheapest path distance exceeds this limit will be returned as unreachable (with null time and distance).

matrix_locationsinteger

Early-exit after finding this many targets. Only valid for TDMatrix algorithm.

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

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

verboseboolean

Include detailed per-cell metadata in the response.

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

Response

Successful response

algorithmstring

Which matrix algorithm answered the request.

units'kilometers' | 'miles'

Units the distances are expressed in.

Example response

{
  "algorithm": "costmatrix"
}

Changes

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