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

• Search, geocoding, reverse geocoding and place details return places.
• The places module displays them as markers with popups and interaction.

Place object structure

• id - A unique string.
• geometry.coordinates - [longitude, latitude].
• bbox - The area the place covers, if it is wider than a point (a city, a country).
• properties:
  • type - The place type.
  • address - The structured address.
  • poi - POI details, if type is 'POI'.
  • relatedPois - Parent and child POIs.
  • entryPoints - Entrances.
  • geographyType - Administrative levels, if type is 'Geography'.
  • chargingPark - EV charging infrastructure.
  • addressRanges - House number ranges, if type is 'Address Range'.
  • mapcodes - Mapcodes for the location.
  • dataSources - Ids for follow-up calls.

Search and reverse geocoding results add their own properties.

Place types

place.properties.type is one of placeTypes:

Address

In place.properties.address, only freeformAddress is always present:

• Full address: freeformAddress, formatted the way the place’s country writes addresses.
• Street: streetNumber, streetName, routeNumbers (road numbers such as highway designations).
• Local areas: neighborhood (informal, no official boundary), municipalitySecondarySubdivision, municipalitySubdivision, municipality (city or town), localName.
• Administrative divisions: countryTertiarySubdivision, countrySecondarySubdivision (county), countrySubdivision (state or province), countrySubdivisionName (its full name, when countrySubdivision is abbreviated), countrySubdivisionCodeIso (e.g. 'US-CA').
• Postal codes: postalCode, extendedPostalCode, and postalName on a postal code area.
• Country: country, countryCode (ISO 3166-1 alpha-2, e.g. 'NL'), countryCodeISO3 (alpha-3, e.g. 'NLD').

Point of interest (POI)

place.properties.poi is present if type is 'POI':

• name - Display name, in the request language.
• phone, url, brands (e.g. ['Shell']).
• categories - Standardized POICategory codes, e.g. ['ITALIAN_RESTAURANT'], for filtering and icon mapping. The POI categories service resolves words to them.
• localizedCategories - Human-readable category names, e.g. ['italian', 'restaurant'], in English whatever the request language. For names in that language, look up categories in getPOICategories, and keep the English name where it returns an identifier such as GeneralHospitalAndPolyclinic.
• openingHours - If you asked for it with openingHours: 'nextSevenDays'.
  • mode - Always 'nextSevenDays'.
  • timeRanges - Open periods, each a start and end with a Date and its parts (dateYYYYMMDD, year, month 1–12, day, hour, minute). An overnight period ends on the next day. The Date holds the place’s local time read in the runtime’s time zone, so compare it with the current time in the place’s timeZone.
  • alwaysOpenThisPeriod - true for a place open around the clock. Its timeRanges then holds one range spanning the period, midnight to midnight.
• timeZone.ianaId - e.g. 'Europe/Amsterdam'.

Related POIs

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

• relationType - 'parent' if this POI is inside the referenced one (a store in a mall), 'child' if the referenced one is inside it.
• id - Pass it to place details to fetch the related POI.

Entry points

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

• position - [longitude, latitude].
• type - 'main' (at most one per place) or 'minor', if the service classifies it.
• functions - What the entrance is for, e.g. 'FrontDoor', 'ServiceEntrance', 'ParkingGarage'.

Reverse geocoding returns entry points on the road network, where a vehicle arrives, rather than at the door. These have no type.

getPosition and routing’s useEntryPoints can pick the main entry point over the place’s position. With main-when-available, a place with no entry point typed 'main' uses its first untyped one, as reverse geocoding returns them. A place whose entry points are all 'minor' keeps its own position.

Geography

place.properties.geographyType is present if type is 'Geography'. From largest to smallest:

• Country
• CountrySubdivision - State or province
• CountrySecondarySubdivision - County
• CountryTertiarySubdivision
• Municipality - City or town
• MunicipalitySubdivision - District within a city
• MunicipalitySecondarySubdivision
• Neighbourhood
• PostalCodeArea

An area with several administrative roles carries several types. Geocoding and reverse geocoding both return these names, so they match the geographyTypes filter you pass. Which levels hold data varies by country.

EV charging stations

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

• connectors - Connector counts, grouped by type and power.
  • connector - type (e.g. 'IEC62196Type2CCS'), ratedPowerKW, chargingSpeed, currentType, voltageV, currentA.
  • count - How many connectors of that kind the park has.
• chargingStations - The charging stations, on search results.
  • chargingPoints - Each charging point (EVSE), with capabilities, restrictions, its connectors, and evseId when the operator publishes one.

Address ranges

place.properties.addressRanges is present if type is 'Address Range':

• rangeLeft, rangeRight - The house numbers on each side, looking from from towards to.
• from, to - The segment’s end coordinates, [longitude, latitude].

Mapcodes

place.properties.mapcodes holds short codes to use instead of coordinates:

• type - 'Local' (shortest, needs its territory), 'International' (unambiguous worldwide) or 'Alternative' (another local code).
• fullMapcode - The complete code, territory included, e.g. 'NLD 4J.P2'.
• territory - On local and alternative codes, e.g. 'NLD'.
• code - The code without the territory, e.g. '4J.P2'.

Data sources

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

• geometry.id - Pass it to geometry data for the place’s outline. Only search results have it, not reverse geocoded places.

To fetch a place’s details, pass the place’s own id to place details.

Search-specific properties

Search results (SearchPlaceProps) add:

• score - Relevance. Higher is a better match.
• distance - Meters from the geoBias position, if you gave one.
• info - The original data source.

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

• Places
• CommonPlaceProps
• SearchPlaceProps
• RevGeoAddressProps

Related guides and examples

Places services

• Places quickstart
• Search
• Geocoding
• Reverse geocoding
• Geometry data

Map integration

• Places module

Related examples

• Geocode: geocode an address and show it
• Reverse geocode: turn coordinates into an address
• Search places within geometry: search places inside a boundary
• Places default icon styling: style the default place markers