Calculate Route

Service version number. The current value is 1.

Locations through which the calculated route must pass.

The content type of the response structure. If the content type is jsonp, a callback method can be specified in the query parameters.

Number of alternative routes to be calculated.

Determines whether the alternative routes to be calculated should be better with respect to the planning criteria provided than the reference route.

All alternative routes will follow the reference route for the specified minimum number of meters starting from the origin point.

All alternative routes will follow the reference route for the specified minimum number of seconds starting from the origin point.

If specified, guidance instructions will be returned (if available).

The language parameter determines the language of the guidance messages.

Re-order the route waypoints to reduce the route length.

Specifies the representation of the set of routes provided as a response.

Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time.

The directional heading of the vehicle in degrees. Entered in degrees, measured clockwise from north (so north is 0, east is 90, etc.).

Specifies which section types are explicitly reported in the route response. Can be specified multiple times.

• carTrain, ferry, tunnel or motorway
• pedestrian
• tollRoad
• tollVignette
• country
• travelMode
• traffic

Specifies the jsonp callback method.

Specifies which data should be reported for diagnosis purposes.

The date and time of departure from the origin point. Departure times apart from <i>now</i> must be specified as a dateTime.

The date and time of arrival at the destination point. It must be specified as a dateTime.

The type of route requested.

Determines whether current traffic is used in route calculations. Note that information on historic road speeds is always used.

Specifies whether the routing engine should try to avoid specific types of road segment when calculating the route. Can be specified multiple times. Possible values:

• tollRoads
• motorways
• ferries
• unpavedRoads
• carpools
• alreadyUsedRoads

The mode of travel for the requested route.

Degree of hilliness for calculating a thrilling route.

Amount that a thrilling route should wind.

Maximum speed of the vehicle in km/hour.

Weight of the vehicle in kilograms.

Weight per axle of the vehicle in kg.

Length of the vehicle in meters.

Width of the vehicle in meters.

Height of the vehicle in meters.

Indicates that the vehicle is used for commercial purposes. This means it may not be allowed on certain roads.

Indicates what kinds of hazardous materials the vehicle is carrying (if any). This means it may not be allowed on certain roads. Use these for routing in the US:

• <i>USHazmatClass1</i> Explosives
• <i>USHazmatClass2</i> Compressed gas
• <i>USHazmatClass3</i> Flammable liquids
• <i>USHazmatClass4</i> Flammable solids
• <i>USHazmatClass5</i> Oxidizers
• <i>USHazmatClass6</i> Poisons
• <i>USHazmatClass7</i> Radioactive
• <i>USHazmatClass8</i> Corrosives
• <i>USHazmatClass9</i> Miscellaneous

Use these for routing in all other countries:

• <i>otherHazmatExplosive</i> Explosives
• <i>otherHazmatGeneral</i> Miscellaneous
• <i>otherHazmatHarmfulToWater</i> Harmful to water

vehicleLoadType can be specified multiple times. This parameter is currently only considered for <b>travelMode</b>=<i>truck</i>.

Engine type of the vehicle.

Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs.

Specifies the current supply of fuel in liters.

Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour.

Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ).

Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates (i.e. KineticEnergyGained/ChemicalEnergyConsumed).

Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e. ChemicalEnergySaved/KineticEnergyLost).

Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation (i.e. PotentialEnergyGained/ChemicalEnergyConsumed).

Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e. ChemicalEnergySaved/PotentialEnergyLost).

Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs.