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.
Query parameters
Version number of Azure Maps API.
The 2 or 3 letter ISO3166-1 country/region code portion of an address. E.g. US.
Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100
Starting offset of the returned results within the full result set. Default: 0
The street number portion of an address
The street name portion of an address
The cross street name for the structured address
The municipality portion of an address
The municipality subdivision (sub/super city) for the structured address
The named area for the structured address
The country/region for the structured address
The country/region subdivision portion of an address
The postal code portion of an address
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.
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
Parameters
Response
OK