Location · GraphQL type

PhysicalAddress type

A physical address.

Fields

Field Name Description
id - PlusCodeGlobalCode! Unique id of the physical address if available in open location code format, also known as a global plus code.
addressComponents - [PhysicalAddressComponent!] An array containing the separate components applicable to this address.
street - String The street name or route parsed from the components for convenience if available.
streetNumber - String Street number parsed from the components for convenience if available.
neighborhood - String A named neighborhood parsed from the components for convenience if available.
district - String The district or sub-locality parsed from the components for convenience if available.
city - String City parsed from the components for convenience if available.
county - String County parsed from the components for convenience if USA and available.
state - String State parsed from the components for convenience if USA and available.
stateCode - String Two letter state code parsed from the components for convenience if USA and available.
province - String Province parsed from the components for convenience if Canada and available.
provinceCode - String Two letter province code parsed from the components for convenience if Canada and available.
country - String Country parsed from the components for convenience if available.
countryCode - String Two letter ISO 3166 country code parsed form the components for convenience if available. See ISO 3166-2 country codes (Wikipedia)
postalCode - String Postal code parsed from the components for convenience if available.
formattedAddress - String Full formatted address parsed from the components for convenience if available.
shortAddress - String A convenient short format address if available e.g.: Austin, TX USA

Used by

  • Location type: A physical place identified by its global plus code (Open Location Code), with a street address resolved by reverse geocoding.

Example

Example

{
  "id": "796RWF8Q+WF",
  "addressComponents": [PhysicalAddressComponent],
  "street": "xyz789",
  "streetNumber": "abc123",
  "neighborhood": "abc123",
  "district": "abc123",
  "city": "abc123",
  "county": "xyz789",
  "state": "xyz789",
  "stateCode": "abc123",
  "province": "xyz789",
  "provinceCode": "abc123",
  "country": "xyz789",
  "countryCode": "abc123",
  "postalCode": "abc123",
  "formattedAddress": "abc123",
  "shortAddress": "xyz789"
}