Places (Search) API Developer's Guide

Address Object Structure

Address information is provided in two ways: as a displayable, formatted address string as well as a series of structured attributes.

  "address": {
    "street": "22 Rue du Grenier Saint-Lazare",
    "postalCode": "75003",
    "city": "Paris",
    "countryCode": "FRA",
    "country": "France",
    "text": "22 Rue du Grenier Saint-Lazare\n75003 Paris\nFrance"

The address object contains the following attributes:

Attribute Type Description
text String (formatted text) A displayable, formatted address as rich text.
level String; optional Contains level of place inside of a venue
building String; optional Building name
house String; optional House or street number.
street String; optional Street name (in practice may also contain street number).
postalCode String; optional An alphanumeric string included in a postal address to facilitate mail sorting (a.k.a. post code, postcode, or ZIP code).
areas Array[String]; optional An array of named areas below the district and above street. In some regions such areas might also contain street names, when individual street segments have names separate from the name of the whole road.
district String; optional A division of city; typically an administrative unit within a larger city or a customary name of a city's neighborhood.
city String; optional The name of the primary locality of the place.
regions Array[String]; optional For address conventions where more than to levels of named areas above the city level are in use, the regions attribute provides an array with all additional area names, ordered by decreasing size (starting with the highest subdivision below state)
county String; optional A division of a state; typically a secondary-level administrative division of a country or equivalent.
state String; optional A division of a country; typically a first-level administrative division of a country and/or a geographical region.
stateCode String; optional A code/abbreviation for the state division of a country.
country String; optional The localised country name.
countryCode String (ISO 3166-1 alpha-3 code); optional A three-letter country code.

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on