Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference
Routing

Calculate a route between two points

$client->routing->route(GeoJsonGeometry destination, GeoJsonGeometry origin, ?Mode mode): RouteResult
POST/api/v1/route

Calculate a route between two points

ParametersExpand Collapse
destination: GeoJsonGeometry

Destination point (GeoJSON Point geometry)

origin: GeoJsonGeometry

Origin point (GeoJSON Point geometry)

mode?:optional Mode
ReturnsExpand Collapse
Properties properties
Type type

Calculate a route between two points

<?php

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

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

$routeResult = $client->routing->route(
  destination: ['coordinates' => [0], 'type' => 'Point'],
  origin: ['coordinates' => [0], 'type' => 'Point'],
  mode: 'auto',
);

var_dump($routeResult);
Returns Examples