Package version:

Interface Address

The address of the result

Hierarchy

  • Address

Properties

boundingBox?: any

The bounding box of the location.

buildingNumber?: string

The building number on the street. DEPRECATED, use streetNumber instead.

country?: string

Country name

countryCode?: string

Country (Note: This is a two-letter code, not a country name.)

countryCodeISO3?: string

ISO alpha-3 country code

countrySecondarySubdivision?: string

County

countrySubdivision?: string

State or Province

countrySubdivisionName?: string

The full name of a first level of country administrative hierarchy. This field appears only in case countrySubdivision is presented in an abbreviated form. Only supported for USA, Canada, and Great Britain.

countryTertiarySubdivision?: string

Named Area

crossStreet?: string

The name of the street being crossed.

extendedPostalCode?: string

Extended postal code (availability is dependent on the region).

freeformAddress?: string

An address line formatted according to the formatting rules of a Result's country of origin, or in the case of a country, its full country name.

localName?: string

An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit. This field is used to build the freeformAddress property.

municipality?: string

City / Town

municipalitySubdivision?: string

Sub / Super City

postalCode?: string

Postal Code / Zip Code

routeNumbers?: Object

The codes used to unambiguously identify the street

street?: string

The street name. DEPRECATED, use streetName instead.

streetName?: string

The street name.

streetNameAndNumber?: string

The street name and number.

streetNumber?: string

The building number on the street.

Generated using TypeDoc