Introduction

Service version: 1
Last edit: 2019.08.19

What is TomTom's Routing API?

Routing is a suite of web services designed for developers to use our latest scalable online Routing engine. Independent tests have established that the TomTom Routing engine is the best in the industry. Our Routing engine uses IQ Routes and TomTom Traffic.

The Routing API consists of the the following services with endpoints:

Routing service

Contains a suite of web services including Calculate Route, Calculate Reachable Range, and Common Routing Parameters.

Batch Routing service

Enables you to dispatch batches of Calculate Route and Calculate Reachable Range requests.

Matrix Routing service

Enables the calculation of a matrix of route summaries for a set of routes defined with origin and destination locations.

Matrix Routing v2 service

Allows clients to calculate a matrix of route summaries for a set of routes defined with origin and destination locations.

Routing API and Extended Routing API Market Coverage

Provides a list of all countries supported by the Routing API and Extended Routing API engines.


What is TomTom's Extended Routing?

The Extended Routing web service allows EV drivers to plan their trips around where to stop and recharge their electric vehicle. Given the start, intermediate, and end parameters, the endpoint returns routes with available charging stations within driving range and displays them on a TomTom map.

Extended Routing consists of the following RESTful API services with endpoints:

Long Distance EV Routing service

Calculates a route between a given origin and destination.

Routing API and Extended Routing API Market Coverage

Provides a list of all countries supported by the Routing API and Extended Routing API engines.


Getting started

  1. To get your API Key, you first need to be registered for the TomTom Developer Portal. If you don't have an account, no worries! Register / Sign in now before continuing.
  2. Once you are registered, go to your Dashboard and locate the API Key that you would like to use (we've created the first one for you, it's called My first API Key).
  3. Read the documentation and start coding.
  4. Consider using the TomTom Maps SDK for Web, for iOS, and for Android.
  5. Check related Blog articles for further information.

Common use cases you can implement

Calculating

  • Calculate departure times by planning routes using desired arrival times.
  • Calculate the travel time of pre-existing routes (like routes created using GPS trace data or routes planned with other routing engines).
  • Calculate a batch of up to 700 routing requests in parallel and retrieve the results as a single file.
  • While having a matrix of origins and destinations, calculate routing costs for each origin-to-destination combination and retrieve it in a single file.

Evaluating and plotting

  • Evaluate the amount of fuel/energy needed for any route.
  • Plot the route geometry on map tiles from TomTom (or other map suppliers).
  • Draw a polygon of the reachable range with the current fuel/energy budget.

Planning

  • Plan the fastest, shortest or eco route from A to B taking in consideration the real-time traffic and the historical traffic.
  • Plan multiple alternative routes through one single API call.
  • Plan a route through up to 150 intermediate waypoints.
  • Plan the optimized route through the intermediate waypoints (traveling salesman).
  • Plan a round trip through at least one intermediate point.
  • Plan a route which avoids toll roads, ferries, or other types of roads.
  • Plan a route for vehicles or pedestrians.
  • Plan a route using our elaborated consumption models for both electric and combustion engines.
  • Draggable routes: replan the same route with additional intermediate points.

Features

Routing API

Traffic

Our Routing engine uses IQ Routes and TomTom Traffic. As such, the Routing API enables you to:

  • Plan routes for immediate departure and TomTom's industry-leading traffic data will be used to optimize journey times, minimize traffic delays and get to your destination faster.
  • Plan routes in the future to take advantage of TomTom's extensive historic traffic database. Using past traffic patterns, the routing engine can predict journey times and calculate fastest routes for any day and time.

Alternative routes

There are many ways to get from point A to B. Sometimes your users want to know about them.

  • You can reuse the same waypoints in calls with different routing parameters (like fastest, shortest, and eco).
  • You can request more than one route matching your input parameters within the same call.

Waypoints

In addition to the start and end of the route, you can specify intermediate waypoints that the planned route must go through.

  • Use additional waypoints to create draggable routes, where the user can replan a displayed route to go via a desired location.
  • Use our Optimized Routing algorithm to obtain the best order in which to visit your chosen waypoints.

Extended Routing API

Charging data

Each charging stop results in an additional leg in the route response.

  • Each additional leg contains a chargingInformationAtEndOfLeg element in its leg summary.
  • Both the route summary and the leg summary include a remainingChargeAtArrivalInkWh element.
  • The route summary includes a totalChargingTimeInSeconds element.
  • The chargingInformationAtEndOfLeg field consists of:
    • target battery charge
    • charging time
    • details about the charging stop