Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference
Optimize

Optimize route through waypoints

$client->optimize->create(GeoJsonGeometry waypoints, ?Mode mode, ?bool roundtrip): OptimizeResult
POST/api/v1/optimize

Optimize route through waypoints

ParametersExpand Collapse
waypoints: GeoJsonGeometry

Waypoints to visit (GeoJSON MultiPoint geometry, minimum 2 points)

mode?:optional Mode

Travel mode (default: auto)

roundtrip?:optional bool

Whether route returns to start (default: true)

ReturnsExpand Collapse
One of the following:
Properties properties
Status status

Job status

Type type
string jobID

Job ID for polling

Status status

Job status

Optimize route through waypoints

<?php

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

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

$optimizeResult = $client->optimize->create(
  waypoints: ['coordinates' => [0], 'type' => 'Point'],
  mode: 'auto',
  roundtrip: true,
);

var_dump($optimizeResult);
Returns Examples