Calculate Route

Latitude, longitude pair (in EPSG:4326 projection), with the following constraints:

• Latitude values must be in the range [-90, +90].

• Longitude values must be in the range [-180, +180].

Example: 52.37245,4.89406

A location represented as a JSON object. The object should contain the two fields latitude and longitude each containing a number, and expressed in the same reference frame and with the same constraints as for the location type. Example: {"latitude": 52.37245, "longitude": 4.89406}

A date and time specified in RFC 3339 format with an optional time zone offset. Examples:

• 2023-12-19T16:39:57
• 2023-12-19T16:39:57-08:00

Comma-separated speedInkmh,consumptionInkWhPerHundredkm pairs with the following constraint: The speedInkmh values must be in the range [0.0, 255.0].
Example: 15.5,8.0

Specifies API version
Value: 2

Requests that the response be compressed. Value: gzip

Specifies the compression used for the request body. Currently, only gzip is supported. If not specified, no compression is assumed. This is equal to specifying identity.

Values:

• identity
• gzip

Specifies the MIME type of the body of the request.

Value: application/json

Specifies an identifier for the request.

• The value should be unique for each request.

• The value must match the regular expression '^[a-zA-Z0-9-_\.]{1,100}$'.

• If specified, the same value is sent back in the similar-named response header. Otherwise, a generated value may be sent back.

Locations through which the route is calculated. The following constraints apply:

• At least two locations must be provided.

• The first location in the sequence defines the origin and must be a location.

• The last location in the sequence defines the destination and must be a location.

• One or more optional intermediate locations (known as waypoints in this context) may be provided:

  • The maximum allowed number of waypoints is 150.

  • A waypoint of type location results in an extra leg in the response.

Values: Colon-delimited locations, with the constraints mentionned above.

Base URL for calling the API.
Value: api.tomtom.com (The default global API endpoint.)

The content type of the response structure. Only possible value:

• json

Authorization key to access the API. Value: Your valid API Key.

Specifies the API version.
Only allowed value: 2

Number of desired alternative routes to be calculated. The value provided:

• Must be an integer in the range 0-5.

• Fewer alternative routes may be returned if either fewer alternatives exist, or the requested number of alternatives is larger than the service can calculate.

Default value: 0
Maximum value: 5

When maxAlternatives is greater than 0, allows to specify the objective of computing alternative routes: finding routes that are significantly different than the reference route, or finding routes that are better than the reference route. Possible values are:

• anyRoute: returns alternative routes that are significantly different from the reference route.

• betterRoute: only returns alternative routes that are better than the reference route, according to the given planning criteria (set by routeType). If there is a road block on the reference route, then any alternative that does not contain any blockages will be considered a better route. The summary in the route response will contain information (see the planningReason parameter) about the reason for the better alternative.

Note: The betterRoute value can only be used when reconstructing a reference route. Default value: anyRoute
Other values: betterRoute

All alternative routes returned will follow the reference route (see the POST data parameters section) from the origin point of the calculateRoute request for at least this number of meters.

• Can only be used when reconstructing a route.

All alternative routes returned will follow the reference route (see the POST data parameters section) from the origin point of the calculateRoute request for at least this number of seconds.

• Can only be used when reconstructing a route.

Largest index in the array of supportingPoints per route or in joined arrays of supportingPoints per leg (see the POST data parameters section) for which supportingPoints[supportingPointIndexOfOrigin] lies on or before the origin point.
The Routing API uses this index as a hint to disambiguate situations where the supportingPoints in the POST data are not planar, or where they come back close to the origin at a later point in the reconstructed route. In these cases, the supportingPointIndexOfOrigin can explicitly identify if the origin is meant to be on the later part of the route, or not.

• Can only be used when reconstructing a route.

Minimum value: 0
Maximum value: Size of supportingPoints array - 1

The directional heading of the vehicle, in degrees starting at true North and continuing in a clockwise direction.

• North is 0 degrees.

• East is 90 degrees.

• South is 180 degrees.

• West is 270 degrees.

Maximum value: 359
Other values: 0-359

Specifies which of the section types is reported in the route response. sectionType can be specified multiple times (e.g., ...&sectionType=ferry&sectionType=traffic&...).
Possible values are:

• carTrain: sections of the route that are car trains.

• ferry: sections of the route that are ferries.

• tunnel: sections of the route that are tunnels.

• motorway: sections of the route that are motorways.

• pedestrian: sections of the route that are only suited for pedestrians.

• toll: sections of the route that require a toll to be paid.

• country: sections indicating which countries the route is in.

• travelMode: sections in relation to the request parameter travelMode.

• traffic: sections of the route that contain traffic information.

• carpool: sections of the route that require use of carpool (HOV/High Occupancy Vehicle) lanes.

• urban: sections of the route that are located within urban areas.

• unpaved: sections of the route that are unpaved.

• lowEmissionZone: sections of the route that are located within low-emission zones.

• speedLimit: Sections with legal speed limit information. maxSpeedLimitInKmh: The maximum legal speed limit in kilometers/hour. This can be time-dependent and/or vehicle-dependent. In the case of a time-dependent speed limit, the section will contain the speed limit effective at the time the planned route would enter this section.

Specifies the extended representation of the set of routes provided as a response. <extendedRouteRepresentation> can be specified multiple times (e.g., ...&extendedRouteRepresentation=distance&extendedRouteRepresentation=travelTime&extendedRouteRepresentation=consumption&... ). Possible values are:

• distance: Includes distances to route polyline points in the response.

• travelTime: Includes travel times to route polyline points in the response.

• consumption: Includes consumption values dependent on the vehicleEngineType to route polyline points in the response.

  • Can only be used when the vehicleEngineType is set to electric and the constantSpeedConsumptionInkWhPerHundredkm is specified.

• distance
• travelTime
• consumption

Decides how traffic is considered for computing routes.
Possible values are:

• live: In addition to historical travel times, routing and estimated travel time consider traffic jams and short- and long-term closures during the travel time window.

• historical: Routing and estimated travel time consider historical travel times and long term closures. Traffic jams and short-term closures during the travel time window do not influence routing or travel time.

Default value: live

Specifies something that the route calculation should try to avoid when determining the route. The avoid can be specified multiple times (e.g., ...&avoid=motorways&avoid=ferries&...).
Possible values are:

• tollRoads: Avoids toll roads.

• motorways: Avoids motorways.

• ferries: Avoids ferries.

• unpavedRoads: Avoids unpaved roads.

• carpools: Avoids routes that require use of carpool (HOV/High Occupancy Vehicle) lanes.

• alreadyUsedRoads:

  • Avoids using the same road multiple times.

  • This is most useful in conjunction with routeType=thrilling.

• borderCrossings: Avoids crossing country borders.

• tunnels: Avoids tunnels.

• carTrains: Avoids car trains.

• lowEmissionZones: Avoids low-emission zones.

Specifies the type of optimization used when calculating routes.
Possible values are:

• fast: Route calculation is optimized by travel time, while keeping the routes sensible. For example, the calculation may avoid shortcuts along inconvenient side roads or long detours that only save very little time.

• short: Route calculation is optimized such that a good compromise between small travel time and short travel distance is achieved.

• efficient: Route calculation is optimized such that a good compromise between small travel time and low fuel or energy consumption is achieved.

• thrilling: Route calculation is optimized such that routes include interesting or challenging roads and use as few motorways as possible.

  • There is a limit of 900km on routes planned with routeType=thrilling.

Default value: fast

Default value and only allowed value: car.

The engine type of the vehicle. When the value is electric a detailed consumption model can be used.
Default value: combustion
Other value: electric

Weight of the vehicle in kilograms.
When the value is positive then the calculated route respects weight restrictions.
It must be positive when used in the context of the detailed consumption model.
Default value: 0
Minimum value: 0

Specifies the speed-dependent component of consumption.

• Provided as an unordered list of speed/consumption-rate pairs.

• The list defines points on a consumption curve.

Consumption rates for speeds not in the list are found as follows:

• By linear interpolation, if the given speed lies in between two speeds in the list.

• Otherwise, by linear extrapolation assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list.

The list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed.

• If it only contains a single point, then the consumption rate of that point is used without further processing.

• Consumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates.

• Similarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed. The minimum and maximum values described here refer to the valid range for the consumption values (expressed in kWh/100km).

Minimum value: 0.01
Maximum value: 100000.0

Specifies the current electric energy supply in kilowatt hours (kWh).
Note: Requires maxChargeInkWh to be set.
Minimum value: 0.0
Maximum value: maxChargeInkWh

Specifies the maximum electric energy supply in kilowatt hours (kWh) that may be stored in the vehicle's battery.
Note: Requires currentChargeInkWh to be set.
Minimum value: currentChargeInkWh

Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW). It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.
Minimum value: 0.0
Default value: 0.0

Specifies the efficiency of converting electric energy to kinetic energy when the vehicle accelerates (i.e., KineticEnergyGained/ ElectricEnergyConsumed).
Notes:

• It must be paired with decelerationEfficiency.
• It cannot be used with consumptionInkWhPerkmAltitudeGain or recuperationInkWhPerkmAltitudeLoss.
• Requires vehicleWeight to be set.

Minimum value: 0.0
Maximum value: 1/decelerationEfficiency

Specifies the efficiency of converting kinetic energy to electric energy when the vehicle decelerates (i.e., ElectricEnergyGained/ KineticEnergyLost).
Notes:

• It must be paired with accelerationEfficiency.

• It cannot be used with consumptionInkWhPerkmAltitudeGain or recuperationInkWhPerkmAltitudeLoss.

• Requires vehicleWeight to be set.

Minimum value: 0.0
Maximum value: 1/accelerationEfficiency

Specifies the efficiency of converting electric energy to potential energy when the vehicle gains elevation (i.e., PotentialEnergyGained/ElectricEnergyConsumed).
Notes:

• It must be paired with downhillEfficiency.

• It cannot be used with consumptionInkWhPerkmAltitudeGain or recuperationInkWhPerkmAltitudeLoss.

• Requires vehicleWeight to be set.

Minimum value: 0.0
Maximum value: 1/downhillEfficiency

Specifies the efficiency of converting potential energy to electric energy when the vehicle loses elevation (i.e, ElectricEnergyGained/PotentialEnergyLost).
Notes:

• It must be paired with uphillEfficiency.

• It cannot be used with consumptionInkWhPerkmAltitudeGain or recuperationInkWhPerkmAltitudeLoss.

• Requires vehicleWeight to be set.

Minimum value: 0.0
Maximum value: 1/uphillEfficiency

Specifies the electric energy in kWh consumed by the vehicle through gaining 1000 meters of elevation.
Notes:

• It must be paired with recuperationInkWhPerkmAltitudeLoss.

• It cannot be used with accelerationEfficiency, decelerationEfficiency, uphillEfficiency or downhillEfficiency.

Minimum value: recuperationInkWhPerkmAltitudeLoss
Maximum value: 500.0

Specifies the electric energy in kWh gained by the vehicle through losing 1000 meters of elevation.
Notes:

• It must be paired with consumptionInkWhPerkmAltitudeGain.

• It cannot be used with accelerationEfficiency, decelerationEfficiency, uphillEfficiency, or downhillEfficiency.

Minimum value: 0.0
Maximum value: consumptionInkWhPerkmAltitudeGain

Defines areas of certain shapes to avoid when planning routes. Supported shapes include rectangles. It can contain one of each supported shapes fields.

This is an array of objects with a maximum of ten elements. Each object describes an axis-aligned rectangle, defined using the fields southWestCorner and northEastCorner.

• The maximum size of a rectangle is about 160x160 km.

• It cannot cross the 180th meridian.

• It must be between -80 and +80 degrees of latitude.

The south-west corner of a rectangle. It is an object consisting of a latitude and a longitude field, each field containing the value in degrees as a number.

The north-east corner of a rectangle. It is an object consisting of a latitude and a longitude field, each field containing the value in degrees as a number.

Locations to be used as input for route reconstruction.

An array of pointWaypoint objects, to be used to represent waypoints when reconstructing a route.

• If specified, the array must not be empty.

Must contain one waypointSourceType and one supportingPointIndex object.

Denotes the source of the waypoint. Possible values:

• USER_DEFINED: a waypoint that was explicitly defined by the user.

An index into the supportingPoints array that denotes the location of the waypoint on the reference route.

• Must be inside supportingPoints array boundaries.

An array of objects with the parameters for the computation of each leg. If the parameter is such that it is available for use in the query parameters, then its simultaneous use in the query parameters and in the POST data is prohibited, and such a request will be returned with an error.
If the legs field is present in the POST data, then the number of elements in the array must be equal to the number of waypoints + 1.
If there is no need to specify any parameters for some leg, then an empty object must be specified.
It may contain the following fields:

• routeType: specifies the type of optimization used when calculating the leg. For the details, please see the Request parameters section.
  Default value: fast

• routeStop: an object of RouteStop type with additional parameters for the stop at the end of the current leg. It must be omitted if not needed.

• supportingPoints: An array of point objects, to be used as input for leg reconstruction.
  supportingPoints cannot be used for the entire route and per leg simultaneously.
  supportingPoints per leg cannot be used in conjunction with pointWaypoints.
  When using minDeviationTime, minDeviationDistance, or supportingPointIndexOfOrigin, all legs must have non-empty supporting points.
  A supportingPoints array must cover the whole leg, and the itinerary points (an origin, a destination, or a waypoint) must be located at (or very near to) the first and last points, respectively. It must be omitted if not needed.

Specifies the waiting time at route stops (including charging time). It must be 0 in the last leg (the destination).
Default value: 0

The service whitelists response headers that browsers are allowed to access.
Value: Content-Length

The service allows cross-origin resource sharing.
Value: * (wildcard)

The service supports HTTP compression if requested by the client.
Value: gzip

The format of the response.
Value: application/json; charset=utf-8

The Cache-Control general-header field is used to specify directives that must be obeyed by all caching mechanisms along the request/response chain. It is supported by HTTP/1.1 clients. It may not be supported by HTTP/1.0 clients.
Values:

• no-cache
• no-transform

The Pragma general-header field is used to specify directives that might apply to any recipient along the request/response chain. It is supported by HTTP/1.0 client. Value: no-cache

This is an identifier for the request. If Tracking-ID was specified in the request headers, it contains the same value. Otherwise it may contain a generated value.

This may be sent for deprecated features.

OK: A route or range was calculated and the body of the response contains the data for a successful response.

Bad request: One or more parameters were:

• Incorrectly specified.

• Are mutually exclusive.

• The points in the route request are not connected by the road network.

• The points in the request are not near enough to a road.

Permission, capacity, or authentication issues:

• Forbidden

• Not authorized

• Account inactive

• Account over queries per second limit

Not Found: The requested resource could not be found, but it may be available again in the future.

Method Not Allowed: The client used a HTTP method other than GET or POST.

Request timeout: The client took too long to transmit the request.

Requested uri is too long.

Unsupported Media Type.

Too Many Requests: Too many requests were sent in a given amount of time for the supplied API Key.

An error occurred while processing the request. Please try again later. This can also indicate that the request reached an internal computation time threshold and timed out.

Internal network connectivity issue.

Service currently unavailable.

Internal network connectivity issue.

Service not found.

The format version.

The request may return more than one route.
Each object has at least a summary field and a legs field. It may contain other fields depending on the request parameters.

The summary of a route, or of a route leg.
The summary object may be extended with new fields in the future; clients should ignore fields they do not recognize.

A description of a part of a route, comprised of an array of points.

• Contains the summary and points fields.

• Each additional waypoint provided in the request will result in an additional leg in the returned route.

Each object in the array is a location on the surface of the globe defined by its latitude and longitude fields.

Included if requested using the sectionType parameter. This array is available inside route objects.

• Contains one or more section objects.

• The structure of section objects is given below.

Index of the first point (offset 0) in the route this section applies to.

Index of the last point (offset 0) in the route this section applies to.

A 3-character ISO 3166-1 alpha-3 country code.

Type of the incident.

• Can currently be JAM, ROAD_WORK, ROAD_CLOSURE, or OTHER.

• See the tec field for detailed information.

The effective speed of the incident in km/h, averaged over its entire length.

The delay in seconds caused by the incident.

The magnitude of delay caused by the incident.
Possible values:

• 0: unknown

• 1: minor

• 2: moderate

• 3: major

• 4: undefined, used for road closures and other indefinite delays

These values correspond to the values of the response field magnitudeOfDelay

Details of the traffic event. It uses the definitions in the TPEG2-TEC standard. It can contain the effectCode and causes fields.
A selection of TPEG2-TEC causes can be found in the Terms and definitions of Safety related message sets.

The effect on the traffic flow. Contains a value in the tec001:EffectCode table, as defined in the TPEG2-TEC standard. Can be used to color-code traffic events according to severity.

Each object in the array describes one cause of the traffic event.

• It can contain the mainCauseCode and subCauseCode fields.

• It can be used to define iconography and descriptions.

The main cause of the traffic event. Contains a value in the tec002:CauseCode table, as defined in the TPEG2-TEC standard.
A selection of TPEG2-TEC causes can be found in the Terms and definitions of Safety related message sets.

The sub-cause of the traffic event. Contains a value in the sub cause table defined by the mainCauseCode, as defined in the TPEG2-TEC standard.
A selection of TPEG2-TEC causes can be found in the Terms and definitions of Safety related message sets.

The route or leg length in meters.

The estimated travel time in seconds depending on traffic.

• If traffic=historical, then travelTimeInSeconds includes historical travel times on the route.

• If traffic=live, then travelTimeInSeconds includes historical travel times as well as traffic jams during the travel time window on the route.

The delay in seconds compared to free-flow conditions according to real-time traffic information. Note that this is zero if traffic=historical.

The portion of the route or leg, expressed in meters, that is affected by traffic events which cause the delay.

The distance (in meters) from the origin point of the calculateRoute request to the first point where this route forks off from the reference route.

• If the route is identical to the reference route, then this field is set to the length of the route.

• Included in all alternative (but not reference) route summary fields.

The travel time (in seconds) from the origin point of the calculateRoute request to the first point where this route forks off from the reference route.

• If the route is identical to the reference route, then this field is set to the estimated travel time of the route.

• Included in all alternative (but not reference) route summary fields.

The coordinates of the first point following the origin point of the calculateRoute request where this route forks off from the reference route.

• If the route is identical to the reference route, then this field is set to the coordinates of the last point on the route.

• Included in all alternative (but not reference) route summary fields.

The estimated departure time for the route or leg. Specified as a dateTime.

The estimated arrival time for the route or leg. Specified as a dateTime.

The reason for a better route proposal. Can currently be:

• Blockage in case the reference route contains road blockages. The returned value is implementation-defined in case both reasons for a better proposal are applicable to the same route.

• Better_Proposal in case the alternative type is better than the reference route, according to the given planning criterion (set by routeType).

This field is included in the response only if the route is requested with alternativeType=betterRoute. This field is not present in the leg summary field.

The estimated electric energy consumption in kilowatt hours (kWh).

• Included if:

  • vehicleEngineType is set to electric.

  • constantSpeedConsumptionInkWhPerHundredkm is specified.

• The value of batteryConsumptionInkWh includes the recuperated electric energy and can therefore be negative (which indicates gaining energy).

• If both maxChargeInkWh and currentChargeInkWh are specified, recuperation will be capped to ensure that the battery charge level never exceeds maxChargeInkWh.

• If neither maxChargeInkWh nor currentChargeInkWh are specified, unconstrained recuperation is assumed in the consumption calculation.

This field is included if extendedRouteRepresentation is used.

• It always contains entries for the first and the last point in the route.

• For any pair of consecutive entries in the progress array, progress for pointIndex values that are not explicitly present and are enclosed by said pair, can be linearly interpolated by summing up straight line distances of the leg points.

• The Haversine formula is precise enough to compute such distances.

A progress point object may contain the following members:

• pointIndex: index of the point (offset 0) in the route this object applies to.

• distanceInMeters: distance (in meters) from the start of the route to this point. This field is included if the extendedRouteRepresentation value distance is used.

• travelTimeInSeconds: travel time (in seconds) from the start of the route to this point. This field is included if the extendedRouteRepresentation value travelTime is used.

• batteryConsumptionInkWh: electric energy consumption (in kilowatt hours) from the start of the route to this point. This field is included if the extendedRouteRepresentation value consumption is used and the vehicleEngineType is set to electric. See also the batteryConsumptionInkWh in summary section.

The index of the waypoint at the end of the leg that corresponds to:

• The index of this waypoint in the list of waypoints from the routePlanningLocations base path parameter in the request (the first waypoint has an index equal to 0).

• The index of this waypoint in the pointWaypoints field when reconstructing a route.

This field is not provided if the end of the leg corresponds to the destination or to a new charging waypoint that is not present in the request.

Contains the value of pauseTimeInSeconds, if it was specified for the corresponding leg. This field is not present in the route summary field.

Contains the response section type.

• The COUNTRY sections span between country border crossings, from the departure, or to the destination.

  • The section additionally contains countryCode.

  • If the route has disjointed parts in the same country, there will be several sections with the same countryCode.

  • If no country can be assigned to a part of the route, as for example in international waters, there may be no country section for this part.

• A TRAFFIC section may additionally contain any of the following: simpleCategory, effectiveSpeedInKmh, delayInSeconds, magnitudeOfDelay, tec.

• TRAVEL_MODE sections cover the whole route. Each section's travel mode is reported in travelMode .

This field is either set to the value given to the request parameter travelMode, if this travel mode is possible, or to other which indicates that the given mode of transport is not possible in this section. This field can only be used within sections of type TRAVEL_MODE.

This object provides a representation of the error message. It contains a code and a message field.