Skip to content
Plaza Plaza Docs
GuidesBlogPlaygroundDashboard
API Reference
Routing

Calculate a distance matrix between points

POST/api/v1/matrix

Calculate a distance matrix between points

Body ParametersJSONExpand Collapse
destinations: array of object { lat, lng }

Array of destination coordinates (max 50)

lat: number

Latitude in decimal degrees (-90 to 90)

maximum90
minimum-90
lng: number

Longitude in decimal degrees (-180 to 180)

maximum180
minimum-180
origins: array of object { lat, lng }

Array of origin coordinates (max 50)

lat: number

Latitude in decimal degrees (-90 to 90)

maximum90
minimum-90
lng: number

Longitude in decimal degrees (-180 to 180)

maximum180
minimum-180
annotations: optional string

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

fallback_speed: optional number

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

exclusiveMinimum
minimum0
mode: optional "auto" or "foot" or "bicycle"

Travel mode (default: auto)

One of the following:
"auto"
"foot"
"bicycle"
ReturnsExpand Collapse
MatrixResult = map[unknown]

Distance matrix result. The exact response shape depends on the routing backend. Contains duration (and optionally distance) data for all origin-destination pairs. Null values indicate unreachable pairs.

Calculate a distance matrix between points

curl https://plaza.fyi/api/v1/matrix \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $PLAZA_API_KEY" \
    -d '{
          "destinations": [
            {
              "lat": 48.8584,
              "lng": 2.2945
            }
          ],
          "origins": [
            {
              "lat": 48.8566,
              "lng": 2.3522
            },
            {
              "lat": 48.8606,
              "lng": 2.3376
            }
          ]
        }'
{
  "foo": "bar"
}
Returns Examples
{
  "foo": "bar"
}