Documentation

Contains details about addresses or points of interest that match the search criteria.

Not all details are included with all responses. Some details may only be returned by specific data partners.

See: newPlace smart constructor.

Create a value of Place with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:addressNumber:Place', place_addressNumber - The numerical portion of an address, such as a building number.

$sel:country:Place', place_country - A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.

$sel:interpolated:Place', place_interpolated - True if the result is interpolated from other known places.

False if the Place is a known place.

Not returned when the partner does not provide the information.

For example, returns False for an address location that is found in the partner data, but returns True if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.

$sel:label:Place', place_label - The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA.

$sel:municipality:Place', place_municipality - A name for a local area, such as a city or town name. For example, Toronto.

$sel:neighborhood:Place', place_neighborhood - The name of a community district. For example, Downtown.

$sel:postalCode:Place', place_postalCode - A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.

$sel:region:Place', place_region - A name for an area or geographical division, such as a province or state name. For example, British Columbia.

$sel:street:Place', place_street - The name for a street or a road to identify a location. For example, Main Street.

$sel:subRegion:Place', place_subRegion - A country, or an area that's part of a larger region. For example, Metro Vancouver.

$sel:timeZone:Place', place_timeZone - The time zone in which the Place is located. Returned only when using HERE as the selected partner.

$sel:unitNumber:Place', place_unitNumber - For addresses with multiple units, the unit identifier. Can include numbers and letters, for example 3B or Unit 123.

Returned only for a place index that uses Esri as a data provider. Is not returned for SearchPlaceIndexForPosition.

$sel:unitType:Place', place_unitType - For addresses with a UnitNumber, the type of unit. For example, Apartment.

$sel:geometry:Place', place_geometry - Undocumented member.

The numerical portion of an address, such as a building number.

A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.

True if the result is interpolated from other known places.

False if the Place is a known place.

Not returned when the partner does not provide the information.

For example, returns False for an address location that is found in the partner data, but returns True if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.

The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA.

A name for a local area, such as a city or town name. For example, Toronto.

The name of a community district. For example, Downtown.

A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.

A name for an area or geographical division, such as a province or state name. For example, British Columbia.

The name for a street or a road to identify a location. For example, Main Street.

A country, or an area that's part of a larger region. For example, Metro Vancouver.

The time zone in which the Place is located. Returned only when using HERE as the selected partner.

For addresses with multiple units, the unit identifier. Can include numbers and letters, for example 3B or Unit 123.

Returned only for a place index that uses Esri as a data provider. Is not returned for SearchPlaceIndexForPosition.

For addresses with a UnitNumber, the type of unit. For example, Apartment.

Undocumented member.