Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference

Routing

Calculate a route between two points
$ plaza routing route
POST/api/v1/route
Snap a coordinate to the nearest road
$ plaza routing nearest
GET/api/v1/nearest
Calculate an isochrone from a point
$ plaza routing isochrone
GET/api/v1/isochrone
Calculate a distance matrix between points
$ plaza routing matrix
POST/api/v1/matrix
ModelsExpand Collapse
matrix_request: object { destinations, origins, mode }
destinations: object { coordinates, type }

Destination points (GeoJSON MultiPoint geometry)

coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

union_member_0: array of number
union_member_1: array of array of number
union_member_2: array of array of array of number
union_member_3: array of array of array of array of number
type: "Point" or "LineString" or "Polygon" or 3 more
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
origins: object { coordinates, type }

Origin points (GeoJSON MultiPoint geometry)

coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

union_member_0: array of number
union_member_1: array of array of number
union_member_2: array of array of array of number
union_member_3: array of array of array of array of number
type: "Point" or "LineString" or "Polygon" or 3 more
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
mode: optional "auto" or "foot" or "bicycle"

Travel mode

"auto"
"foot"
"bicycle"
matrix_result: object { distances, durations }
distances: array of array of number

Distance matrix (meters), origins x destinations

durations: array of array of number

Duration matrix (seconds), origins x destinations

nearest_result: object { geometry, properties, type }

GeoJSON Point Feature snapped to the nearest road segment

geometry: object { coordinates, type }
coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

union_member_0: array of number
union_member_1: array of array of number
union_member_2: array of array of array of number
union_member_3: array of array of array of array of number
type: "Point" or "LineString" or "Polygon" or 3 more
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: object { distance_m, edge_id }
distance_m: optional number

Distance to nearest road in meters

edge_id: optional number

Road edge ID

type: "Feature"
"Feature"
route_request: object { destination, origin, mode }
destination: object { coordinates, type }

Destination point (GeoJSON Point geometry)

coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

union_member_0: array of number
union_member_1: array of array of number
union_member_2: array of array of array of number
union_member_3: array of array of array of array of number
type: "Point" or "LineString" or "Polygon" or 3 more
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
origin: object { coordinates, type }

Origin point (GeoJSON Point geometry)

coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

union_member_0: array of number
union_member_1: array of array of number
union_member_2: array of array of array of number
union_member_3: array of array of array of array of number
type: "Point" or "LineString" or "Polygon" or 3 more
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
mode: optional "auto" or "foot" or "bicycle"
"auto"
"foot"
"bicycle"
route_result: object { geometry, properties, type }
geometry: object { coordinates, type }
coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

union_member_0: array of number
union_member_1: array of array of number
union_member_2: array of array of array of number
union_member_3: array of array of array of array of number
type: "Point" or "LineString" or "Polygon" or 3 more
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: object { distance, duration, mode }
distance: optional number

Total distance in meters

duration: optional number

Estimated duration in seconds

mode: optional string

Travel mode used

type: "Feature"
"Feature"