Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference

Routing

Calculate a route between two points
RouteResult Routing.Route(RoutingRouteParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/route
Snap a coordinate to the nearest road
NearestResult Routing.Nearest(RoutingNearestParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/nearest
Calculate an isochrone from a point
GeoJsonFeature Routing.Isochrone(RoutingIsochroneParamsparameters, CancellationTokencancellationToken = default)
GET/api/v1/isochrone
Calculate a distance matrix between points
MatrixResult Routing.Matrix(RoutingMatrixParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/matrix
ModelsExpand Collapse
class MatrixRequest:
required GeoJsonGeometry Destinations

Destination points (GeoJSON MultiPoint geometry)

required Coordinates Coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type
One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
required GeoJsonGeometry Origins

Origin points (GeoJSON MultiPoint geometry)

required Coordinates Coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type
One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
Mode Mode

Travel mode

One of the following:
"auto"Auto
"foot"Foot
"bicycle"Bicycle
class MatrixResult:
required IReadOnlyList<IReadOnlyList<Double>> Distances

Distance matrix (meters), origins x destinations

required IReadOnlyList<IReadOnlyList<Double>> Durations

Duration matrix (seconds), origins x destinations

class NearestResult:

GeoJSON Point Feature snapped to the nearest road segment

required GeoJsonGeometry Geometry
required Coordinates Coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type
One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
required Properties Properties
Double DistanceM

Distance to nearest road in meters

Long? EdgeID

Road edge ID

required Type Type
class RouteRequest:
required GeoJsonGeometry Destination

Destination point (GeoJSON Point geometry)

required Coordinates Coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type
One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
required GeoJsonGeometry Origin

Origin point (GeoJSON Point geometry)

required Coordinates Coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type
One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
Mode Mode
One of the following:
"auto"Auto
"foot"Foot
"bicycle"Bicycle
class RouteResult:
required GeoJsonGeometry Geometry
required Coordinates Coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type
One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
required Properties Properties
Double Distance

Total distance in meters

Double Duration

Estimated duration in seconds

string Mode

Travel mode used

required Type Type