Address Object (Autosuggest Module)

Note

Bing Maps Web Control SDK retirement

Bing Maps Web Control SDK is deprecated and will be retired. Free (Basic) account customers can continue to use Bing Maps Web Control SDK until June 30th, 2025. Enterprise account customers can continue to use Bing Maps Web Control SDK until June 30th, 2028. To avoid service disruptions, all implementations using Bing Maps Web Control SDK will need to be updated to use Azure Maps Web SDK by the retirement date that applies to your Bing Maps for Enterprise account type. For detailed migration guidance, see Migrate Bing Maps Enterprise applications to Azure Maps with GitHub Copilot.

Azure Maps is Microsoft's next-generation maps and geospatial services for developers. Azure Maps has many of the same features as Bing Maps for Enterprise, and more. To get started with Azure Maps, create a free Azure subscription and an Azure Maps account. For more information about azure Maps, see Azure Maps Documentation. For migration guidance, see Bing Maps Migration Overview.

Represents a structured address.

Name Type Description
addressLine string The street line of an address. The addressLine property is the most precise, official line for an address relative to the postal agency servicing the area specified by the locality or postalCode properties.
adminDistrict string The subdivision name within the country or region for an address. This element is also commonly treated as the first order administrative subdivision. An example is a US state, such as “Oregon”.
countryRegion string The country or region name of the address.
countryRegionISO2 string A string specifying the two-letter ISO country code.
district string The second, third, or fourth order subdivision within a country/region, dependency, or region. An example is a US county, such as “King”.
formattedAddress string A nicely formatted address string.
locality string The locality, such as the primary city, that corresponds to an address. An example is “Seattle”.
postalCode string The post code, postal code, or ZIP code of an address. An example is a US ZIP code, such as “98152”.