Routing Quickstart

VERSION 0.41.1 PUBLIC PREVIEW

The Routing Service calculates routes between locations with support for multiple waypoints, various vehicle types, and real-time traffic integration.

import { TomTomConfig } from '@tomtom-org/maps-sdk/core';
import { calculateRoute } from '@tomtom-org/maps-sdk/services';
import { API_KEY } from './config';

TomTomConfig.instance.put({ apiKey: API_KEY });

(async () => {
    const response = await calculateRoute({
        locations: [
            [4.89066, 52.37317],
            [4.47059, 51.92291],
        ],
    });
    console.log(JSON.stringify(response.features[0].properties, null, 4));
})();

Initialization

Configure the SDK with your API key:

1
import { TomTomConfig } from '@tomtom-org/maps-sdk/core';
2
import { calculateRoute } from '@tomtom-org/maps-sdk/services';
3

4
TomTomConfig.instance.put({
5
    apiKey: 'YOUR_API_KEY_HERE'
6
});

Calculating a Route

Calculate a route between two locations:

1
const route = await calculateRoute({
2
    locations: [
3
        [4.9041, 52.3676], // Amsterdam
4
        [2.3522, 48.8566]  // Paris
5
    ]
6
});

Calculate a route between two geocoded locations:

1
import { geocodeOne } from '@tomtom-org/maps-sdk/services';
2

3
const waypoints = await Promise.all([
4
  geocodeOne('Amsterdam, Netherlands'),
5
  geocodeOne('Paris, France')
6
]);
7

8
const route = await calculateRoute({ locations: waypoints });

Calculate a route with extra options:

1
const routes = await calculateRoute({
2
    locations: [[4.9041, 52.3676], [2.3522, 48.8566]],
3
    costModel: {
4
        avoid: ['tollRoads'],
5
    },
6
    when: {
7
        option: 'departAt',
8
        date: new Date(Date.now() + 15 * 60 * 1000), // 15 minutes from now
9
    },
10
    maxAlternatives: 2
11
});

Accessing Route Information

1
const route = await calculateRoute({
2
    locations: [[4.9041, 52.3676], [2.3522, 48.8566]]
3
});
4

5
console.log(`Distance: ${route.features[0].properties.summary.lengthInMeters}m`);
6
console.log(`Duration: ${route.features[0].properties.summary.travelTimeInSeconds}s`);

Showing a Route on the Map

Display the calculated route using the Routing Module:

1
import { TomTomMap, RoutingModule } from '@tomtom-org/maps-sdk/map';
2

3
// Initialize map
4
const map = new TomTomMap({ mapLibre: { container: 'map' } });
5

6
// Initialize Routing Module
7
const routingModule = await RoutingModule.get(map);
8

9

10
// Calculate route
11
const route = await calculateRoute({
12
    locations: [[4.9041, 52.3676], [2.3522, 48.8566]]
13
});
14

15
// Display on map
16
await routingModule.showRoutes(route);

API Reference

For complete documentation of all route calculation properties and types, see the calculateRoute API Reference .

Route Planning Parameters - Comprehensive route planning with configuration options
Locations - Specifying route planning locations
Route Object - Understanding route structure
Long Distance EV Routing - Electric vehicle routing with charging stops

Map Integration

Routing Module - Display and interact with routes on the map

Route with waypoints - Basic route calculation and display
Route with alternatives - Multiple route options
Waypoints - Multi-stop routing
Node.js Routing - Server-side routing