Search - Get Search Address Structured

Use to get latitude and longitude coordinates of a street address in an unstructured or query input format.
The Get Search Address Structured (Structured Address Geocoding) API is an HTTP GET request that returns latitude and longitude coordinates of a street address in an unstructured or query input format.

The geocoding search index will be queried for everything above the street level data. No POIs will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc.

GET https://atlas.microsoft.com/search/address/structured/{format}?api-version=1.0&countryCode={countryCode}
GET https://atlas.microsoft.com/search/address/structured/{format}?api-version=1.0&language={language}&countryCode={countryCode}&limit={limit}&ofs={ofs}&streetNumber={streetNumber}&streetName={streetName}&crossStreet={crossStreet}&municipality={municipality}&municipalitySubdivision={municipalitySubdivision}&countryTertiarySubdivision={countryTertiarySubdivision}&countrySecondarySubdivision={countrySecondarySubdivision}&countrySubdivision={countrySubdivision}&postalCode={postalCode}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}

URI Parameters

Name In Required Type Description
format
path True

ResponseFormat

Desired format of the response. Value can be either json or xml.

api-version
query True

string

Version number of Azure Maps API.

countryCode
query True

string

The 2 or 3 letter ISO3166-1 country/region code portion of an address. E.g. US.

countrySecondarySubdivision
query

string

The country/region for the structured address

countrySubdivision
query

string

The country/region subdivision portion of an address

countryTertiarySubdivision
query

string

The named area for the structured address

crossStreet
query

string

The cross street name for the structured address

entityType
query

GeographicEntityType

Specifies the level of filtering performed on geographies. Narrows the search for specified geography entity types, e.g. return only municipality. The resulting response will contain the geography ID as well as the entity type matched. If you provide more than one entity as a comma separated list, endpoint will return the 'smallest entity available'. Returned Geometry ID can be used to get the geometry of that geography via Get Search Polygon API. The following parameters are ignored when entityType is set:

  • heading
  • number
  • returnRoadUse
  • returnSpeedLimit
  • roadUse
  • returnMatchType
extendedPostalCodesFor
query

SearchIndexes[]

Indexes for which extended postal codes should be included in the results.

Available indexes are:

Addr = Address ranges

Geo = Geographies

PAD = Point Addresses

POI = Points of Interest

Str = Streets

XStr = Cross Streets (intersections)

Value should be a comma separated list of index types (in any order) or None for no indexes.

By default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.

Usage examples:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Extended postal code is returned as an extendedPostalCode property of an address. Availability is region-dependent.

language
query

string

Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.

Please refer to Supported Languages for details.

limit
query

integer

Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100

municipality
query

string

The municipality portion of an address

municipalitySubdivision
query

string

The municipality subdivision (sub/super city) for the structured address

ofs
query

integer

Starting offset of the returned results within the full result set. Default: 0

postalCode
query

string

The postal code portion of an address

streetName
query

string

The street name portion of an address

streetNumber
query

string

The street number portion of an address

view
query

LocalizedMapView

The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country/region where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.

Please refer to Supported Views for details and to see the available Views.

Request Header

Name Required Type Description
x-ms-client-id

string

Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following articles for guidance.

Responses

Name Type Description
200 OK

SearchAddressResult

OK

Other Status Codes

ErrorResponse

An unexpected error occurred.

Security

AADToken

These are the Microsoft Entra OAuth 2.0 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.

To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Note

  • This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.
  • The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations.
  • The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.
  • Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.
  • For more information on Microsoft identity platform, see Microsoft identity platform overview.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

This is a shared key that is provisioned when you Create an Azure Maps account in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.

With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.

For publicly exposed applications, our recommendation is to use the confidential client applications approach to access Azure Maps REST APIs so your key can be securely stored.

Type: apiKey
In: query

SAS Token

This is a shared access signature token is created from the List SAS operation on the Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.

With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.

For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the Map account resource to limit rendering abuse and regularly renew the SAS Token.

Type: apiKey
In: header

Examples

Search address in Redmond, WA in structured form

Sample request

GET https://atlas.microsoft.com/search/address/structured/json?api-version=1.0&countryCode=US&streetNumber=15127&streetName=NE%2024th%20Street&municipality=Redmond&postalCode=98052

Sample response

{
  "summary": {
    "query": "15127 98052 ne redmond wa",
    "queryType": "NON_NEAR",
    "queryTime": 57,
    "numResults": 1,
    "offset": 0,
    "totalResults": 34,
    "fuzzyLevel": 1,
    "geoBias": {
      "lat": 47.30129317913035,
      "lon": -120.88247999999997
    }
  },
  "results": [
    {
      "type": "Point Address",
      "id": "US/PAD/p0/37974392",
      "score": 8.074,
      "dist": 101274.64693865852,
      "address": {
        "streetNumber": "15127",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond, Earlmount, Avondale, Ames Lake, Adelaide",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "980525544",
        "countryCode": "US",
        "country": "United States Of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "15127 NE 24th St, Redmond, WA 98052",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6308,
        "lon": -122.1385
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.6317,
          "lon": -122.13983
        },
        "btmRightPoint": {
          "lat": 47.6299,
          "lon": -122.13717
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6315,
            "lon": -122.13852
          }
        }
      ]
    }
  ]
}

Definitions

Name Description
Address

The address of the result

AddressRanges

Describes the address range on both sides of the street for a search result. Coordinates for the start and end locations of the address range are included.

BoundingBox

The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport.

BoundingBoxCompassNotation

The bounding box of the location.

Brand

The brand associated with the POI

Classification

The classification for the POI being returned

ClassificationName

Name for the classification

DataSources

Optional section. Reference ids for use with the Get Search Polygon API.

Entity

Entity type source of the bounding box. For reverse-geocoding this is always equal to position.

EntryPoint

The entry point for the POI being returned.

EntryPointType

The type of entry point. Value can be either main or minor.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

GeographicEntityType

Geography entity type. Present only when entityType was requested and is available.

Geometry

Information about the geometric shape of the result. Only present if type == Geography.

LatLongPairAbbreviated

A location represented as a latitude and longitude using short names 'lat' & 'lon'.

LocalizedMapView

The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country/region where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.

Please refer to Supported Views for details and to see the available Views.

MatchType

Types of match for a reverse address search operation.

OperatingHours

Opening hours for a POI (Points of Interest).

OperatingHoursTime

Represents a date and time

OperatingHoursTimeRange

Open time range for a day

PointOfInterest

Details of the returned POI including information such as the name, phone, url address, and classifications.

PointOfInterestCategorySet

POI category

QueryType

The type of query being returned: NEARBY or NON_NEAR.

ResponseFormat

Desired format of the response. Value can be either json or xml.

SearchAddressResult

This object is returned from a successful Search calls.

SearchAddressResultItem

Result object for a Search API response.

SearchAddressResultType

One of:

  • POI
  • Street
  • Geography
  • Point Address
  • Address Range
  • Cross Street
SearchIndexes

Indexes for which extended postal codes should be included in the results.

Available indexes are:

Addr = Address ranges

Geo = Geographies

PAD = Point Addresses

POI = Points of Interest

Str = Streets

XStr = Cross Streets (intersections)

Value should be a comma separated list of index types (in any order) or None for no indexes.

By default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.

Usage examples:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Extended postal code is returned as an extendedPostalCode property of an address. Availability is region-dependent.

SearchSummary

Summary object for a Search API response.

Address

The address of the result

Name Type Description
boundingBox

BoundingBoxCompassNotation

The bounding box of the location.

buildingNumber

string

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

country

string

country/region name

countryCode

string

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

countryCodeISO3

string

ISO alpha-3 country code

countrySecondarySubdivision

string

County

countrySubdivision

string

State or Province

countrySubdivisionCode

string

countrySubdivisionCode prefixed by countryCode ( countryCode-countrySubdivisionCode ) and the hyphen forms the ISO 3166-2 code. Examples: TX for Texas, SCT for Scotland and ON for Ontario.

countrySubdivisionName

string

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

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/region of origin, or in the case of a country/region, its full country/region name.

localName

string

An address component that represents the name of a geographic area or locality that groups multiple addressable objects for addressing purposes, without being an administrative unit. This field is used to build the freeformAddress property. localName represents the postal municipality. Depending on the location, localName is the commonly known name of a city or town. For the commonly known name of a city or town, use localName instead of municipality.

municipality

string

City / Town
Note: municipality represents the residential municipality. Depending on the location, the municipality value may differ from the commonly known name of a city or town. For the commonly known name of the city or town, it’s suggested that the localName value be used instead of the municipality value.

municipalitySubdivision

string

Sub / Super City

neighbourhood

string

A Neighbourhood is a geographically localized area within a city or town with distinctive characteristics and social interactions between inhabitants.

postalCode

string

Postal Code / Zip Code

routeNumbers

string[]

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.

AddressRanges

Describes the address range on both sides of the street for a search result. Coordinates for the start and end locations of the address range are included.

Name Type Description
from

LatLongPairAbbreviated

A location represented as a latitude and longitude using short names 'lat' & 'lon'.

rangeLeft

string

Address range on the left side of the street.

rangeRight

string

Address range on the right side of the street.

to

LatLongPairAbbreviated

A location represented as a latitude and longitude using short names 'lat' & 'lon'.

BoundingBox

The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport.

Name Type Description
btmRightPoint

LatLongPairAbbreviated

A location represented as a latitude and longitude using short names 'lat' & 'lon'.

topLeftPoint

LatLongPairAbbreviated

A location represented as a latitude and longitude using short names 'lat' & 'lon'.

BoundingBoxCompassNotation

The bounding box of the location.

Name Type Description
entity

Entity

Entity type source of the bounding box. For reverse-geocoding this is always equal to position.

northEast

string

North-east latitude,longitude coordinate of the bounding box as comma-separated floats

southWest

string

South-west latitude,longitude coordinate of the bounding box as comma-separated floats

Brand

The brand associated with the POI

Name Type Description
name

string

Name of the brand

Classification

The classification for the POI being returned

Name Type Description
code

string

Code property

names

ClassificationName[]

Names array

ClassificationName

Name for the classification

Name Type Description
name

string

Name property

nameLocale

string

Name Locale property

DataSources

Optional section. Reference ids for use with the Get Search Polygon API.

Name Type Description
geometry

Geometry

Information about the geometric shape of the result. Only present if type == Geography.

Entity

Entity type source of the bounding box. For reverse-geocoding this is always equal to position.

Name Type Description
position

string

Position entity

EntryPoint

The entry point for the POI being returned.

Name Type Description
position

LatLongPairAbbreviated

A location represented as a latitude and longitude using short names 'lat' & 'lon'.

type

EntryPointType

The type of entry point. Value can be either main or minor.

EntryPointType

The type of entry point. Value can be either main or minor.

Name Type Description
main

string

minor

string

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

GeographicEntityType

Geography entity type. Present only when entityType was requested and is available.

Name Type Description
Country

string

country/region name

CountrySecondarySubdivision

string

County

CountrySubdivision

string

State or Province

CountryTertiarySubdivision

string

Named Area

Municipality

string

City / Town

MunicipalitySubdivision

string

Sub / Super City

Neighbourhood

string

Neighbourhood

PostalCodeArea

string

Postal Code / Zip Code

Geometry

Information about the geometric shape of the result. Only present if type == Geography.

Name Type Description
id

string

Pass this as geometryId to the Get Search Polygon API to fetch geometry information for this result.

LatLongPairAbbreviated

A location represented as a latitude and longitude using short names 'lat' & 'lon'.

Name Type Description
lat

number

Latitude property

lon

number

Longitude property

LocalizedMapView

The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country/region where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.

Please refer to Supported Views for details and to see the available Views.

Name Type Description
AE

string

United Arab Emirates (Arabic View)

AR

string

Argentina (Argentinian View)

Auto

string

Return the map data based on the IP address of the request.

BH

string

Bahrain (Arabic View)

IN

string

India (Indian View)

IQ

string

Iraq (Arabic View)

JO

string

Jordan (Arabic View)

KW

string

Kuwait (Arabic View)

LB

string

Lebanon (Arabic View)

MA

string

Morocco (Moroccan View)

OM

string

Oman (Arabic View)

PK

string

Pakistan (Pakistani View)

PS

string

Palestinian Authority (Arabic View)

QA

string

Qatar (Arabic View)

SA

string

Saudi Arabia (Arabic View)

SY

string

Syria (Arabic View)

Unified

string

Unified View (Others)

YE

string

Yemen (Arabic View)

MatchType

Types of match for a reverse address search operation.

Name Type Description
AddressPoint

string

HouseNumberRange

string

Street

string

OperatingHours

Opening hours for a POI (Points of Interest).

Name Type Description
mode

string

Value used in the request: none or "nextSevenDays"

timeRanges

OperatingHoursTimeRange[]

List of time ranges for the next 7 days

OperatingHoursTime

Represents a date and time

Name Type Description
date

string

Represents current calendar date in POI time zone, e.g. "2019-02-07".

hour

integer

Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23.

minute

integer

Minutes are in the local time of a POI; possible values are 0 - 59.

OperatingHoursTimeRange

Open time range for a day

Name Type Description
endTime

OperatingHoursTime

The point in the next 7 days range when a given POI is being closed, or the beginning of the range if it was closed before the range.

startTime

OperatingHoursTime

The point in the next 7 days range when a given POI is being opened, or the beginning of the range if it was opened before the range.

PointOfInterest

Details of the returned POI including information such as the name, phone, url address, and classifications.

Name Type Description
brands

Brand[]

Brands array. The name of the brand for the POI being returned.

categories

string[]

Categories array

categorySet

PointOfInterestCategorySet[]

The list of the most specific POI categories

classifications

Classification[]

Classification array

name

string

Name of the POI property

openingHours

OperatingHours

Opening hours for a POI (Points of Interest).

phone

string

Telephone number property

url

string

Website URL property

PointOfInterestCategorySet

POI category

Name Type Description
id

integer

Category ID

QueryType

The type of query being returned: NEARBY or NON_NEAR.

Name Type Description
NEARBY

string

Search was performed around a certain latitude and longitude with a defined radius

NON_NEAR

string

Search was performed globally, without biasing to a certain latitude and longitude, and no defined radius

ResponseFormat

Desired format of the response. Value can be either json or xml.

Name Type Description
json

string

The JavaScript Object Notation Data Interchange Format

xml

string

The Extensible Markup Language

SearchAddressResult

This object is returned from a successful Search calls.

Name Type Description
results

SearchAddressResultItem[]

A list of Search API results.

summary

SearchSummary

Summary object for a Search API response

SearchAddressResultItem

Result object for a Search API response.

Name Type Description
address

Address

The address of the result

addressRanges

AddressRanges

Describes the address range on both sides of the street for a search result. Coordinates for the start and end locations of the address range are included.

dataSources

DataSources

Optional section. Reference geometry id for use with the Get Search Polygon API.

detourTime

integer

Detour time in seconds. Only returned for calls to the Search Along Route API.

dist

number

Straight line distance between the result and geobias location in meters.

entityType

GeographicEntityType

Geography entity type. Present only when entityType was requested and is available.

entryPoints

EntryPoint[]

Array of EntryPoints. Those describe the types of entrances available at the location. The type can be "main" for main entrances such as a front door, or a lobby, and "minor", for side and back doors.

id

string

Id property

info

string

Information about the original data source of the Result. Used for support requests.

matchType

MatchType

Information on the type of match.

One of:

  • AddressPoint
  • HouseNumberRange
  • Street
poi

PointOfInterest

Details of the returned POI including information such as the name, phone, url address, and classifications.

position

LatLongPairAbbreviated

A location represented as a latitude and longitude using short names 'lat' & 'lon'.

score

number

The value within a result set to indicate the relative matching score between results. You can use this to determine that result x is twice as likely to be as relevant as result y if the value of x is 2x the value of y. The values vary between queries and is only meant as a relative value for one result set.

type

SearchAddressResultType

One of:

  • POI
  • Street
  • Geography
  • Point Address
  • Address Range
  • Cross Street
viewport

BoundingBox

The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport.

SearchAddressResultType

One of:

  • POI
  • Street
  • Geography
  • Point Address
  • Address Range
  • Cross Street
Name Type Description
Address Range

string

Cross Street

string

Geography

string

POI

string

Point Address

string

Street

string

SearchIndexes

Indexes for which extended postal codes should be included in the results.

Available indexes are:

Addr = Address ranges

Geo = Geographies

PAD = Point Addresses

POI = Points of Interest

Str = Streets

XStr = Cross Streets (intersections)

Value should be a comma separated list of index types (in any order) or None for no indexes.

By default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.

Usage examples:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Extended postal code is returned as an extendedPostalCode property of an address. Availability is region-dependent.

Name Type Description
Addr

string

Geo

string

PAD

string

POI

string

Str

string

Xstr

string

SearchSummary

Summary object for a Search API response.

Name Type Description
fuzzyLevel

integer

The maximum fuzzy level required to provide Results.

geoBias

LatLongPairAbbreviated

Indication when the internal search engine has applied a geospatial bias to improve the ranking of results. In some methods, this can be affected by setting the lat and lon parameters where available. In other cases it is purely internal.

limit

integer

Maximum number of responses that will be returned

numResults

integer

Number of results in the response.

offset

integer

The starting offset of the returned Results within the full Result set.

query

string

The query parameter that was used to produce these search results.

queryTime

integer

Time spent resolving the query, in milliseconds.

queryType

QueryType

The type of query being returned: NEARBY or NON_NEAR.

totalResults

integer

The total number of Results found.