FAQs

Service version: 1
Last edit: 2024.10.05
TomTom Maps
What is a Routing API and how does it work?

A Routing API is a set of tools and protocols that allow software applications to communicate and interact with each other to facilitate route planning and optimization.

It uses mapping and navigation data to calculate the most efficient route between two or more points, and considers factors such as real-time traffic, road conditions, and user preferences to provide accurate and optimized directions.

What is TomTom's Waypoint Optimization service?

TomTom's Waypoint Optimization service is designed to optimize the order of provided waypoints based on the fastest route.

It employs a heuristic algorithm to create an optimized sequence that considers road network distances and driving times. The resulting order represents the fastest route and this means for you faster travel times with fewer delays.

What is Matrix Routing, and when is it beneficial?

Matrix Routing allows users to simultaneously calculate travel times and distances for multiple destinations. It is beneficial for businesses dealing with complex logistical challenges, enabling batch processing and large-scale optimization.

What are the key features of the Routing APIs?

The key features include:

  • Precise directions with turn-by-turn navigation.
  • Route planning and optimization based on real-time data.
  • Live traffic information integration.
  • Alternative route creation for flexibility.
  • Accurate travel time and distance calculations.
  • Matrix routing for handling multiple destinations.
  • Turn-by-turn direction (or guidance) for confident travel.
Can the Routing API be customized for specific use cases?

Yes. Many Routing APIs offer customization options, allowing developers to tailor the functionality to specific use cases, industries, and preferences.

We support routing for trucks, commercial vehicles and EVs. This flexibility enhances the adaptability of the API for diverse applications.

Can the API create alternative routes in case of unexpected events?

Yes, the Routing API intelligently generates alternative routes., providing users with flexibility and minimizing disruptions to schedules and commitments.

Check the “maxAlternatives” and “alternativeType” parameters in the documentation here.

How can developers integrate the Routing API into their applications?

Developers can integrate the Routing API by following the provided tutorials and user guides, which typically include details on API endpoints and authentication. Integration is often facilitated through RESTful APIs.

How can businesses benefit from using a Routing API?

Businesses can benefit by optimizing delivery routes, reducing operational costs, improving efficiency, and enhancing customer satisfaction through timely deliveries. Matrix routing is particularly useful for handling complex logistics challenges in the last mile delivery industry. See this article.

How does the API handle live traffic information?

The API integrates in its calculations live traffic updates, allowing it to dynamically adjust routes to avoid congestion and roadblocks. This feature ensures that users receive the most up-to-date and efficient routes in real-time

What does 'Engine error while executing route request: STOPPED' mean?

Requests in the Routing API are forcefully canceled once they exceed some internal compute time limit (currently around 30 seconds) in order to avoid resource starvation scenarios. In this case, the Routing API returns the following error response:

1{
2
3 "formatVersion": "0.0.12",
4
5 "detailedError": {
6
7 "message": "Engine error while executing route request: STOPPED: The request exceeded the internal compute time limit and was canceled. For more information, go to: https://developer.tomtom.com/routing-api/documentation/product-information/faq",
8
9 "code": "COMPUTE_TIME_LIMIT_EXCEEDED"
10
11 }
12
13}
A request was canceled, or the response time is long. How can I reduce the response time?

The length of the resulting route for a route calculation, and respectively the resulting area for a reachable range calculation have the largest direct impact on the time it takes to compute them.

In addition most routing / range options have some impact on compute time. The default options produce fast responses. Using non-default options typically increases the response time.

The following options have a big impact on the response time:

Common Routing Parameters:

  • any avoid options, in particular, motorways, tollRoads, and ferries
  • routeType options thrilling, shortest, and short
  • travelMode options pedestrian and bicycle
  • vehicleMaxSpeed less than 60

Calculate Route:

  • long distance between route planning locations
  • maxAlternatives greater than 0

Calculate Reachable Range:

  • large timeBudgetInSec or distanceBudgetInMeters
  • overly efficient vehicle models with a large ratio between fuelBudgetInLiters or energyBudgetInkWh and the respective consumption per distance

Long Distance EV Routing:

  • parameters that cause a long response time for routing mentioned above
  • vehicles that require a high number of charging stops, e.g., a very small battery or an extremely high consumption
How do I reverse a route?

There is no specific function or parameter to reverse a route. Simply switch the origin and destination (or the order of your waypoints) and request a new route again using the calculateRoute endpoint.