Type Alias PlaceDetailsOptionalParams

Optional parameters for the place details service.

type PlaceDetailsOptionalParams = {
    geopoliticalView?: GeopoliticalView;
    mapcodes?: MapcodeType[];
    openingHours?: OpeningHoursMode;
    relatedPois?: RelatedPoisRequest;
    timeZone?: TimeZoneRequest;
}

Index

Properties

geopoliticalView? mapcodes? openingHours? relatedPois? timeZone?

Properties

`Optional`geopoliticalView

geopoliticalView?: GeopoliticalView

Geopolitical view of the result, overriding the global one. It sets which country a place in a disputed territory belongs to. See GeopoliticalView.

`Optional`mapcodes

mapcodes?: MapcodeType[]

Enables a comma-separated mapcodes list in the response.

Remarks

Mapcodes are short location codes representing a specific location to within a few meters. You can filter them to selected mapcode types.

Mapcode types:

Local: Short local codes for use within a territory
International: Longer codes that work worldwide
Alternative: Alternative codes for the same location

See

Mapcode Project

Example

mapcodes: ['Local', 'International']

`Optional`openingHours

openingHours?: OpeningHoursMode

Opening hours to include in the response.

Remarks

Provides operating hours for POIs (restaurants, stores, etc.).

Example

openingHours: 'nextSevenDays'

`Optional`relatedPois

relatedPois?: RelatedPoisRequest

Related Points of Interest for the response.

Remarks

POIs can have parent/child relationships. For example, an airport terminal is a child of the airport.

Relation types:

child: POIs that are children of this place
parent: POIs that are parents of this place
all: Both child and parent relations
off: No related POIs (default)

Default

'off'

Example

relatedPois: 'child'  // Get terminals inside an airport
relatedPois: 'parent'  // Get the airport containing a terminal
relatedPois: 'all'  // Get all related POIs

`Optional`timeZone

timeZone?: TimeZoneRequest

Timezone information for the response.

Remarks

Returns the timezone of the place's location (e.g., "America/New_York").

Example

timeZone: 'iana'

Type Alias PlaceDetailsOptionalParams

Index

Properties

Properties

`Optional`geopoliticalView

`Optional`mapcodes

Remarks

See

Example

`Optional`openingHours

Remarks

Example

`Optional`relatedPois

Remarks

Default

Example

`Optional`timeZone

Remarks

Example

Settings

On This Page

Type Alias PlaceDetailsOptionalParams

Index

Properties

Properties

OptionalgeopoliticalView

Optionalmapcodes

Remarks

See

Example

OptionalopeningHours

Remarks

Example

OptionalrelatedPois

Remarks

Default

Example

OptionaltimeZone

Remarks

Example

Settings

On This Page

`Optional`geopoliticalView

`Optional`mapcodes

`Optional`openingHours

`Optional`relatedPois

`Optional`timeZone