Route Path

The Route Path API retrieves a series of geographic coordinates that make up a route. The route is generated using the parameters below.

The Route Path can also be generated as one of the reports in our Route Reports API.

Requires a license for access to Trimble MAPS JavaScript.

GET /route/routePath

Parameters

This table includes the most frequently used parameters. Please see the Route Geometry overview page for a full list. If you would like to test out this API, enter values in the table below and scroll down the page to submit your request. Required parameters are highlighted in yellow.

Request

API KEY
GET

Response

Route Path Response

Data ElementDescriptionData TypeValue/Example
typeIndicates the type of response
string
geometryThe route points of the route that was runGeoJson Geometry
vehiclerestrictedcleanupgeometryList of coordinates that represents the path from the drivable road network to a stop located on a pedestrian only road. (This is usually the path the driver has walk to reach a stop on a vehicle-restricted road.) This path, if one exists, is only returned when includeVehicleRestrictedCleanupPoints is set to true in the request.GeoJson Geometry

Geometry

Data ElementDescriptionData TypeValue/Example
TypeIndicates the type of geometry
string
Multistring (currently this is the only value)
CoordinatesA series of geographic coordinate points that make up a routeJson array of arrays