Response Parameters

northeast

Yes

Coordinate

Coordinates of the northeast corner.

southwest

Yes

Coordinate

Coordinates of the southwest corner.

lat

Yes

double

Latitude.

lng

Yes

double

Longitude.

roadID

Yes

String

ID of a road.

steps

Yes

Step[]

Route section information.

distance

No

double

Route distance, in meters.

distanceText

No

String

Distance description.

duration

No

double

Journey time, in seconds.

durationText

No

String

Journey time description.

durationInTraffic

No

double

Journey time calculated based on the real-time traffic condition, in seconds.

durationInTrafficText

No

String

Description of the journey time calculated based on the real-time traffic condition.

startLocation

Yes

Coordinate

Longitude and latitude of the departure place.

startAddress

No

String

Departure place details.

endLocation

Yes

Coordinate

Longitude and latitude of the destination.

endAddress

No

String

Destination details.

viaWaypoints

No

ViaWayPoints[]

Waypoint information.

paths

Yes

Path[]

Planned routes.

-

overviewPolyline

No

String

Encoded polyline of the route.

-

optimizedWaypoints

No

int[]

Optimized waypoint index. This parameter is available only when viaType is set to false and optimize is set to true.

-

bounds

No

CoordinateBounds

Route bounds.

-

hasRestrictedRoad

No

int

Indicates whether the route includes private or restricted roads.

• 0: no
• 1: yes

dstInRestrictedArea

No

int

Indicates whether the destination is in a restricted area.

crossCountry

No

int

Indicates whether the route crosses a country boundary. (If yes, learn about the COVID-19 restriction policies before departure.)

crossMultiCountries

No

int

Indicates whether the route crosses multiple country boundaries.

hasRoughRoad

No

int

Indicates whether the route includes rough roads.

dstInDiffTimeZone

No

int

Indicates whether the time zone of the destination is different from that of the departure place.

hasFerry

No

int

Indicates whether the route includes ferries.

hasTrafficLight

No

int

Indicates whether the route has traffic lights.

hasTolls

No

int

Indicates whether the route includes toll gates.

hasStairs

No

int

Indicates whether the route has stairs.

trafficLightNum

No

int

Number of traffic lights.

-

distance

No

double

Route distance, in meters.

distanceText

No

String

Distance description.

duration

No

double

Journey time, in seconds.

durationText

No

String

Journey time description.

startLocation

No

Coordinate

Longitude and latitude of the departure place.

endLocation

No

Coordinate

Longitude and latitude of the destination.

action

No

String

Operation to be performed in the current step. The options are as follows:

• TURN_SLIGHT_LEFT
• TURN_SHARP_LEFT
• UTURN_LEFT
• TURN_LEFT
• TURN_SLIGHT_RIGHT
• TURN_SHARP_RIGHT
• UTURN_RIGHT
• TURN_RIGHT
• STRAIGHT
• RAMP_LEFT
• RAMP_RIGHT
• MERGE
• FORK_LEFT
• FORK_RIGHT
• FERRY (not supported currently)
• FERRY_TRAIN (not supported currently)
• ROUNDABOUT_LEFT
• ROUNDABOUT_RIGHT
• END

polyline

No

Coordinate[]

A series of coordinate points on a road section (including coordinates of the departure place and destination).

roadName

No

String

Road name.

orientation

No

int

Road direction. The options are as follows:

• 0: bidirectional
• 1: forward direction
• 2: reverse direction

instruction

No

String

Text instruction.

traffic

No

Dict[]

Traffic information.

distance

No

double

Route distance, in meters.

status

No

int

Traffic status. The options are as follows:

• 0: unknown
• 1: smooth
• 2: slow
• 3: congested
• 4: extremely congested

polyline

No

Coordinate

A series of coordinate points on a road section.

location

Yes

Coordinate

Longitude and latitude of the waypoint.

stepIndex

Yes

int

Waypoint index in the Step array.

cells

Yes

Cell[]

Information about each cell in the distance matrix.

status

Yes

int

Result code for route calculation between the departure place and destination. For details, please refer to Result Codes.

distance

No

double

Route distance, in meters.

distanceText

No

String

Distance description.

duration

No

double

Journey time, in seconds.

durationText

No

String

Journey time description.