TomTom Maps for JavaScript
    Preparing search index...

    Type Alias PlaceByIdParams

    PlaceByIdParams: CommonServiceParams<URL, PlaceByIdResponseAPI> & PlaceByIdMandatoryParams & PlaceByIdOptionalParams

    Parameters for the Place by ID service.

    Combines mandatory and optional parameters for fetching detailed information about a specific place using its unique identifier.

    Use this service to:

    • Get detailed POI information
    • Refresh cached place data
    • Navigate between related POIs
    • Fetch additional place properties not in search results
    // Basic lookup
    const params: PlaceByIdParams = {
    key: 'your-api-key',
    entityId: '528009002822995'
    };

    // With additional information
    const detailedParams: PlaceByIdParams = {
    key: 'your-api-key',
    entityId: '528009002822995',
    openingHours: 'nextSevenDays',
    mapcodes: ['Local'],
    relatedPois: 'child'
    };