Calculate Route

You must include an apiKey with every request. For more information on authentication, see the Identity & Access Management Developer Guide.

A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application.

If you use the app ID/app code option, you need to include an app_id and app_code with every request. For more information on authentication, see the Identity & Access Management Developer Guide.

A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application.

If you use the app ID/app code option, you need to include an app_id and app_code with every request. For more information on authentication, see the Identity & Access Management Developer Guide.

See also WaypointParameterType

waypoint0=geo!52.5,13.4

The routing mode determines how the route is calculated.

See also RoutingModeType

Type;TransportModes;TrafficMode;Feature

&mode=fastest;car;traffic:disabled;motorway:-2

avoidareas=52.517100760,
13.3905424488;
52.5169701849,
13.391808451!
52.517000760,
13.3700424488;
52.5168701849,
13.371308451

avoidlinks=-53623477

avoidseasonalclosures=true

Examples of seasonally closed links are roads that may be closed during the winter due to weather conditions or ferries that may be out of operation for the season (based on past closure dates).

List of turn types that the route should avoid. Defaults to empty list. For details on the available values, see the description of the TurnType enumeration type.

Enum [ difficult ]

Identifiers of zones where routing engine should not take zone restrictions into account (for example in case of a special permission to access a restricted environmental zone). Allowed zones are also not considered in evaluation of the excludezonetypes parameter. Type: list of xs:unsignedLong.

To obtain identifiers of relevant zones use the getroutingzones resource.

licenseplate=lastcharacter:5&allowedzones=167772378 // ignore license plate rules in Indonesia Odd/Even scheme zones
excludezonetypes=vignette&allowedzones=508 // disable all roads where any vignette applies except vignette in Austria

To obtain identifiers of relevant zones use the getroutingzones resource.

excludezones=510,511

excludezonetypes=vignette,congestionPricing

excludecountries=AUT,CHE

departure=2018-07-04T17:00:00+02

arrival=2013-07-04T17:00:00+02

When the optional timezone offset is not specified, the time is assumed to be the local.

alternatives=3

If the view bounds are given in the request then only route shape points which fit into these bounds will be returned. The route shape beyond the view bounds is reduced to the points which are referenced by links, legs or maneuvers. A common use case for this is the drag and drop scenario where the client is only interested in a rough visual update of the route in the currently visible bounds. See also BoundingBox.

viewbounds=37.7902858,-122.4027371;
37.7890649,-122.3993039

Specifies the resolution of the view and a possible snap resolution in meters per pixel in the response. You must specify a whole, positive integer.

If you specify only one value, then this value defines the view resolution only.

You can use snap resolution to adjust waypoint links to the resolution of the client display.

resolution=viewresolution:snapresolution
resolution=300:300

A list of languages for all textual information, the first supported language is used. If there are no matching supported languages the response is an error. Defaults to en-us. See Languages for a list of supported languages.

jsonattributes=9

Name of a user-defined function used to wrap the JSON response.

Define which elements are included in the response as part of the data representation of the route. See also RouteRepresentationModeType.

Enum [ overview | display | dragNDrop | navigation | linkPaging | turnByTurn ]

Define which attributes are included in the response as part of the data representation of the route. Defaults to waypoints, summary, legs It is strongly advised to always request notes in order to be informed in case any restrictions were violated in the calculated route. See also RouteAttributeType.

Enum [ waypoints | summary | summaryByCountry | shape | boundingBox | legs | notes | routeId | groups | tickets | incidents | zones ]

Define which attributes are included in the response as part of the data representation of the route legs. Defaults to maneuvers, waypoint, length, travelTime. See also RouteLegAttributeType.

Enum [ waypoint | maneuvers | links | length | travelTime | shape | indices | boundingBox | baseTime | trafficTime | summary ]

Define which attributes are included in the response as part of the data representation of the route maneuvers. Defaults to position, length, travelTime. See also ManeuverAttributeType

Enum [ position | shape | travelTime | length | time | link | platform | roadName | nextRoadName | roadNumber | nextRoadNumber | signPost | notes | action | direction | freewayExit | freewayJunction | indices | baseTime | trafficTime | waitTime | boundingBox | roadShield | shapeQuality | nextManeuver | startAngle ]

Define which attributes are included in the response as part of the data representation of the route links. Defaults to shape, speedLimit, . See also RouteLinkAttributeType.

Enum [ consumption | dynamicSpeedInfo | flags | functionalClass | indices | length | maneuver | nextLink | nextStopName | remainDistance | remainTime | roadName | roadNumber | shape | speedLimit | timeDependentRestriction | timezone | truckRestrictions ]

generalizationtolerances=0.1,0.01

Specifies type of vehicle engine and average fuel consumption, which can be used to estimate CO2 emission for the route summary (RouteSummaryType).

See also VehicleType

vehicletype=diesel,5.5

Specifies fragments of vehicle's license plate number. The lastcharacter is currently the only supported fragment type. The license plate parameter enables evaluation of license plate based vehicle restrictions like odd/even scheme in Indonesia.

Fragment types [ lastcharacter ]

licensePlate=lastcharacter:5

Truck routing only, specifies the vehicle type. Defaults to truck.

Enum [truck | tractorTruck]

Truck routing only, specifies number of trailers pulled by the vehicle. The provided value must be between 0 and 4. Defaults to 0.

Truck routing only, specifies number of axles on the vehicle. The provided value must be between 2 and 254. Defaults to 2.

Truck routing only, list of hazardous materials in the vehicle. Please refer to the enumeration type HazardousGoodTypeType for available values. Note the value allhazardousGoods does not apply to the request parameter.

Enum [explosive | gas | flammable | combustible | organic | poison | radioActive | corrosive | poisonousInhalation | harmfulToWater | other]

Truck routing only, vehicle weight including trailers and shipped goods, in tons. The provided value must be between 0 and 1000.

Truck routing only, vehicle weight per axle in tons. The provided value must be between 0 and 1000.

Truck routing only, semicolon-separated list of vehicle weights per distinct axle groups in tons. Each weight-per-axle-group item consists of a TruckAxleGroupType (see TruckAxleGroupType for available types) and a weight value. The provided weight value must be between 0 and 1000. See Weight Per Axle Group for details.

AxleGroupType:WeightValue;AxleGroupType:WeightValue;...

&weightsPerAxleGroup=single:10;tandem:15

Truck routing only, vehicle height in meters. The provided value must be between 0 and 50.

Truck routing only, vehicle width in meters. The provided value must be between 0 and 50.

Truck routing only, vehicle length in meters. The provided value must be between 0 and 300.

Truck routing only, specifies the tunnel category to restrict certain route links. The route will pass only through tunnels of a less strict category.

Enum [ B | C | D | E ]

tunnelcategory=C

Truck routing only, specifies the penalty type on violated truck restrictions. Defaults to strict. Refer to the enumeration type TruckRestrictionPenaltyType for details on available values. Note that the route computed with the penalty type soft will use links with a violated truck restriction if there is no alternative to avoid them. The route violating truck restrictions is then indicated with dedicated route and maneuver notes in the response as demonstrated in this example.

Enum [ strict | soft ]

truckRestrictionPenalty=soft&routeattributes=notes

If set to true, all shapes inside routing response will consist of 3 values instead of 2. Third value will be elevation. If there are no elevation data available for given shape point, elevation will be interpolated from surrounding points. In case there is no elevation data available for any of the shape points, elevation will be 0.0. If jsonattributes=32, elevation cannot be returned.

returnelevation=true

If you request information on consumption, you must provide a consumption model. The possible values are default and standard. When you specify the value standard, you must provide additional information in the query parameter customconsumptiondetails

consumptionmodel=default

consumptionmodel=standard

Provides vehicle specific information for use in the consumption model. This information can include such things as the amount of energy consumed while travelling at a given speed. For details on the consumption model see Standard consumption model.

Specifies the speed profile variant for a given routing mode. The speed profile affects travel time estimation as well as roads evaluation when computing the fastest route. Note that computed routes might differ depending on a used profile. See SpeedProfileType for details.

Enum [ default | fast ]

speedProfile=fast