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

Calculate a route between two points

ParametersExpand Collapse
RoutingRouteParams parameters
required GeoJsonGeometry destination

Destination point (GeoJSON Point geometry)

required GeoJsonGeometry origin

Origin point (GeoJSON Point geometry)

Mode mode
"auto"Auto
"foot"Foot
"bicycle"Bicycle
ReturnsExpand Collapse
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

Calculate a route between two points

RoutingRouteParams parameters = new()
{
    Destination = new()
    {
        Coordinates = new(

            [
                0
            ]
        ),
        Type = Type.Point,
    },
    Origin = new()
    {
        Coordinates = new(

            [
                0
            ]
        ),
        Type = Type.Point,
    },
};

var routeResult = await client.Routing.Route(parameters);

Console.WriteLine(routeResult);
Returns Examples