Skip to content
GuidesPlaygroundDashboard

Optimize

Optimize route through waypoints
OptimizeResult optimize().create(OptimizeCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/api/v1/optimize
Get async optimization result
OptimizeJobStatus optimize().retrieve(OptimizeRetrieveParamsparams = OptimizeRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/api/v1/optimize/{job_id}
ModelsExpand Collapse
class OptimizeCompletedResult:

Completed optimization — GeoJSON Feature with optimized route

Coordinates coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List<double>
List<List<double>>
List<List<List<double>>>
List<List<List<List<double>>>>
Type type
One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
Properties properties
Optional<Double> distance

Total distance in meters

Optional<Double> duration

Estimated duration in seconds

Optional<List<Long>> waypointOrder

Optimized waypoint ordering

Status status

Job status

Type type
class OptimizeJobStatus:

Status of an async optimization job

Status status

Job status

One of the following:
COMPLETED("completed")
PROCESSING("processing")
FAILED("failed")
Optional<String> error

Error message when failed

Optional<JsonValue> result

Optimization result when completed

class OptimizeProcessingResult:

Async optimization in progress — poll with the job_id

String jobId

Job ID for polling

Status status

Job status

class OptimizeRequest:

Route optimization request through waypoints

GeoJsonGeometry waypoints

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

Coordinates coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List<double>
List<List<double>>
List<List<List<double>>>
List<List<List<List<double>>>>
Type type
One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
Optional<Mode> mode

Travel mode (default: auto)

One of the following:
AUTO("auto")
FOOT("foot")
BICYCLE("bicycle")
Optional<Boolean> roundtrip

Whether route returns to start (default: true)

class OptimizeResult: A class that can be one of several variants.union

Optimization response — either a completed GeoJSON Feature route or an async job reference

class OptimizeCompletedResult:

Completed optimization — GeoJSON Feature with optimized route

Coordinates coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List<double>
List<List<double>>
List<List<List<double>>>
List<List<List<List<double>>>>
Type type
One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
Properties properties
Optional<Double> distance

Total distance in meters

Optional<Double> duration

Estimated duration in seconds

Optional<List<Long>> waypointOrder

Optimized waypoint ordering

Status status

Job status

Type type
class OptimizeProcessingResult:

Async optimization in progress — poll with the job_id

String jobId

Job ID for polling

Status status

Job status