Skip to content
Plaza Plaza Docs
GuidesBlogPlaygroundDashboard
API Reference
Routing

Calculate a distance matrix between points

IReadOnlyDictionary<string, JsonElement> Routing.Matrix(RoutingMatrixParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/matrix

Calculate a distance matrix between points

ParametersExpand Collapse
RoutingMatrixParams parameters
required IReadOnlyList<Destination> destinations

Array of destination coordinates (max 50)

required Double Lat

Latitude in decimal degrees (-90 to 90)

maximum90
minimum-90
required Double Lng

Longitude in decimal degrees (-180 to 180)

maximum180
minimum-180
required IReadOnlyList<Origin> origins

Array of origin coordinates (max 50)

required Double Lat

Latitude in decimal degrees (-90 to 90)

maximum90
minimum-90
required Double Lng

Longitude in decimal degrees (-180 to 180)

maximum180
minimum-180
string annotations

Comma-separated list of annotations to include: duration (always included), distance. Example: duration,distance.

Double? fallbackSpeed

Fallback speed in km/h for pairs where no route exists. When set, unreachable pairs get estimated values instead of null.

exclusiveMinimum
minimum0
Mode mode

Travel mode (default: auto)

"auto"Auto
"foot"Foot
"bicycle"Bicycle
ReturnsExpand Collapse
IReadOnlyDictionary<string, JsonElement>

Calculate a distance matrix between points

RoutingMatrixParams parameters = new()
{
    Destinations =
    [
        new()
        {
            Lat = 48.8584,
            Lng = 2.2945,
        },
    ],
    Origins =
    [
        new()
        {
            Lat = 48.8566,
            Lng = 2.3522,
        },
        new()
        {
            Lat = 48.8606,
            Lng = 2.3376,
        },
    ],
};

var matrixResult = await client.Routing.Matrix(parameters);

Console.WriteLine(matrixResult);
{
  "foo": "bar"
}
Returns Examples
{
  "foo": "bar"
}