TomTom Maps SDK for JavaScript
This is the documentation of version 0.62.1. Go to the latest version, 1.0.0-rc.5.

Place details

The place details service, getPlaceDetails(), retrieves detailed information about a specific place using its unique entity identifier. This is the recommended way to get full place details — including opening hours, categories, and entry points — once you have a place ID.

Basic usage

Pass the entityId to retrieve a Place with full details, or undefined if the ID is not found:

import { getPlaceDetails } from '@tomtom-org/maps-sdk/services';

const place = await getPlaceDetails({
    entityId: '528009002822995'
});

if (!place) {
    console.log('Place not found');
    return;
}

const [lng, lat] = place.geometry.coordinates;
console.log(place.properties.poi?.name);            // e.g. 'Rijksmuseum'
console.log(place.properties.address.freeformAddress); // e.g. 'Museumstraat 1, Amsterdam'

Opening hours

Request opening hours for the upcoming week by setting openingHours:

const place = await getPlaceDetails({
    entityId: '528009002822995',
    openingHours: 'nextSevenDays',
});

const hours = place?.properties.poi?.openingHours;
if (hours?.alwaysOpenThisPeriod) {
    console.log('Open 24/7');
} else {
    hours?.timeRanges.forEach(({ start, end }) => {
        console.log(`Open ${start.date.toLocaleString()} – ${end.date.toLocaleString()}`);
    });
}

Related POIs

Retrieve parent or child POI relationships using relatedPois:

// Retrieve child POIs (e.g. terminals inside an airport)
const place = await getPlaceDetails({
    entityId: '528009002822995',
    relatedPois: 'child',
});

place?.properties.relatedPois?.forEach(related => {
    console.log(related.id, related.relationType);
});

Available values: 'child' | 'parent' | 'all' | 'off'

Additional options

const place = await getPlaceDetails({
    entityId: '528009002822995',
    openingHours: 'nextSevenDays',
    timeZone: 'iana',       // Include IANA timezone in opening hours
    mapcodes: ['Local', 'International'],  // Alternative location codes
    geopoliticalView: 'Unified', // Geopolitical view, overriding the global one
});

See Geopolitical views for what geopoliticalView changes and the views place details serve.

Working with results

getPlaceDetails() returns a Place<SearchPlaceProps> — the same structure as search results — giving you access to the full place detail set:

const place = await getPlaceDetails({ entityId: '528009002822995' });
if (!place) return;

// Coordinates
const [lng, lat] = place.geometry.coordinates;

// Address
const { freeformAddress, municipality, country } = place.properties.address;

// POI details
const poi = place.properties.poi;
console.log(poi?.name);           // Business name
console.log(poi?.categories);     // e.g. ['MUSEUM']
console.log(poi?.phone);          // Phone number
console.log(poi?.url);            // Website URL

Displaying on the map

Use PlacesModule.show() to render the retrieved place as a marker on the map:

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

const map = new TomTomMap({ mapLibre: { container: 'sdk-map' } });
const placesModule = await PlacesModule.create(map);

const place = await getPlaceDetails({ entityId: '528009002822995' });
if (place) {
    await placesModule.show(place);
}

Integration with POIs module

A common pattern is to fetch full place details when the user clicks a POI on the map. The POI click event provides the id needed for the lookup:

import { POIsModule } from '@tomtom-org/maps-sdk/map';
import { getPlaceDetails } from '@tomtom-org/maps-sdk/services';

const poisModule = await POIsModule.get(map);

poisModule.events.on('click', async (feature) => {
    const place = await getPlaceDetails({
        entityId: feature.properties.id,
        openingHours: 'nextSevenDays',
    });

    if (!place) return;
    // Display place on map or show a popup with details
});

See the POIs Module guide for a full walkthrough of this pattern, including popups and map marker integration.

API reference

For complete documentation of all parameters and response types, see the getPlaceDetails API Reference.

Related guides and examples

Map integration

Related examples

Related services