successRouteResponse

codestring

routes object[]

Array [

geometryobject

Depending on the geometries query parameter, this is either a GeoJSON LineString or a Polyline string. Depending on the overview query parameter, this is the complete route geometry (full), a simplified geometry to the zoom level at which the route can be displayed in full (simplified), or is not included (false).

legs object[]

Array of legs for the route, where each leg represents a route between provided in the request waypoints.

Array [

end_timestring<date-time>

Time when the vehicle is scheduled to finish this leg of the journey.

steps object[]

Depending on the optional steps parameter, either an array of route step objects (steps=true) or an empty array (steps=false, default).

Array [

geometryobject

Geometry representation of the the step

maneuver object

Represents maneuvers at this step. Used as instructions for the step by step navigation

bearing_afternumber

bearing_beforenumber

locationnumber[]

modifierstring

typestring

modestring

Requested travelling mode (i.e. driving)

driving_sidestring

left or right driving side on the road

typestring

Type of the step

intersections object[]

Array of objects representing intersections for this step

Array [

outinteger

Number of exits at the intersection

ininteger

Number of entrances at the intersection

entryboolean[]

Flag indicating if the intersections is allowed to enter

bearingsinteger[]

Bearings of intesection exits\entrances

locationnumber[]

Location of hte intersection

]

weightnumber

Weight of the step

durationnumber

Planned duration of the step

distancenumber

Planned distance for the step

namestring

Name of the step-related geographical feature

]

slackinteger

Delay on the leg

summarystring

weightnumber

start_timestring<date-time>

Time when the vehicle is scheduled to begin this leg of the journey.

durationnumber

The estimated travel time through the waypoints, in seconds.

distancenumber

The distance traveled through the waypoints, in meters.

]

weight_namestring

weightnumber

A numeric value representing desirability of a route, where a lower weight indicates a more favorable route when comparing two routes with the same set of waypoints. In case multiple routes are returned, they are sorted in ascending order based on their weights.

durationnumber

The estimated travel time through the waypoints, in seconds.

distancenumber

The distance traveled through the waypoints, in meters.

]

waypoints object[]

Array [

hintstring

distancenumber

The straight-line distance from the coordinate specified in the query to the location it was snapped to.

namestring

The name of the road or path to which the input coordinate has been snapped.

locationnumber[]

Possible values: >= 2, <= 2

]

version object

patchinteger

majorinteger

minorinteger

changesstring

tagstring

git-sha1string

successRouteResponse

{
  "code": "string",
  "routes": [
    {
      "geometry": {},
      "legs": [
        {
          "end_time": "2024-07-29T15:51:28.071Z",
          "steps": [
            {
              "geometry": {},
              "maneuver": {
                "bearing_after": 0,
                "bearing_before": 0,
                "location": [
                  0
                ],
                "modifier": "string",
                "type": "string"
              },
              "mode": "string",
              "driving_side": "string",
              "type": "string",
              "intersections": [
                {
                  "out": 0,
                  "in": 0,
                  "entry": [
                    true
                  ],
                  "bearings": [
                    0
                  ],
                  "location": [
                    0
                  ]
                }
              ],
              "weight": 0,
              "duration": 0,
              "distance": 0,
              "name": "string"
            }
          ],
          "slack": 0,
          "summary": "string",
          "weight": 0,
          "start_time": "2024-07-29T15:51:28.071Z",
          "duration": 0,
          "distance": 0
        }
      ],
      "weight_name": "string",
      "weight": 0,
      "duration": 0,
      "distance": 0
    }
  ],
  "waypoints": [
    {
      "hint": "string",
      "distance": 0,
      "name": "string",
      "location": [
        0
      ]
    }
  ],
  "version": {
    "patch": 0,
    "major": 0,
    "minor": 0,
    "changes": "string",
    "tag": "string",
    "git-sha1": "string"
  }
}