Places quickstart

VERSION 1.0.0-rc.7 PUBLIC PREVIEW

The places services find places by text, area or route, turn addresses into coordinates and back, and return each result as a GeoJSON place that the Places module shows without mapping fields first.

Basic setup

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

3
TomTomConfig.instance.put({ apiKey: 'YOUR_API_KEY' });

The global configuration also sets the language and geopolitical view that every call inherits. A single call can override them.

Quick examples

Search for places

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

3
const results = await discoverPlaces({
4
    query: 'coffee shops',
5
    geoBias: { position: [4.9041, 52.3676] }, // Amsterdam
6
});
7

8
console.log(results.features[0].properties.poi?.name);

Geocode an address

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

3
const place = await geocodeOne('Dam Square, Amsterdam');
4
const coordinates = place.geometry.coordinates; // [lng, lat]

Reverse geocode coordinates

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

3
const place = await reverseGeocode({ position: [4.9041, 52.3676] });
4
console.log(place.properties?.address?.freeformAddress);

Next steps

Guide	Covers
Discover places	Fuzzy, geometry and along-route search, filters, pagination
Search suggestions	Places, brands and categories for a search box
Place details	A place’s full details by its ID
POI categories	The category codes, found by name or synonym
Geocoding	Addresses to coordinates
Reverse geocoding	Coordinates to an address
Geometry data	The outlines of areas

Geocode - A geocoded address on the map
Reverse geocode - The address of a point
Search playground - Search-as-you-type with getSearchSuggestions()
Geometry search playground - Searching inside area boundaries

Map integration

Places module - Search results on the map
Geometries module - Area outlines from geometry data