This is the documentation of version 0.55.1. Go to the latest version, 1.0.0-rc.5.

Places

A place is a GeoJSON Feature with Point geometry representing a location. The feature properties contain comprehensive information including address details, POI data, entry points, and geographic classifications.

Where places are used

Places are returned by various services and can be displayed on the map:

Services that return places:

Displaying places on the map:

Place object structure

The place object contains the following properties:

geometry

properties

Place types

Places are categorized into six main types accessible via place.properties.type:

Location types:

Address types:

Address

The address contains structured location information, breaking down the full address into hierarchical components. Access it via place.properties.address:

Complete address:

Building and street:

Local areas:

Administrative divisions:

Postal codes:

Country information:

Point of interest (POI)

POI information enriches places with business details, categories, and operational information. Available when type === 'POI'. Access it via place.properties.poi:

Basic information:

Categories:

Operating hours:

Time zone:

Related POIs

References to parent or child POIs establish hierarchical relationships between places. Access them via place.properties.relatedPois:

Relationship types:

Properties:

Entry points

Physical access points (entrances) to buildings or facilities, useful for precise navigation and routing. Access them via place.properties.entryPoints:

Entry point types:

Properties:

Reverse geocoding returns entry points on the road network, which is where a vehicle would arrive rather than where the door is. It does not classify them, so their type is absent.

Geography

Administrative area classifications for places representing geographic entities. Available when type === 'Geography'. Access it via place.properties.geographyType:

Geographic hierarchy (largest to smallest):

Multiple types can be present when an area has multiple administrative roles.

EV charging stations

Electric vehicle charging infrastructure information for POIs that are charging stations. Access it via place.properties.chargingPark:

Charging infrastructure:

Facility details:

Address ranges

Range information for street segments, showing address numbers along both sides of a street. Available when type === 'Address Range'. Access it via place.properties.addressRanges:

Mapcodes

Alternative location codes that can be used instead of coordinates. Access them via place.properties.mapcodes:

Mapcode types:

Properties:

Data sources

References to additional data services for fetching more detailed information. Access them via place.properties.dataSources:

Search-specific properties

Additional properties available when places are returned from search operations:

Search places (SearchPlaceProps):

Reverse geocoding properties

Additional properties available when places are returned from reverse geocoding:

Reverse geocoded places (RevGeoAddressProps):

API reference

For complete type documentation, see the place feature types:

Related guides and examples

Places services

Map integration

Related examples