Services quickstart

VERSION 0.45.8 PUBLIC PREVIEW

The Services bundle provides a comprehensive set of GeoJSON-based functions for accessing TomTom’s location APIs. These services can be used in any JavaScript-based application, from web browsers to Node.js servers.

Installing Dependencies

1
# npm or Yarn - automatic peer dependency installation
2
npm install @tomtom-org/maps-sdk
3

4
# pnpm - enable auto-install-peers for easiest setup
5
echo "auto-install-peers=true" >> .npmrc
6
pnpm install @tomtom-org/maps-sdk

Peer dependencies (installed automatically with above commands):

lodash-es (v4) - Utility functions
zod (v4) - Schema validation

For more details, see the Project setup guide .

Setup

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

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

Available Services

Places Services

Search, geocoding, and reverse geocoding functionality:

1
import { search, geocode, reverseGeocode } from '@tomtom-org/maps-sdk/services';
2

3
// Search for places
4
const results = await search({
5
    query: 'restaurants',
6
    position: [4.9041, 52.3676]
7
});
8

9
// Geocode address
10
const location = await geocode({
11
    query: 'Dam Square, Amsterdam'
12
});
13

14
// Reverse geocode coordinates
15
const address = await reverseGeocode({
16
    position: [4.9041, 52.3676]
17
});

Routing Services

Route calculation and optimization:

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

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

Node.js Usage

The services work identically in Node.js environments:

1
const { TomTomConfig } = require('@tomtom-org/maps-sdk/core');
2
const { search, calculateRoute } = require('@tomtom-org/maps-sdk/services');
3

4
TomTomConfig.instance.put({
5
    apiKey: process.env.TOMTOM_API_KEY
6
});
7

8
const results = await search({
9
    query: 'coffee shops',
10
    position: [4.9041, 52.3676]
11
});

Next Steps

Places Services - Search, geocoding, reverse geocoding
Routing Services - Route calculation and optimization
Customizing Services - Configuration options