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

Places

A place (Place) is a GeoJSON Feature with Point geometry and a required string id. Its properties carry the address, POI details, entry points and the ids for follow-up calls. A list of places (Places) is a FeatureCollection of them.

Where places are used

Place object structure

Search and reverse geocoding results add their own properties.

Place types

place.properties.type is one of placeTypes:

Type Meaning
POI Point of interest: a business, landmark or facility
Street A named street
Geography An administrative area: city, state, country, postal code area
Point Address A street address with a building number
Address Range A range of house numbers along a street segment
Cross Street An intersection of two streets

Address

place.properties.address; only freeformAddress is always present:

Point of interest (POI)

place.properties.poi, present when type is 'POI':

Related POIs

place.properties.relatedPois links a POI to the ones it contains or sits in:

Entry points

place.properties.entryPoints lists the entrances of a building or facility, for routing to the right door:

Reverse geocoding returns entry points on the road network, where a vehicle arrives rather than where the door is, and leaves their type absent. getPosition picks the main entry point over the place's position when asked to.

Geography

place.properties.geographyType, present when type is 'Geography', from largest to smallest:

An area with several administrative roles carries several types.

EV charging stations

place.properties.chargingPark, on EV charging station POIs:

Neither carries real-time status: EV charging availability adds it, and shows how to read both.

Address ranges

place.properties.addressRanges, present when type is 'Address Range':

Mapcodes

place.properties.mapcodes, short codes usable instead of coordinates:

Data sources

place.properties.dataSources holds the ids for follow-up calls:

Search-specific properties

Search results (SearchPlaceProps) add:

Geocoding results (GeocodingProps) carry score and distance too, plus matchConfidence.score for how well the text matched; their type is never 'POI'.

Reverse geocoding properties

Reverse geocoded places (RevGeoAddressProps) add originalPosition: the [longitude, latitude] the service matched. The feature's own geometry holds the position you queried.

API reference

Related guides and examples

Places services

Map integration

Related examples