Address interface

Package:

@azure/maps-search

The address of the result

Properties

boundingBox	The bounding box of the location.
buildingNumber	The building number on the street. DEPRECATED, use streetNumber instead.
country	Country name
countryCode	Country (Note: This is a two-letter code, not a country name.)
countryCodeISO3	ISO alpha-3 country code
countrySecondarySubdivision	County
countrySubdivision	State or Province
countrySubdivisionName	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	Named Area
crossStreet	The name of the street being crossed.
extendedPostalCode	Extended postal code (availability is dependent on the region).
freeformAddress	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	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	City / Town
municipalitySubdivision	Sub / Super City
postalCode	Postal Code / Zip Code
routeNumbers	The codes used to unambiguously identify the street
street	The street name. DEPRECATED, use streetName instead.
streetName	The street name.
streetNameAndNumber	The street name and number.
streetNumber	The building number on the street.

Property Details

boundingBox

The bounding box of the location.

boundingBox?: BoundingBox

Property Value

BoundingBox

buildingNumber

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

buildingNumber?: string

Property Value

string

country

Country name

country?: string

Property Value

string

countryCode

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

countryCode?: string

Property Value

string

countryCodeISO3

ISO alpha-3 country code

countryCodeISO3?: string

Property Value

string

countrySecondarySubdivision

County

countrySecondarySubdivision?: string

Property Value

string

countrySubdivision

State or Province

countrySubdivision?: string

Property Value

string

countrySubdivisionName

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.

countrySubdivisionName?: string

Property Value

string

countryTertiarySubdivision

Named Area

countryTertiarySubdivision?: string

Property Value

string

crossStreet

The name of the street being crossed.

crossStreet?: string

Property Value

string

extendedPostalCode

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

extendedPostalCode?: string

Property Value

string

freeformAddress

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.

freeformAddress?: string

Property Value

string

localName

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.

localName?: string

Property Value

string

municipality

City / Town

municipality?: string

Property Value

string

municipalitySubdivision

Sub / Super City

municipalitySubdivision?: string

Property Value

string

postalCode

Postal Code / Zip Code

postalCode?: string

Property Value

string

routeNumbers

The codes used to unambiguously identify the street

routeNumbers?: string[]

Property Value

string[]

street

The street name. DEPRECATED, use streetName instead.

street?: string

Property Value

string

streetName

The street name.

streetName?: string

Property Value

string

streetNameAndNumber

The street name and number.

streetNameAndNumber?: string

Property Value

string

streetNumber

The building number on the street.

streetNumber?: string

Property Value

string