API Reference

Routing

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Calculate a distance matrix between points

$client->routing->matrix(GeoJsonGeometry destinations, GeoJsonGeometry origins, ?Mode mode): MatrixResult

POST/api/v1/matrix

Calculate a distance matrix between points

ParametersExpand Collapse

destinations: GeoJsonGeometry

Destination points (GeoJSON MultiPoint geometry)

origins: GeoJsonGeometry

Origin points (GeoJSON MultiPoint geometry)

mode?:optional Mode

Travel mode

ReturnsExpand Collapse

MatrixResult

list<list<float>> distances

Distance matrix (meters), origins x destinations

list<list<float>> durations

Duration matrix (seconds), origins x destinations

Calculate a distance matrix between points

PHP

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(apiKey: 'My API Key', environment: 'local');

$matrixResult = $client->routing->matrix(
  destinations: ['coordinates' => [0], 'type' => 'Point'],
  origins: ['coordinates' => [0], 'type' => 'Point'],
  mode: 'auto',
);

var_dump($matrixResult);

200 example

{
  "distances": [
    [
      0
    ]
  ],
  "durations": [
    [
      0
    ]
  ]
}

Returns Examples

200 example

{
  "distances": [
    [
      0
    ]
  ],
  "durations": [
    [
      0
    ]
  ]
}