LocationServiceRoutesV2 / Client / calculate_routes
calculate_routes#
- LocationServiceRoutesV2.Client.calculate_routes(**kwargs)#
Calculates a route given the following required parameters:
OriginandDestination.See also: AWS API Documentation
Request Syntax
response = client.calculate_routes( Allow={ 'Hot': True|False, 'Hov': True|False }, ArrivalTime='string', Avoid={ 'Areas': [ { 'Except': [ { 'Corridor': { 'LineString': [ [ 123.0, ], ], 'Radius': 123 }, 'BoundingBox': [ 123.0, ], 'Polygon': [ [ [ 123.0, ], ], ], 'PolylineCorridor': { 'Polyline': 'string', 'Radius': 123 }, 'PolylinePolygon': [ 'string', ] }, ], 'Geometry': { 'Corridor': { 'LineString': [ [ 123.0, ], ], 'Radius': 123 }, 'BoundingBox': [ 123.0, ], 'Polygon': [ [ [ 123.0, ], ], ], 'PolylineCorridor': { 'Polyline': 'string', 'Radius': 123 }, 'PolylinePolygon': [ 'string', ] } }, ], 'CarShuttleTrains': True|False, 'ControlledAccessHighways': True|False, 'DirtRoads': True|False, 'Ferries': True|False, 'SeasonalClosure': True|False, 'TollRoads': True|False, 'TollTransponders': True|False, 'TruckRoadTypes': [ 'string', ], 'Tunnels': True|False, 'UTurns': True|False, 'ZoneCategories': [ { 'Category': 'CongestionPricing'|'Environmental'|'Vignette' }, ] }, DepartNow=True|False, DepartureTime='string', Destination=[ 123.0, ], DestinationOptions={ 'AvoidActionsForDistance': 123, 'AvoidUTurns': True|False, 'Heading': 123.0, 'Matching': { 'NameHint': 'string', 'OnRoadThreshold': 123, 'Radius': 123, 'Strategy': 'MatchAny'|'MatchMostSignificantRoad' }, 'SideOfStreet': { 'Position': [ 123.0, ], 'UseWith': 'AnyStreet'|'DividedStreetOnly' }, 'StopDuration': 123 }, Driver={ 'Schedule': [ { 'DriveDuration': 123, 'RestDuration': 123 }, ] }, Exclude={ 'Countries': [ 'string', ] }, InstructionsMeasurementSystem='Metric'|'Imperial', Key='string', Languages=[ 'string', ], LegAdditionalFeatures=[ 'Elevation'|'Incidents'|'PassThroughWaypoints'|'Summary'|'Tolls'|'TravelStepInstructions'|'TruckRoadTypes'|'TypicalDuration'|'Zones', ], LegGeometryFormat='FlexiblePolyline'|'Simple', MaxAlternatives=123, OptimizeRoutingFor='FastestRoute'|'ShortestRoute', Origin=[ 123.0, ], OriginOptions={ 'AvoidActionsForDistance': 123, 'AvoidUTurns': True|False, 'Heading': 123.0, 'Matching': { 'NameHint': 'string', 'OnRoadThreshold': 123, 'Radius': 123, 'Strategy': 'MatchAny'|'MatchMostSignificantRoad' }, 'SideOfStreet': { 'Position': [ 123.0, ], 'UseWith': 'AnyStreet'|'DividedStreetOnly' } }, SpanAdditionalFeatures=[ 'BestCaseDuration'|'CarAccess'|'Country'|'Distance'|'Duration'|'DynamicSpeed'|'FunctionalClassification'|'Gates'|'Incidents'|'Names'|'Notices'|'PedestrianAccess'|'RailwayCrossings'|'Region'|'RoadAttributes'|'RouteNumbers'|'ScooterAccess'|'SpeedLimit'|'TollSystems'|'TruckAccess'|'TruckRoadTypes'|'TypicalDuration'|'Zones'|'Consumption', ], Tolls={ 'AllTransponders': True|False, 'AllVignettes': True|False, 'Currency': 'string', 'EmissionType': { 'Co2EmissionClass': 'string', 'Type': 'string' }, 'VehicleCategory': 'Minibus' }, Traffic={ 'FlowEventThresholdOverride': 123, 'Usage': 'IgnoreTrafficData'|'UseTrafficData' }, TravelMode='Car'|'Pedestrian'|'Scooter'|'Truck', TravelModeOptions={ 'Car': { 'EngineType': 'Electric'|'InternalCombustion'|'PluginHybrid', 'LicensePlate': { 'LastCharacter': 'string' }, 'MaxSpeed': 123.0, 'Occupancy': 123 }, 'Pedestrian': { 'Speed': 123.0 }, 'Scooter': { 'EngineType': 'Electric'|'InternalCombustion'|'PluginHybrid', 'LicensePlate': { 'LastCharacter': 'string' }, 'MaxSpeed': 123.0, 'Occupancy': 123 }, 'Truck': { 'AxleCount': 123, 'EngineType': 'Electric'|'InternalCombustion'|'PluginHybrid', 'GrossWeight': 123, 'HazardousCargos': [ 'Combustible'|'Corrosive'|'Explosive'|'Flammable'|'Gas'|'HarmfulToWater'|'Organic'|'Other'|'Poison'|'PoisonousInhalation'|'Radioactive', ], 'Height': 123, 'HeightAboveFirstAxle': 123, 'KpraLength': 123, 'Length': 123, 'LicensePlate': { 'LastCharacter': 'string' }, 'MaxSpeed': 123.0, 'Occupancy': 123, 'PayloadCapacity': 123, 'TireCount': 123, 'Trailer': { 'AxleCount': 123, 'TrailerCount': 123 }, 'TruckType': 'LightTruck'|'StraightTruck'|'Tractor', 'TunnelRestrictionCode': 'string', 'WeightPerAxle': 123, 'WeightPerAxleGroup': { 'Single': 123, 'Tandem': 123, 'Triple': 123, 'Quad': 123, 'Quint': 123 }, 'Width': 123 } }, TravelStepType='Default'|'TurnByTurn', Waypoints=[ { 'AvoidActionsForDistance': 123, 'AvoidUTurns': True|False, 'Heading': 123.0, 'Matching': { 'NameHint': 'string', 'OnRoadThreshold': 123, 'Radius': 123, 'Strategy': 'MatchAny'|'MatchMostSignificantRoad' }, 'PassThrough': True|False, 'Position': [ 123.0, ], 'SideOfStreet': { 'Position': [ 123.0, ], 'UseWith': 'AnyStreet'|'DividedStreetOnly' }, 'StopDuration': 123 }, ] )
- Parameters:
Allow (dict) –
Features that are allowed while calculating. a route
Hot (boolean) –
Allow Hot (High Occupancy Toll) lanes while calculating the route.
Hov (boolean) –
Allow Hov (High Occupancy vehicle) lanes while calculating the route.
ArrivalTime (string) –
Time of arrival at the destination.
Time format:
YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mmExamples:
2020-04-22T17:57:24Z2020-04-22T17:57:24+02:00Avoid (dict) –
Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can’t be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.
Areas (list) –
Areas to be avoided.
(dict) –
Areas to be avoided.
Except (list) –
Exceptions to the provided avoidance geometry, to be included while calculating the route.
(dict) –
Geometry of the area to be avoided.
Corridor (dict) –
Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.
LineString (list) – [REQUIRED]
An ordered list of positions used to plot a route on a map.
Note
LineString and Polyline are mutually exclusive properties.
(list) –
(float) –
Radius (integer) – [REQUIRED]
Radius that defines the width of the corridor.
BoundingBox (list) –
Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.
(float) –
Polygon (list) –
Geometry defined as a polygon with only one linear ring.
(list) –
(list) –
(float) –
PolylineCorridor (dict) –
Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.
Polyline (string) – [REQUIRED]
An ordered list of positions used to plot a route on a map in a lossy compression format.
Note
LineString and Polyline are mutually exclusive properties.
Radius (integer) – [REQUIRED]
Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.
Unit:
Meters
PolylinePolygon (list) –
A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.
(string) –
Geometry (dict) – [REQUIRED]
Geometry of the area to be avoided.
Corridor (dict) –
Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.
LineString (list) – [REQUIRED]
An ordered list of positions used to plot a route on a map.
Note
LineString and Polyline are mutually exclusive properties.
(list) –
(float) –
Radius (integer) – [REQUIRED]
Radius that defines the width of the corridor.
BoundingBox (list) –
Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.
(float) –
Polygon (list) –
Geometry defined as a polygon with only one linear ring.
(list) –
(list) –
(float) –
PolylineCorridor (dict) –
Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.
Polyline (string) – [REQUIRED]
An ordered list of positions used to plot a route on a map in a lossy compression format.
Note
LineString and Polyline are mutually exclusive properties.
Radius (integer) – [REQUIRED]
Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.
Unit:
Meters
PolylinePolygon (list) –
A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.
(string) –
CarShuttleTrains (boolean) –
Avoid car-shuttle-trains while calculating the route.
ControlledAccessHighways (boolean) –
Avoid controlled access highways while calculating the route.
DirtRoads (boolean) –
Avoid dirt roads while calculating the route.
Ferries (boolean) –
Avoid ferries while calculating the route.
SeasonalClosure (boolean) –
Avoid roads that have seasonal closure while calculating the route.
TollRoads (boolean) –
Avoids roads where the specified toll transponders are the only mode of payment.
TollTransponders (boolean) –
Avoids roads where the specified toll transponders are the only mode of payment.
TruckRoadTypes (list) –
Truck road type identifiers.
BK1throughBK4apply only to Sweden.A2,A4,B2,B4,C,D,ET2,ET4apply only to Mexico.Note
There are currently no other supported values as of 26th April 2024.
(string) –
Tunnels (boolean) –
Avoid tunnels while calculating the route.
UTurns (boolean) –
Avoid U-turns for calculation on highways and motorways.
ZoneCategories (list) –
Zone categories to be avoided.
(dict) –
Zone categories to be avoided.
Category (string) – [REQUIRED]
Zone category to be avoided.
DepartNow (boolean) – Uses the current time as the time of departure.
DepartureTime (string) –
Time of departure from thr origin.
Time format:
YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mmExamples:
2020-04-22T17:57:24Z2020-04-22T17:57:24+02:00Destination (list) –
[REQUIRED]
The final position for the route. In the World Geodetic System (WGS 84) format:
[longitude, latitude].(float) –
DestinationOptions (dict) –
Destination related options.
AvoidActionsForDistance (integer) –
Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.
AvoidUTurns (boolean) –
Avoid U-turns for calculation on highways and motorways.
Heading (float) –
GPS Heading at the position.
Matching (dict) –
Options to configure matching the provided position to the road network.
NameHint (string) –
Attempts to match the provided position to a road similar to the provided name.
OnRoadThreshold (integer) –
If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.
Unit:
metersRadius (integer) –
Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.
Unit:
MetersStrategy (string) –
Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.
SideOfStreet (dict) –
Options to configure matching the provided position to a side of the street.
Position (list) – [REQUIRED]
Position defined as
[longitude, latitude].(float) –
UseWith (string) –
Strategy that defines when the side of street position should be used.
Default Value:
DividedStreetOnly
StopDuration (integer) –
Duration of the stop.
Unit:
seconds
Driver (dict) –
Driver related options.
Schedule (list) –
Driver work-rest schedule. Stops are added to fulfil the provided rest schedule.
(dict) –
Interval of the driver work-rest schedule. Stops are added to fulfil the provided rest schedule.
DriveDuration (integer) – [REQUIRED]
Maximum allowed driving time before stopping to rest.
Unit:
secondsRestDuration (integer) – [REQUIRED]
Resting time before the driver can continue driving.
Unit:
seconds
Exclude (dict) –
Features to be strictly excluded while calculating the route.
Countries (list) – [REQUIRED]
List of countries to be avoided defined by two-letter or three-letter country codes.
(string) –
InstructionsMeasurementSystem (string) – Measurement system to be used for instructions within steps in the response.
Key (string) – Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
Languages (list) –
List of languages for instructions within steps in the response.
Note
Instructions in the requested language are returned only if they are available.
(string) –
LegAdditionalFeatures (list) –
A list of optional additional parameters such as timezone that can be requested for each result.
Elevation: Retrieves the elevation information for each location.Incidents: Provides information on traffic incidents along the route.PassThroughWaypoints: Indicates waypoints that are passed through without stopping.Summary: Returns a summary of the route, including distance and duration.Tolls: Supplies toll cost information along the route.TravelStepInstructions: Provides step-by-step instructions for travel along the route.TruckRoadTypes: Returns information about road types suitable for trucks.TypicalDuration: Gives typical travel duration based on historical data.Zones: Specifies the time zone information for each waypoint.
(string) –
LegGeometryFormat (string) –
Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.
FlexiblePolyline: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for FlexiblePolyline.Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.MaxAlternatives (integer) – Maximum number of alternative routes to be provided in the response, if available.
OptimizeRoutingFor (string) –
Specifies the optimization criteria for calculating a route.
Default Value:
FastestRouteOrigin (list) –
[REQUIRED]
The start position for the route.
(float) –
OriginOptions (dict) –
Origin related options.
AvoidActionsForDistance (integer) –
Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.
AvoidUTurns (boolean) –
Avoid U-turns for calculation on highways and motorways.
Heading (float) –
GPS Heading at the position.
Matching (dict) –
Options to configure matching the provided position to the road network.
NameHint (string) –
Attempts to match the provided position to a road similar to the provided name.
OnRoadThreshold (integer) –
If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.
Unit:
metersRadius (integer) –
Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.
Unit:
MetersStrategy (string) –
Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.
SideOfStreet (dict) –
Options to configure matching the provided position to a side of the street.
Position (list) – [REQUIRED]
Position defined as
[longitude, latitude].(float) –
UseWith (string) –
Strategy that defines when the side of street position should be used.
Default Value:
DividedStreetOnly
SpanAdditionalFeatures (list) –
A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values.
(string) –
Tolls (dict) –
Toll related options.
AllTransponders (boolean) –
Specifies if the user has valid transponder with access to all toll systems. This impacts toll calculation, and if true the price with transponders is used.
AllVignettes (boolean) –
Specifies if the user has valid vignettes with access for all toll roads. If a user has a vignette for a toll road, then toll cost for that road is omitted since no further payment is necessary.
Currency (string) –
Currency code corresponding to the price. This is the same as Currency specified in the request.
EmissionType (dict) –
Emission type of the vehicle for toll cost calculation.
Valid values:
Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEevCo2EmissionClass (string) –
The CO 2 emission classes.
Type (string) – [REQUIRED]
Type of the emission.
Valid values:
Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEev
VehicleCategory (string) –
Vehicle category for toll cost calculation.
Traffic (dict) –
Traffic related options.
FlowEventThresholdOverride (integer) –
Duration for which flow traffic is considered valid. For this period, the flow traffic is used over historical traffic data. Flow traffic refers to congestion, which changes very quickly. Duration in seconds for which flow traffic event would be considered valid. While flow traffic event is valid it will be used over the historical traffic data.
Usage (string) –
Determines if traffic should be used or ignored while calculating the route.
Default Value:
UseTrafficData
TravelMode (string) –
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
Default Value:
CarTravelModeOptions (dict) –
Travel mode related options for the provided travel mode.
Car (dict) –
Travel mode options when the provided travel mode is “Car”
EngineType (string) –
Engine type of the vehicle.
LicensePlate (dict) –
The vehicle License Plate.
LastCharacter (string) –
The last character of the License Plate.
MaxSpeed (float) –
Maximum speed specified.
Unit:
KilometersPerHourOccupancy (integer) –
The number of occupants in the vehicle.
Default Value:
1
Pedestrian (dict) –
Travel mode options when the provided travel mode is “Pedestrian”
Speed (float) –
Walking speed in Kilometers per hour.
Scooter (dict) –
Travel mode options when the provided travel mode is “Scooter”
EngineType (string) –
Engine type of the vehicle.
LicensePlate (dict) –
The vehicle License Plate.
LastCharacter (string) –
The last character of the License Plate.
MaxSpeed (float) –
Maximum speed
Unit:
KilometersPerHourOccupancy (integer) –
The number of occupants in the vehicle.
Default Value:
1
Truck (dict) –
Travel mode options when the provided travel mode is “Truck”
AxleCount (integer) –
Total number of axles of the vehicle.
EngineType (string) –
Engine type of the vehicle.
GrossWeight (integer) –
Gross weight of the vehicle including trailers, and goods at capacity.
Unit:
KilogramsHazardousCargos (list) –
List of Hazardous cargo contained in the vehicle.
(string) –
Height (integer) –
Height of the vehicle.
Unit:
centimetersHeightAboveFirstAxle (integer) –
Height of the vehicle above its first axle.
Unit:
centimetersKpraLength (integer) –
Kingpin to rear axle length of the vehicle.
Unit:
centimetersLength (integer) –
Length of the vehicle.
Unit:
cLicensePlate (dict) –
The vehicle License Plate.
LastCharacter (string) –
The last character of the License Plate.
MaxSpeed (float) –
Maximum speed
Unit:
KilometersPerHourOccupancy (integer) –
The number of occupants in the vehicle.
Default Value:
1PayloadCapacity (integer) –
Payload capacity of the vehicle and trailers attached.
Unit:
kilogramsTireCount (integer) –
Number of tires on the vehicle.
Trailer (dict) –
Trailer options corresponding to the vehicle.
AxleCount (integer) –
Total number of axles of the vehicle.
TrailerCount (integer) –
Number of trailers attached to the vehicle.
Default Value:
0
TruckType (string) –
Type of the truck.
TunnelRestrictionCode (string) –
The tunnel restriction code.
Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.
Tunnel Category B
Risk Level: Limited risk
Restrictions: Few restrictions
Tunnel Category C
Risk Level: Medium risk
Restrictions: Some restrictions
Tunnel Category D
Risk Level: High risk
Restrictions: Many restrictions occur
Tunnel Category E
Risk Level: Very high risk
Restrictions: Restricted tunnel
WeightPerAxle (integer) –
Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.
Unit:
KilogramsWeightPerAxleGroup (dict) –
Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.
Unit:
KilogramsSingle (integer) –
Weight for single axle group.
Unit:
KilogramsTandem (integer) –
Weight for tandem axle group.
Unit:
KilogramsTriple (integer) –
Weight for triple axle group.
Unit:
KilogramsQuad (integer) –
Weight for quad axle group.
Unit:
KilogramsQuint (integer) –
Weight for quad quint group.
Unit:
Kilograms
Width (integer) –
Width of the vehicle.
Unit:
centimeters
TravelStepType (string) – Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based naviagtion system.
Waypoints (list) –
List of waypoints between the Origin and Destination.
(dict) –
Waypoint between the Origin and Destination.
AvoidActionsForDistance (integer) –
Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.
AvoidUTurns (boolean) –
Avoid U-turns for calculation on highways and motorways.
Heading (float) –
GPS Heading at the position.
Matching (dict) –
Options to configure matching the provided position to the road network.
NameHint (string) –
Attempts to match the provided position to a road similar to the provided name.
OnRoadThreshold (integer) –
If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.
Unit:
metersRadius (integer) –
Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.
Unit:
MetersStrategy (string) –
Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.
PassThrough (boolean) –
If the waypoint should not be treated as a stop. If yes, the waypoint is passed through and doesn’t split the route into different legs.
Position (list) – [REQUIRED]
Position defined as
[longitude, latitude].(float) –
SideOfStreet (dict) –
Options to configure matching the provided position to a side of the street.
Position (list) – [REQUIRED]
Position defined as
[longitude, latitude].(float) –
UseWith (string) –
Strategy that defines when the side of street position should be used.
Default Value:
DividedStreetOnly
StopDuration (integer) –
Duration of the stop.
Unit:
seconds
- Return type:
dict
- Returns:
Response Syntax
{ 'LegGeometryFormat': 'FlexiblePolyline'|'Simple', 'Notices': [ { 'Code': 'MainLanguageNotFound'|'Other'|'TravelTimeExceedsDriverWorkHours', 'Impact': 'High'|'Low' }, ], 'PricingBucket': 'string', 'Routes': [ { 'Legs': [ { 'FerryLegDetails': { 'AfterTravelSteps': [ { 'Duration': 123, 'Instruction': 'string', 'Type': 'Deboard' }, ], 'Arrival': { 'Place': { 'Name': 'string', 'OriginalPosition': [ 123.0, ], 'Position': [ 123.0, ], 'WaypointIndex': 123 }, 'Time': 'string' }, 'BeforeTravelSteps': [ { 'Duration': 123, 'Instruction': 'string', 'Type': 'Board' }, ], 'Departure': { 'Place': { 'Name': 'string', 'OriginalPosition': [ 123.0, ], 'Position': [ 123.0, ], 'WaypointIndex': 123 }, 'Time': 'string' }, 'Notices': [ { 'Code': 'AccuratePolylineUnavailable'|'NoSchedule'|'Other'|'ViolatedAvoidFerry'|'ViolatedAvoidRailFerry', 'Impact': 'High'|'Low' }, ], 'PassThroughWaypoints': [ { 'GeometryOffset': 123, 'Place': { 'OriginalPosition': [ 123.0, ], 'Position': [ 123.0, ], 'WaypointIndex': 123 } }, ], 'RouteName': 'string', 'Spans': [ { 'Country': 'string', 'Distance': 123, 'Duration': 123, 'GeometryOffset': 123, 'Names': [ { 'Language': 'string', 'Value': 'string' }, ], 'Region': 'string' }, ], 'Summary': { 'Overview': { 'Distance': 123, 'Duration': 123 }, 'TravelOnly': { 'Duration': 123 } }, 'TravelSteps': [ { 'Distance': 123, 'Duration': 123, 'GeometryOffset': 123, 'Instruction': 'string', 'Type': 'Depart'|'Continue'|'Arrive' }, ] }, 'Geometry': { 'LineString': [ [ 123.0, ], ], 'Polyline': 'string' }, 'Language': 'string', 'PedestrianLegDetails': { 'Arrival': { 'Place': { 'Name': 'string', 'OriginalPosition': [ 123.0, ], 'Position': [ 123.0, ], 'SideOfStreet': 'Left'|'Right', 'WaypointIndex': 123 }, 'Time': 'string' }, 'Departure': { 'Place': { 'Name': 'string', 'OriginalPosition': [ 123.0, ], 'Position': [ 123.0, ], 'SideOfStreet': 'Left'|'Right', 'WaypointIndex': 123 }, 'Time': 'string' }, 'Notices': [ { 'Code': 'AccuratePolylineUnavailable'|'Other'|'ViolatedAvoidDirtRoad'|'ViolatedAvoidTunnel'|'ViolatedPedestrianOption', 'Impact': 'High'|'Low' }, ], 'PassThroughWaypoints': [ { 'GeometryOffset': 123, 'Place': { 'OriginalPosition': [ 123.0, ], 'Position': [ 123.0, ], 'WaypointIndex': 123 } }, ], 'Spans': [ { 'BestCaseDuration': 123, 'Country': 'string', 'Distance': 123, 'Duration': 123, 'DynamicSpeed': { 'BestCaseSpeed': 123.0, 'TurnDuration': 123, 'TypicalSpeed': 123.0 }, 'FunctionalClassification': 123, 'GeometryOffset': 123, 'Incidents': [ 123, ], 'Names': [ { 'Language': 'string', 'Value': 'string' }, ], 'PedestrianAccess': [ 'Allowed'|'Indoors'|'NoThroughTraffic'|'Park'|'Stairs'|'TollRoad', ], 'Region': 'string', 'RoadAttributes': [ 'Bridge'|'BuiltUpArea'|'ControlledAccessHighway'|'DirtRoad'|'DividedRoad'|'Motorway'|'PrivateRoad'|'Ramp'|'RightHandTraffic'|'Roundabout'|'Tunnel'|'UnderConstruction', ], 'RouteNumbers': [ { 'Direction': 'East'|'North'|'South'|'West', 'Language': 'string', 'Value': 'string' }, ], 'SpeedLimit': { 'MaxSpeed': 123.0, 'Unlimited': True|False }, 'TypicalDuration': 123 }, ], 'Summary': { 'Overview': { 'Distance': 123, 'Duration': 123 }, 'TravelOnly': { 'Duration': 123 } }, 'TravelSteps': [ { 'ContinueStepDetails': { 'Intersection': [ { 'Language': 'string', 'Value': 'string' }, ] }, 'CurrentRoad': { 'RoadName': [ { 'Language': 'string', 'Value': 'string' }, ], 'RouteNumber': [ { 'Direction': 'East'|'North'|'South'|'West', 'Language': 'string', 'Value': 'string' }, ], 'Towards': [ { 'Language': 'string', 'Value': 'string' }, ], 'Type': 'Highway'|'Rural'|'Urban' }, 'Distance': 123, 'Duration': 123, 'ExitNumber': [ { 'Language': 'string', 'Value': 'string' }, ], 'GeometryOffset': 123, 'Instruction': 'string', 'KeepStepDetails': { 'Intersection': [ { 'Language': 'string', 'Value': 'string' }, ], 'SteeringDirection': 'Left'|'Right'|'Straight', 'TurnAngle': 123.0, 'TurnIntensity': 'Sharp'|'Slight'|'Typical' }, 'NextRoad': { 'RoadName': [ { 'Language': 'string', 'Value': 'string' }, ], 'RouteNumber': [ { 'Direction': 'East'|'North'|'South'|'West', 'Language': 'string', 'Value': 'string' }, ], 'Towards': [ { 'Language': 'string', 'Value': 'string' }, ], 'Type': 'Highway'|'Rural'|'Urban' }, 'RoundaboutEnterStepDetails': { 'Intersection': [ { 'Language': 'string', 'Value': 'string' }, ], 'SteeringDirection': 'Left'|'Right'|'Straight', 'TurnAngle': 123.0, 'TurnIntensity': 'Sharp'|'Slight'|'Typical' }, 'RoundaboutExitStepDetails': { 'Intersection': [ { 'Language': 'string', 'Value': 'string' }, ], 'RelativeExit': 123, 'RoundaboutAngle': 123.0, 'SteeringDirection': 'Left'|'Right'|'Straight' }, 'RoundaboutPassStepDetails': { 'Intersection': [ { 'Language': 'string', 'Value': 'string' }, ], 'SteeringDirection': 'Left'|'Right'|'Straight', 'TurnAngle': 123.0, 'TurnIntensity': 'Sharp'|'Slight'|'Typical' }, 'Signpost': { 'Labels': [ { 'RouteNumber': { 'Direction': 'East'|'North'|'South'|'West', 'Language': 'string', 'Value': 'string' }, 'Text': { 'Language': 'string', 'Value': 'string' } }, ] }, 'TurnStepDetails': { 'Intersection': [ { 'Language': 'string', 'Value': 'string' }, ], 'SteeringDirection': 'Left'|'Right'|'Straight', 'TurnAngle': 123.0, 'TurnIntensity': 'Sharp'|'Slight'|'Typical' }, 'Type': 'Arrive'|'Continue'|'Depart'|'Keep'|'RoundaboutEnter'|'RoundaboutExit'|'RoundaboutPass'|'Turn'|'Exit'|'Ramp'|'UTurn' }, ] }, 'TravelMode': 'Car'|'Ferry'|'Pedestrian'|'Scooter'|'Truck', 'Type': 'Ferry'|'Pedestrian'|'Vehicle', 'VehicleLegDetails': { 'Arrival': { 'Place': { 'Name': 'string', 'OriginalPosition': [ 123.0, ], 'Position': [ 123.0, ], 'SideOfStreet': 'Left'|'Right', 'WaypointIndex': 123 }, 'Time': 'string' }, 'Departure': { 'Place': { 'Name': 'string', 'OriginalPosition': [ 123.0, ], 'Position': [ 123.0, ], 'SideOfStreet': 'Left'|'Right', 'WaypointIndex': 123 }, 'Time': 'string' }, 'Incidents': [ { 'Description': 'string', 'EndTime': 'string', 'Severity': 'Critical'|'High'|'Medium'|'Low', 'StartTime': 'string', 'Type': 'Accident'|'Congestion'|'Construction'|'DisabledVehicle'|'LaneRestriction'|'MassTransit'|'Other'|'PlannedEvent'|'RoadClosure'|'RoadHazard'|'Weather' }, ], 'Notices': [ { 'Code': 'AccuratePolylineUnavailable'|'Other'|'PotentialViolatedAvoidTollRoadUsage'|'PotentialViolatedCarpoolUsage'|'PotentialViolatedTurnRestrictionUsage'|'PotentialViolatedVehicleRestrictionUsage'|'PotentialViolatedZoneRestrictionUsage'|'SeasonalClosure'|'TollsDataTemporarilyUnavailable'|'TollsDataUnavailable'|'TollTransponder'|'ViolatedAvoidControlledAccessHighway'|'ViolatedAvoidDifficultTurns'|'ViolatedAvoidDirtRoad'|'ViolatedAvoidSeasonalClosure'|'ViolatedAvoidTollRoad'|'ViolatedAvoidTollTransponder'|'ViolatedAvoidTruckRoadType'|'ViolatedAvoidTunnel'|'ViolatedAvoidUTurns'|'ViolatedBlockedRoad'|'ViolatedCarpool'|'ViolatedEmergencyGate'|'ViolatedStartDirection'|'ViolatedTurnRestriction'|'ViolatedVehicleRestriction'|'ViolatedZoneRestriction', 'Details': [ { 'Title': 'string', 'ViolatedConstraints': { 'AllHazardsRestricted': True|False, 'AxleCount': { 'Min': 123, 'Max': 123 }, 'HazardousCargos': [ 'Combustible'|'Corrosive'|'Explosive'|'Flammable'|'Gas'|'HarmfulToWater'|'Organic'|'Other'|'Poison'|'PoisonousInhalation'|'Radioactive', ], 'MaxHeight': 123, 'MaxKpraLength': 123, 'MaxLength': 123, 'MaxPayloadCapacity': 123, 'MaxWeight': { 'Type': 'Current'|'Gross'|'Unknown', 'Value': 123 }, 'MaxWeightPerAxle': 123, 'MaxWeightPerAxleGroup': { 'Single': 123, 'Tandem': 123, 'Triple': 123, 'Quad': 123, 'Quint': 123 }, 'MaxWidth': 123, 'Occupancy': { 'Min': 123, 'Max': 123 }, 'RestrictedTimes': 'string', 'TimeDependent': True|False, 'TrailerCount': { 'Min': 123, 'Max': 123 }, 'TravelMode': True|False, 'TruckRoadType': 'string', 'TruckType': 'LightTruck'|'StraightTruck'|'Tractor', 'TunnelRestrictionCode': 'string' } }, ], 'Impact': 'High'|'Low' }, ], 'PassThroughWaypoints': [ { 'GeometryOffset': 123, 'Place': { 'OriginalPosition': [ 123.0, ], 'Position': [ 123.0, ], 'WaypointIndex': 123 } }, ], 'Spans': [ { 'BestCaseDuration': 123, 'CarAccess': [ 'Allowed'|'NoThroughTraffic'|'TollRoad', ], 'Country': 'string', 'Distance': 123, 'Duration': 123, 'DynamicSpeed': { 'BestCaseSpeed': 123.0, 'TurnDuration': 123, 'TypicalSpeed': 123.0 }, 'FunctionalClassification': 123, 'Gate': 'Emergency'|'KeyAccess'|'PermissionRequired', 'GeometryOffset': 123, 'Incidents': [ 123, ], 'Names': [ { 'Language': 'string', 'Value': 'string' }, ], 'Notices': [ 123, ], 'RailwayCrossing': 'Protected'|'Unprotected', 'Region': 'string', 'RoadAttributes': [ 'Bridge'|'BuiltUpArea'|'ControlledAccessHighway'|'DirtRoad'|'DividedRoad'|'Motorway'|'PrivateRoad'|'Ramp'|'RightHandTraffic'|'Roundabout'|'Tunnel'|'UnderConstruction', ], 'RouteNumbers': [ { 'Direction': 'East'|'North'|'South'|'West', 'Language': 'string', 'Value': 'string' }, ], 'ScooterAccess': [ 'Allowed'|'NoThroughTraffic'|'TollRoad', ], 'SpeedLimit': { 'MaxSpeed': 123.0, 'Unlimited': True|False }, 'TollSystems': [ 123, ], 'TruckAccess': [ 'Allowed'|'NoThroughTraffic'|'TollRoad', ], 'TruckRoadTypes': [ 123, ], 'TypicalDuration': 123, 'Zones': [ 123, ] }, ], 'Summary': { 'Overview': { 'BestCaseDuration': 123, 'Distance': 123, 'Duration': 123, 'TypicalDuration': 123 }, 'TravelOnly': { 'BestCaseDuration': 123, 'Duration': 123, 'TypicalDuration': 123 } }, 'Tolls': [ { 'Country': 'string', 'PaymentSites': [ { 'Name': 'string', 'Position': [ 123.0, ] }, ], 'Rates': [ { 'ApplicableTimes': 'string', 'ConvertedPrice': { 'Currency': 'string', 'Estimate': True|False, 'PerDuration': 123, 'Range': True|False, 'RangeValue': { 'Min': 123.0, 'Max': 123.0 }, 'Value': 123.0 }, 'Id': 'string', 'LocalPrice': { 'Currency': 'string', 'Estimate': True|False, 'PerDuration': 123, 'Range': True|False, 'RangeValue': { 'Min': 123.0, 'Max': 123.0 }, 'Value': 123.0 }, 'Name': 'string', 'Pass': { 'IncludesReturnTrip': True|False, 'SeniorPass': True|False, 'TransferCount': 123, 'TripCount': 123, 'ValidityPeriod': { 'Period': 'Annual'|'Days'|'ExtendedAnnual'|'Minutes'|'Months', 'PeriodCount': 123 } }, 'PaymentMethods': [ 'BankCard'|'Cash'|'CashExact'|'CreditCard'|'PassSubscription'|'TravelCard'|'Transponder'|'VideoToll', ], 'Transponders': [ { 'SystemName': 'string' }, ] }, ], 'Systems': [ 123, ] }, ], 'TollSystems': [ { 'Name': 'string' }, ], 'TravelSteps': [ { 'ContinueHighwayStepDetails': { 'Intersection': [ { 'Language': 'string', 'Value': 'string' }, ], 'SteeringDirection': 'Left'|'Right'|'Straight', 'TurnAngle': 123.0, 'TurnIntensity': 'Sharp'|'Slight'|'Typical' }, 'ContinueStepDetails': { 'Intersection': [ { 'Language': 'string', 'Value': 'string' }, ] }, 'CurrentRoad': { 'RoadName': [ { 'Language': 'string', 'Value': 'string' }, ], 'RouteNumber': [ { 'Direction': 'East'|'North'|'South'|'West', 'Language': 'string', 'Value': 'string' }, ], 'Towards': [ { 'Language': 'string', 'Value': 'string' }, ], 'Type': 'Highway'|'Rural'|'Urban' }, 'Distance': 123, 'Duration': 123, 'EnterHighwayStepDetails': { 'Intersection': [ { 'Language': 'string', 'Value': 'string' }, ], 'SteeringDirection': 'Left'|'Right'|'Straight', 'TurnAngle': 123.0, 'TurnIntensity': 'Sharp'|'Slight'|'Typical' }, 'ExitNumber': [ { 'Language': 'string', 'Value': 'string' }, ], 'ExitStepDetails': { 'Intersection': [ { 'Language': 'string', 'Value': 'string' }, ], 'RelativeExit': 123, 'SteeringDirection': 'Left'|'Right'|'Straight', 'TurnAngle': 123.0, 'TurnIntensity': 'Sharp'|'Slight'|'Typical' }, 'GeometryOffset': 123, 'Instruction': 'string', 'KeepStepDetails': { 'Intersection': [ { 'Language': 'string', 'Value': 'string' }, ], 'SteeringDirection': 'Left'|'Right'|'Straight', 'TurnAngle': 123.0, 'TurnIntensity': 'Sharp'|'Slight'|'Typical' }, 'NextRoad': { 'RoadName': [ { 'Language': 'string', 'Value': 'string' }, ], 'RouteNumber': [ { 'Direction': 'East'|'North'|'South'|'West', 'Language': 'string', 'Value': 'string' }, ], 'Towards': [ { 'Language': 'string', 'Value': 'string' }, ], 'Type': 'Highway'|'Rural'|'Urban' }, 'RampStepDetails': { 'Intersection': [ { 'Language': 'string', 'Value': 'string' }, ], 'SteeringDirection': 'Left'|'Right'|'Straight', 'TurnAngle': 123.0, 'TurnIntensity': 'Sharp'|'Slight'|'Typical' }, 'RoundaboutEnterStepDetails': { 'Intersection': [ { 'Language': 'string', 'Value': 'string' }, ], 'SteeringDirection': 'Left'|'Right'|'Straight', 'TurnAngle': 123.0, 'TurnIntensity': 'Sharp'|'Slight'|'Typical' }, 'RoundaboutExitStepDetails': { 'Intersection': [ { 'Language': 'string', 'Value': 'string' }, ], 'RelativeExit': 123, 'RoundaboutAngle': 123.0, 'SteeringDirection': 'Left'|'Right'|'Straight' }, 'RoundaboutPassStepDetails': { 'Intersection': [ { 'Language': 'string', 'Value': 'string' }, ], 'SteeringDirection': 'Left'|'Right'|'Straight', 'TurnAngle': 123.0, 'TurnIntensity': 'Sharp'|'Slight'|'Typical' }, 'Signpost': { 'Labels': [ { 'RouteNumber': { 'Direction': 'East'|'North'|'South'|'West', 'Language': 'string', 'Value': 'string' }, 'Text': { 'Language': 'string', 'Value': 'string' } }, ] }, 'TurnStepDetails': { 'Intersection': [ { 'Language': 'string', 'Value': 'string' }, ], 'SteeringDirection': 'Left'|'Right'|'Straight', 'TurnAngle': 123.0, 'TurnIntensity': 'Sharp'|'Slight'|'Typical' }, 'Type': 'Arrive'|'Continue'|'ContinueHighway'|'Depart'|'EnterHighway'|'Exit'|'Keep'|'Ramp'|'RoundaboutEnter'|'RoundaboutExit'|'RoundaboutPass'|'Turn'|'UTurn', 'UTurnStepDetails': { 'Intersection': [ { 'Language': 'string', 'Value': 'string' }, ], 'SteeringDirection': 'Left'|'Right'|'Straight', 'TurnAngle': 123.0, 'TurnIntensity': 'Sharp'|'Slight'|'Typical' } }, ], 'TruckRoadTypes': [ 'string', ], 'Zones': [ { 'Category': 'CongestionPricing'|'Environmental'|'Vignette', 'Name': 'string' }, ] } }, ], 'MajorRoadLabels': [ { 'RoadName': { 'Language': 'string', 'Value': 'string' }, 'RouteNumber': { 'Direction': 'East'|'North'|'South'|'West', 'Language': 'string', 'Value': 'string' } }, ], 'Summary': { 'Distance': 123, 'Duration': 123, 'Tolls': { 'Total': { 'Currency': 'string', 'Estimate': True|False, 'Range': True|False, 'RangeValue': { 'Min': 123.0, 'Max': 123.0 }, 'Value': 123.0 } } } }, ] }
Response Structure
(dict) –
LegGeometryFormat (string) –
Specifies the format of the geometry returned for each leg of the route.
Notices (list) –
Notices are additional information returned that indicate issues that occurred during route calculation.
(dict) –
Notices are additional information returned that indicate issues that occurred during route calculation.
Code (string) –
Code corresponding to the issue.
Impact (string) –
Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.
PricingBucket (string) –
The pricing bucket for which the query is charged at.
Routes (list) –
The path from the origin to the destination.
(dict) –
The route.
Legs (list) –
A leg is a section of a route from one waypoint to the next. A leg could be of type Vehicle, Pedestrian or Ferry. Legs of different types could occur together within a single route. For example, a car employing the use of a Ferry will contain Vehicle legs corresponding to journey on land, and Ferry legs corresponding to the journey via Ferry.
(dict) –
A leg is a section of a route from one waypoint to the next. A leg could be of type Vehicle, Pedestrian or Ferry. Legs of different types could occur together within a single route. For example, a car employing the use of a Ferry will contain Vehicle legs corresponding to journey on land, and Ferry legs corresponding to the journey via Ferry.
FerryLegDetails (dict) –
FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific
AfterTravelSteps (list) –
Steps of a leg that must be performed after the travel portion of the leg.
(dict) –
Steps of a leg that must be performed after the travel portion of the leg.
Duration (integer) –
Duration of the step.
Unit:
secondsInstruction (string) –
Brief description of the step in the requested language.
Note
Only available when the TravelStepType is Default.
Type (string) –
Type of the step.
Arrival (dict) –
Details corresponding to the arrival for the leg.
Place (dict) –
The place details.
Name (string) –
The name of the place.
OriginalPosition (list) –
Position provided in the request.
(float) –
Position (list) –
Position defined as
[longitude, latitude].(float) –
WaypointIndex (integer) –
Index of the waypoint in the request.
Time (string) –
The time.
BeforeTravelSteps (list) –
Steps of a leg that must be performed before the travel portion of the leg.
(dict) –
Steps of a leg that must be performed before the travel portion of the leg.
Duration (integer) –
Duration of the step.
Unit:
secondsInstruction (string) –
Brief description of the step in the requested language.
Note
Only available when the TravelStepType is Default.
Type (string) –
Type of the step.
Departure (dict) –
Details corresponding to the departure for the leg.
Place (dict) –
The place details.
Name (string) –
The name of the place.
OriginalPosition (list) –
Position provided in the request.
(float) –
Position (list) –
Position defined as
[longitude, latitude].(float) –
WaypointIndex (integer) –
Index of the waypoint in the request.
Time (string) –
The time.
Notices (list) –
Notices are additional information returned that indicate issues that occurred during route calculation.
(dict) –
Notices are additional information returned that indicate issues that occurred during route calculation.
Code (string) –
Code corresponding to the issue.
Impact (string) –
Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.
PassThroughWaypoints (list) –
Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.
(dict) –
If the waypoint should be treated as a stop. If yes, the route is split up into different legs around the stop.
GeometryOffset (integer) –
Offset in the leg geometry corresponding to the start of this step.
Place (dict) –
The place details.
OriginalPosition (list) –
Position provided in the request.
(float) –
Position (list) –
Position defined as
[longitude, latitude].(float) –
WaypointIndex (integer) –
Index of the waypoint in the request.
RouteName (string) –
Route name of the ferry line.
Spans (list) –
Spans that were computed for the requested SpanAdditionalFeatures.
(dict) –
Span computed for the requested SpanAdditionalFeatures.
Country (string) –
3 letter Country code corresponding to the Span.
Distance (integer) –
Distance of the computed span. This feature doesn’t split a span, but is always computed on a span split by other properties.
Duration (integer) –
Duration of the computed span. This feature doesn’t split a span, but is always computed on a span split by other properties.
Unit:
secondsGeometryOffset (integer) –
Offset in the leg geometry corresponding to the start of this span.
Names (list) –
Provides an array of names of the ferry span in available languages.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
Region (string) –
2-3 letter Region code corresponding to the Span. This is either a province or a state.
Summary (dict) –
Summarized details of the leg.
Overview (dict) –
Summarized details for the leg including before travel, travel and after travel steps.
Distance (integer) –
Distance of the step.
Duration (integer) –
Duration of the step.
Unit:
seconds
TravelOnly (dict) –
Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is in meters
Duration (integer) –
Total duration in free flowing traffic, which is the best case or shortest duration possible to cover the leg.
Unit:
seconds
TravelSteps (list) –
Steps of a leg that must be performed before the travel portion of the leg.
(dict) –
Steps of a leg that must be performed during the travel portion of the leg.
Distance (integer) –
Distance of the step.
Duration (integer) –
Duration of the step.
Unit:
secondsGeometryOffset (integer) –
Offset in the leg geometry corresponding to the start of this step.
Instruction (string) –
Brief description of the step in the requested language.
Note
Only available when the TravelStepType is Default.
Type (string) –
Type of the step.
Geometry (dict) –
Geometry of the area to be avoided.
LineString (list) –
An ordered list of positions used to plot a route on a map.
Note
LineString and Polyline are mutually exclusive properties.
(list) –
(float) –
Polyline (string) –
An ordered list of positions used to plot a route on a map in a lossy compression format.
Note
LineString and Polyline are mutually exclusive properties.
Language (string) –
List of languages for instructions within steps in the response.
PedestrianLegDetails (dict) –
Details related to the pedestrian leg.
Arrival (dict) –
Details corresponding to the arrival for the leg.
Place (dict) –
The place details.
Name (string) –
The name of the place.
OriginalPosition (list) –
Position provided in the request.
(float) –
Position (list) –
Position defined as
[longitude, latitude].(float) –
SideOfStreet (string) –
Options to configure matching the provided position to a side of the street.
WaypointIndex (integer) –
Index of the waypoint in the request.
Time (string) –
The time.
Departure (dict) –
Details corresponding to the departure for the leg.
Place (dict) –
The place details.
Name (string) –
The name of the place.
OriginalPosition (list) –
Position provided in the request.
(float) –
Position (list) –
Position defined as
[longitude, latitude].(float) –
SideOfStreet (string) –
Options to configure matching the provided position to a side of the street.
WaypointIndex (integer) –
Index of the waypoint in the request.
Time (string) –
The time.
Notices (list) –
Notices are additional information returned that indicate issues that occurred during route calculation.
(dict) –
Notices are additional information returned that indicate issues that occurred during route calculation.
Code (string) –
Code corresponding to the issue.
Impact (string) –
Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.
PassThroughWaypoints (list) –
Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.
(dict) –
If the waypoint should be treated as a stop. If yes, the route is split up into different legs around the stop.
GeometryOffset (integer) –
Offset in the leg geometry corresponding to the start of this step.
Place (dict) –
The place details.
OriginalPosition (list) –
Position provided in the request.
(float) –
Position (list) –
Position defined as
[longitude, latitude].(float) –
WaypointIndex (integer) –
Index of the waypoint in the request.
Spans (list) –
Spans that were computed for the requested SpanAdditionalFeatures.
(dict) –
Span computed for the requested SpanAdditionalFeatures.
BestCaseDuration (integer) –
Duration of the computed span without traffic congestion.
Unit:
secondsCountry (string) –
3 letter Country code corresponding to the Span.
Distance (integer) –
Distance of the computed span. This feature doesn’t split a span, but is always computed on a span split by other properties.
Duration (integer) –
Duration of the computed span. This feature doesn’t split a span, but is always computed on a span split by other properties.
Unit:
secondsDynamicSpeed (dict) –
Dynamic speed details corresponding to the span.
Unit:
KilometersPerHourBestCaseSpeed (float) –
Estimated speed while traversing the span without traffic congestion.
Unit:
KilometersPerHourTurnDuration (integer) –
Estimated time to turn from this span into the next.
Unit:
secondsTypicalSpeed (float) –
Estimated speed while traversing the span under typical traffic congestion.
Unit:
KilometersPerHour
FunctionalClassification (integer) –
Functional classification of the road segment corresponding to the span.
GeometryOffset (integer) –
Offset in the leg geometry corresponding to the start of this span.
Incidents (list) –
Incidents corresponding to the span. These index into the Incidents in the parent Leg.
(integer) –
Names (list) –
Provides an array of names of the pedestrian span in available languages.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
PedestrianAccess (list) –
Access attributes for a pedestrian corresponding to the span.
(string) –
Region (string) –
2-3 letter Region code corresponding to the Span. This is either a province or a state.
RoadAttributes (list) –
Attributes for the road segment corresponding to the span.
(string) –
RouteNumbers (list) –
Designated route name or number corresponding to the span.
(dict) –
The route number.
Direction (string) –
Directional identifier of the route.
Language (string) –
List of languages for instructions corresponding to the route number.
Value (string) –
The route number.
SpeedLimit (dict) –
Speed limit details corresponding to the span.
Unit:
KilometersPerHourMaxSpeed (float) –
Maximum speed.
Unit:
KilometersPerHourUnlimited (boolean) –
If the span doesn’t have a speed limit like the Autobahn.
TypicalDuration (integer) –
Duration of the computed span under typical traffic congestion.
Unit:
seconds
Summary (dict) –
Summarized details of the leg.
Overview (dict) –
Summarized details for the leg including before travel, travel and after travel steps.
Distance (integer) –
Distance of the step.
Duration (integer) –
Duration of the step.
TravelOnly (dict) –
Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is in meters
Duration (integer) –
Duration of the step.
Unit:
seconds
TravelSteps (list) –
Steps of a leg that must be performed before the travel portion of the leg.
(dict) –
Steps of a leg that must be performed during the travel portion of the leg.
ContinueStepDetails (dict) –
Details related to the continue step.
Intersection (list) –
Name of the intersection, if applicable to the step.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
CurrentRoad (dict) –
Details of the current road. See RouteRoad for details of sub-attributes.
RoadName (list) –
Name of the road (localized).
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
RouteNumber (list) –
Route number of the road.
(dict) –
The route number.
Direction (string) –
Directional identifier of the route.
Language (string) –
List of languages for instructions corresponding to the route number.
Value (string) –
The route number.
Towards (list) –
Names of destinations that can be reached when traveling on the road.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
Type (string) –
The type of road.
Distance (integer) –
Distance of the step.
Duration (integer) –
Duration of the step.
Unit:
secondsExitNumber (list) –
Exit number of the road exit, if applicable.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
GeometryOffset (integer) –
Offset in the leg geometry corresponding to the start of this step.
Instruction (string) –
Brief description of the step in the requested language.
Note
Only available when the TravelStepType is Default.
KeepStepDetails (dict) –
Details that are specific to a Keep step.
Intersection (list) –
Name of the intersection, if applicable to the step.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
SteeringDirection (string) –
Steering direction for the step.
TurnAngle (float) –
Angle of the turn.
TurnIntensity (string) –
Intensity of the turn.
NextRoad (dict) –
Details of the next road. See RouteRoad for details of sub-attributes.
RoadName (list) –
Name of the road (localized).
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
RouteNumber (list) –
Route number of the road.
(dict) –
The route number.
Direction (string) –
Directional identifier of the route.
Language (string) –
List of languages for instructions corresponding to the route number.
Value (string) –
The route number.
Towards (list) –
Names of destinations that can be reached when traveling on the road.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
Type (string) –
The type of road.
RoundaboutEnterStepDetails (dict) –
Details that are specific to a Roundabout Enter step.
Intersection (list) –
Name of the intersection, if applicable to the step.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
SteeringDirection (string) –
Steering direction for the step.
TurnAngle (float) –
Angle of the turn.
TurnIntensity (string) –
Intensity of the turn.
RoundaboutExitStepDetails (dict) –
Details that are specific to a Roundabout Exit step.
Intersection (list) –
Name of the intersection, if applicable to the step.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
RelativeExit (integer) –
Exit to be taken.
RoundaboutAngle (float) –
Angle of the roundabout.
SteeringDirection (string) –
Steering direction for the step.
RoundaboutPassStepDetails (dict) –
Details that are specific to a Roundabout Pass step.
Intersection (list) –
Name of the intersection, if applicable to the step.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
SteeringDirection (string) –
Steering direction for the step.
TurnAngle (float) –
Angle of the turn.
TurnIntensity (string) –
Intensity of the turn.
Signpost (dict) –
Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.
Labels (list) –
Labels present on the sign post.
(dict) –
Labels presented on the sign post.
RouteNumber (dict) –
Route number of the road.
Direction (string) –
Directional identifier of the route.
Language (string) –
List of languages for instructions corresponding to the route number.
Value (string) –
The route number.
Text (dict) –
The Signpost text.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
TurnStepDetails (dict) –
Details that are specific to a turn step.
Intersection (list) –
Name of the intersection, if applicable to the step.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
SteeringDirection (string) –
Steering direction for the step.
TurnAngle (float) –
Angle of the turn.
TurnIntensity (string) –
Intensity of the turn.
Type (string) –
Type of the step.
TravelMode (string) –
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
Default Value:
CarType (string) –
Type of the leg.
VehicleLegDetails (dict) –
Details related to the vehicle leg.
Arrival (dict) –
Details corresponding to the arrival for the leg.
Place (dict) –
The place details.
Name (string) –
The name of the place.
OriginalPosition (list) –
Position provided in the request.
(float) –
Position (list) –
Position defined as
[longitude, latitude].(float) –
SideOfStreet (string) –
Options to configure matching the provided position to a side of the street.
WaypointIndex (integer) –
Index of the waypoint in the request.
Time (string) –
The time.
Departure (dict) –
Details corresponding to the departure for the leg.
Place (dict) –
The place details.
Name (string) –
The name of the place.
OriginalPosition (list) –
Position provided in the request.
(float) –
Position (list) –
Position defined as
[longitude, latitude].(float) –
SideOfStreet (string) –
Options to configure matching the provided position to a side of the street.
WaypointIndex (integer) –
Index of the waypoint in the request.
Time (string) –
The departure time.
Incidents (list) –
Incidents corresponding to this leg of the route.
(dict) –
Incidents corresponding to this leg of the route.
Description (string) –
Brief readable description of the incident.
EndTime (string) –
End timestamp of the incident.
Severity (string) –
Severity of the incident Critical - The part of the route the incident affects is unusable. Major- Major impact on the leg duration, for example stop and go Minor- Minor impact on the leg duration, for example traffic jam Low - Low on duration, for example slightly increased traffic
StartTime (string) –
Start time of the incident.
Type (string) –
Type of the incident.
Notices (list) –
Notices are additional information returned that indicate issues that occurred during route calculation.
(dict) –
Notices are additional information returned that indicate issues that occurred during route calculation.
Code (string) –
Code corresponding to the issue.
Details (list) –
Additional details of the notice.
(dict) –
Additional details of the notice.
Title (string) –
The notice title.
ViolatedConstraints (dict) –
Any violated constraints.
AllHazardsRestricted (boolean) –
This restriction applies to truck cargo, where the resulting route excludes roads on which hazardous materials are prohibited from being transported.
AxleCount (dict) –
Total number of axles of the vehicle.
Min (integer) –
Minimum value for the range.
Max (integer) –
Maximum value for the range.
HazardousCargos (list) –
List of Hazardous cargo contained in the vehicle.
(string) –
MaxHeight (integer) –
The maximum height of the vehicle.
MaxKpraLength (integer) –
The maximum Kpra length of the vehicle.
Unit:
centimetersMaxLength (integer) –
The maximum length of the vehicle.
MaxPayloadCapacity (integer) –
The maximum load capacity of the vehicle.
Unit:
kilogramsMaxWeight (dict) –
The maximum weight of the route.
Unit:
KilogramsType (string) –
The type of constraint.
Value (integer) –
The constraint value.
Unit:
Kilograms
MaxWeightPerAxle (integer) –
The maximum weight per axle of the vehicle.
Unit:
KilogramsMaxWeightPerAxleGroup (dict) –
The maximum weight per axle group of the vehicle.
Unit:
KilogramsSingle (integer) –
Weight for single axle group.
Unit:
KilogramsTandem (integer) –
Weight for tandem axle group.
Unit:
KilogramsTriple (integer) –
Weight for triple axle group.
Unit:
KilogramsQuad (integer) –
Weight for quad axle group.
Unit:
KilogramsQuint (integer) –
Weight for quad quint group.
Unit:
Kilograms
MaxWidth (integer) –
The maximum width of the vehicle.
Occupancy (dict) –
The number of occupants in the vehicle.
Default Value:
1Min (integer) –
Minimum value for the range.
Max (integer) –
Maximum value for the range.
RestrictedTimes (string) –
Access radius restrictions based on time.
TimeDependent (boolean) –
The time dependent constraint.
TrailerCount (dict) –
Number of trailers attached to the vehicle.
Default Value:
0Min (integer) –
Minimum value for the range.
Max (integer) –
Maximum value for the range.
TravelMode (boolean) –
Travel mode corresponding to the leg.
TruckRoadType (string) –
Truck road type identifiers.
BK1throughBK4apply only to Sweden.A2,A4,B2,B4,C,D,ET2,ET4apply only to Mexico.Note
There are currently no other supported values as of 26th April 2024.
TruckType (string) –
Type of the truck.
TunnelRestrictionCode (string) –
The tunnel restriction code.
Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.
Tunnel Category B
Risk Level: Limited risk
Restrictions: Few restrictions
Tunnel Category C
Risk Level: Medium risk
Restrictions: Some restrictions
Tunnel Category D
Risk Level: High risk
Restrictions: Many restrictions occur
Tunnel Category E
Risk Level: Very high risk
Restrictions: Restricted tunnel
Impact (string) –
Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.
PassThroughWaypoints (list) –
Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.
(dict) –
If the waypoint should be treated as a stop. If yes, the route is split up into different legs around the stop.
GeometryOffset (integer) –
Offset in the leg geometry corresponding to the start of this step.
Place (dict) –
The place details.
OriginalPosition (list) –
Position provided in the request.
(float) –
Position (list) –
Position defined as
[longitude, latitude].(float) –
WaypointIndex (integer) –
Index of the waypoint in the request.
Spans (list) –
Spans that were computed for the requested SpanAdditionalFeatures.
(dict) –
Span computed for the requested SpanAdditionalFeatures.
BestCaseDuration (integer) –
Duration of the computed span without traffic congestion.
Unit:
secondsCarAccess (list) –
Access attributes for a car corresponding to the span.
(string) –
Country (string) –
3 letter Country code corresponding to the Span.
Distance (integer) –
Distance of the computed span. This feature doesn’t split a span, but is always computed on a span split by other properties.
Duration (integer) –
Duration of the computed span. This feature doesn’t split a span, but is always computed on a span split by other properties.
Unit:
secondsDynamicSpeed (dict) –
Dynamic speed details corresponding to the span.
Unit:
KilometersPerHourBestCaseSpeed (float) –
Estimated speed while traversing the span without traffic congestion.
Unit:
KilometersPerHourTurnDuration (integer) –
Estimated time to turn from this span into the next.
Unit:
secondsTypicalSpeed (float) –
Estimated speed while traversing the span under typical traffic congestion.
Unit:
KilometersPerHour
FunctionalClassification (integer) –
Functional classification of the road segment corresponding to the span.
Gate (string) –
Attributes corresponding to a gate. The gate is present at the end of the returned span.
GeometryOffset (integer) –
Offset in the leg geometry corresponding to the start of this span.
Incidents (list) –
Incidents corresponding to the span. These index into the Incidents in the parent Leg.
(integer) –
Names (list) –
Provides an array of names of the vehicle span in available languages.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
Notices (list) –
Notices are additional information returned that indicate issues that occurred during route calculation.
(integer) –
RailwayCrossing (string) –
Attributes corresponding to a railway crossing. The gate is present at the end of the returned span.
Region (string) –
2-3 letter Region code corresponding to the Span. This is either a province or a state.
RoadAttributes (list) –
Attributes for the road segment corresponding to the span.
(string) –
RouteNumbers (list) –
Designated route name or number corresponding to the span.
(dict) –
The route number.
Direction (string) –
Directional identifier of the route.
Language (string) –
List of languages for instructions corresponding to the route number.
Value (string) –
The route number.
ScooterAccess (list) –
Access attributes for a scooter corresponding to the span.
(string) –
SpeedLimit (dict) –
Speed limit details corresponding to the span.
Unit:
KilometersPerHourMaxSpeed (float) –
Maximum speed.
Unit:
KilometersPerHourUnlimited (boolean) –
If the span doesn’t have a speed limit like the Autobahn.
TollSystems (list) –
Toll systems are authorities that collect payments for the toll.
(integer) –
TruckAccess (list) –
Access attributes for a truck corresponding to the span.
(string) –
TruckRoadTypes (list) –
Truck road type identifiers.
BK1throughBK4apply only to Sweden.A2,A4,B2,B4,C,D,ET2,ET4apply only to Mexico.Note
There are currently no other supported values as of 26th April 2024.
(integer) –
TypicalDuration (integer) –
Duration of the computed span under typical traffic congestion.
Unit:
secondsZones (list) –
Zones corresponding to this leg of the route.
(integer) –
Summary (dict) –
Summarized details of the leg.
Overview (dict) –
Summarized details for the leg including before travel, travel and after travel steps.
BestCaseDuration (integer) –
Total duration in free flowing traffic, which is the best case or shortest duration possible to cover the leg.
Unit:
secondsDistance (integer) –
Distance of the step.
Duration (integer) –
Duration of the step.
Unit:
secondsTypicalDuration (integer) –
Duration of the computed span under typical traffic congestion.
Unit:
seconds
TravelOnly (dict) –
Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is in meters
BestCaseDuration (integer) –
Total duration in free flowing traffic, which is the best case or shortest duration possible to cover the leg.
Unit:
secondsDuration (integer) –
Duration of the step.
Unit:
secondsTypicalDuration (integer) –
Duration of the computed span under typical traffic congestion.
Unit:
seconds
Tolls (list) –
Toll related options.
(dict) –
Provides details about toll information along a route, including the payment sites, applicable toll rates, toll systems, and the country associated with the toll collection.
Country (string) –
The alpha-2 or alpha-3 character code for the country.
PaymentSites (list) –
Locations or sites where the toll fare is collected.
(dict) –
Locations or sites where the toll fare is collected.
Name (string) –
Name of the payment site.
Position (list) –
Position defined as
[longitude, latitude].(float) –
Rates (list) –
Toll rates that need to be paid to travel this leg of the route.
(dict) –
The toll rate.
ApplicableTimes (string) –
Time when the rate is valid.
ConvertedPrice (dict) –
Price in the converted currency as specified in the request.
Currency (string) –
Currency code corresponding to the price. This is the same as Currency specified in the request.
Estimate (boolean) –
If the price is an estimate or an exact value.
PerDuration (integer) –
Duration for which the price corresponds to.
Unit:
secondsRange (boolean) –
If the price is a range or an exact value. If any of the toll fares making up the route is a range, the overall price is also a range.
RangeValue (dict) –
Price range with a minimum and maximum value, if a range.
Min (float) –
Minimum price.
Max (float) –
Maximum price.
Value (float) –
Exact price, if not a range.
Id (string) –
The Toll rate Id.
LocalPrice (dict) –
Price in the local regional currency.
Currency (string) –
Currency code corresponding to the price. This is the same as Currency specified in the request.
Estimate (boolean) –
If the price is an estimate or an exact value.
PerDuration (integer) –
Duration for which the price corresponds to.
Unit:
secondsRange (boolean) –
If the price is a range or an exact value. If any of the toll fares making up the route is a range, the overall price is also a range.
RangeValue (dict) –
Price range with a minimum and maximum value, if a range.
Min (float) –
Minimum price.
Max (float) –
Maximum price.
Value (float) –
Exact price, if not a range.
Name (string) –
The name of the toll.
Pass (dict) –
Details if the toll rate can be a pass that supports multiple trips.
IncludesReturnTrip (boolean) –
If the pass includes the rate for the return leg of the trip.
SeniorPass (boolean) –
If the pass is only valid for senior persons.
TransferCount (integer) –
If the toll pass can be transferred, and how many times.
TripCount (integer) –
Number of trips the pass is valid for.
ValidityPeriod (dict) –
Period for which the pass is valid.
Period (string) –
Validity period.
PeriodCount (integer) –
Counts for the validity period.
PaymentMethods (list) –
Accepted payment methods at the toll.
(string) –
Transponders (list) –
Transponders for which this toll can be applied.
(dict) –
Transponders for which this toll can be applied.
SystemName (string) –
Names of the toll system collecting the toll.
Systems (list) –
Toll systems are authorities that collect payments for the toll.
(integer) –
TollSystems (list) –
Toll systems are authorities that collect payments for the toll.
(dict) –
Toll systems are authorities that collect payments for the toll.
Name (string) –
The toll system name.
TravelSteps (list) –
Steps of a leg that must be performed before the travel portion of the leg.
(dict) –
Steps of a leg that correspond to the travel portion of the leg.
ContinueHighwayStepDetails (dict) –
Details that are specific to a Continue Highway step.
Intersection (list) –
Name of the intersection, if applicable to the step.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
SteeringDirection (string) –
Steering direction for the step.
TurnAngle (float) –
Angle of the turn.
TurnIntensity (string) –
Intensity of the turn.
ContinueStepDetails (dict) –
Details that are specific to a Continue step.
Intersection (list) –
Name of the intersection, if applicable to the step.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
CurrentRoad (dict) –
Details of the current road.
RoadName (list) –
Name of the road (localized).
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
RouteNumber (list) –
Route number of the road.
(dict) –
The route number.
Direction (string) –
Directional identifier of the route.
Language (string) –
List of languages for instructions corresponding to the route number.
Value (string) –
The route number.
Towards (list) –
Names of destinations that can be reached when traveling on the road.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
Type (string) –
The type of road.
Distance (integer) –
Distance of the step.
Duration (integer) –
Duration of the step.
Unit:
secondsEnterHighwayStepDetails (dict) –
Details that are specific to a Enter Highway step.
Intersection (list) –
Name of the intersection, if applicable to the step.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
SteeringDirection (string) –
Steering direction for the step.
TurnAngle (float) –
Angle of the turn.
TurnIntensity (string) –
Intensity of the turn.
ExitNumber (list) –
Exit number of the road exit, if applicable.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
ExitStepDetails (dict) –
Details that are specific to a Roundabout Exit step.
Intersection (list) –
Name of the intersection, if applicable to the step.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
RelativeExit (integer) –
Exit to be taken.
SteeringDirection (string) –
Steering direction for the step.
TurnAngle (float) –
Angle of the turn.
TurnIntensity (string) –
Intensity of the turn.
GeometryOffset (integer) –
Offset in the leg geometry corresponding to the start of this step.
Instruction (string) –
Brief description of the step in the requested language.
Note
Only available when the TravelStepType is Default.
KeepStepDetails (dict) –
Details that are specific to a Keep step.
Intersection (list) –
Name of the intersection, if applicable to the step.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
SteeringDirection (string) –
Steering direction for the step.
TurnAngle (float) –
Angle of the turn.
TurnIntensity (string) –
Intensity of the turn.
NextRoad (dict) –
Details of the next road. See RouteRoad for details of sub-attributes.
RoadName (list) –
Name of the road (localized).
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
RouteNumber (list) –
Route number of the road.
(dict) –
The route number.
Direction (string) –
Directional identifier of the route.
Language (string) –
List of languages for instructions corresponding to the route number.
Value (string) –
The route number.
Towards (list) –
Names of destinations that can be reached when traveling on the road.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
Type (string) –
The type of road.
RampStepDetails (dict) –
Details that are specific to a Ramp step.
Intersection (list) –
Name of the intersection, if applicable to the step.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
SteeringDirection (string) –
Steering direction for the step.
TurnAngle (float) –
Angle of the turn.
TurnIntensity (string) –
Intensity of the turn.
RoundaboutEnterStepDetails (dict) –
Details that are specific to a Roundabout Enter step.
Intersection (list) –
Name of the intersection, if applicable to the step.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
SteeringDirection (string) –
Steering direction for the step.
TurnAngle (float) –
Angle of the turn.
TurnIntensity (string) –
Intensity of the turn.
RoundaboutExitStepDetails (dict) –
Details that are specific to a Roundabout Exit step.
Intersection (list) –
Name of the intersection, if applicable to the step.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
RelativeExit (integer) –
Exit to be taken.
RoundaboutAngle (float) –
Angle of the roundabout.
SteeringDirection (string) –
Steering direction for the step.
RoundaboutPassStepDetails (dict) –
Details that are specific to a Roundabout Pass step.
Intersection (list) –
Name of the intersection, if applicable to the step.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
SteeringDirection (string) –
Steering direction for the step.
TurnAngle (float) –
Angle of the turn.
TurnIntensity (string) –
Intensity of the turn.
Signpost (dict) –
Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.
Labels (list) –
Labels present on the sign post.
(dict) –
Labels presented on the sign post.
RouteNumber (dict) –
Route number of the road.
Direction (string) –
Directional identifier of the route.
Language (string) –
List of languages for instructions corresponding to the route number.
Value (string) –
The route number.
Text (dict) –
The Signpost text.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
TurnStepDetails (dict) –
Details that are specific to a Turn step.
Intersection (list) –
Name of the intersection, if applicable to the step.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
SteeringDirection (string) –
Steering direction for the step.
TurnAngle (float) –
Angle of the turn.
TurnIntensity (string) –
Intensity of the turn.
Type (string) –
Type of the step.
UTurnStepDetails (dict) –
Details that are specific to a Turn step.
Intersection (list) –
Name of the intersection, if applicable to the step.
(dict) –
The localized string.
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
SteeringDirection (string) –
Steering direction for the step.
TurnAngle (float) –
Angle of the turn.
TurnIntensity (string) –
Intensity of the turn.
TruckRoadTypes (list) –
Truck road type identifiers.
BK1throughBK4apply only to Sweden.A2,A4,B2,B4,C,D,ET2,ET4apply only to Mexico.Note
There are currently no other supported values as of 26th April 2024.
(string) –
Zones (list) –
Zones corresponding to this leg of the route.
(dict) –
The zone.
Category (string) –
The zone category.
Name (string) –
The name of the zone.
MajorRoadLabels (list) –
Important labels including names and route numbers that differentiate the current route from the alternatives presented.
(dict) –
Important labels including names and route numbers that differentiate the current route from the alternatives presented.
RoadName (dict) –
Name of the road (localized).
Language (string) –
A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can’t be provided.
Value (string) –
The value of the localized string.
RouteNumber (dict) –
Route number of the road.
Direction (string) –
Directional identifier of the route.
Language (string) –
List of languages for instructions corresponding to the route number.
Value (string) –
The route number.
Summary (dict) –
Summarized details of the leg.
Distance (integer) –
Distance of the route.
Duration (integer) –
Duration of the route.
Unit:
secondsTolls (dict) –
Toll summary for the complete route.
Total (dict) –
Total toll summary for the complete route. Total is the only summary available today.
Currency (string) –
Currency code corresponding to the price. This is the same as Currency specified in the request.
Estimate (boolean) –
If the price is an estimate or an exact value.
Range (boolean) –
If the price is a range or an exact value. If any of the toll fares making up the route is a range, the overall price is also a range.
RangeValue (dict) –
Price range with a minimum and maximum value, if a range.
Min (float) –
Minimum price.
Max (float) –
Maximum price.
Value (float) –
Exact price, if not a range.
Exceptions
LocationServiceRoutesV2.Client.exceptions.InternalServerExceptionLocationServiceRoutesV2.Client.exceptions.AccessDeniedExceptionLocationServiceRoutesV2.Client.exceptions.ValidationExceptionLocationServiceRoutesV2.Client.exceptions.ThrottlingException