Use to get a street address and location info from latitude and longitude coordinates.

The Get Search Address Reverse API is and HTTP GET request that returns a street address or location when given latitude and longitude coordinates.

There may be times when you need to translate a coordinate (example: 37.786505, -122.3862) into a human understandable street address. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located. This endpoint will return address information for a given coordinate.

get/search/address/reverse/{format}

Query parameters

api-versionstring required

Version number of Azure Maps API.

querynumber[] required

The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".

returnSpeedLimitboolean

Boolean. To enable return of the posted speed limit

headinginteger

The directional heading of the vehicle in degrees, for travel along a segment of roadway. 0 is North, 90 is East and so on, values range from -360 to 360. The precision can include upto one decimal place

radiusinteger

The radius in meters to for the results to be constrained to the defined area

numberstring

Street number as a string. If a number is sent in along with the request, the response may include the side of the street (Left/Right) and also an offset position for that number

returnRoadUseboolean

Boolean. To enable return of the road use array for reverse geocodes at street level

roadUsestring[]

To restrict reverse geocodes to a certain type of road use. The road use array for reverse geocodes can be one or more of LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet

allowFreeformNewlineboolean

Format of newlines in the formatted address.

If true, the address will contain newlines. If false, newlines will be converted to commas.

returnMatchTypeboolean

Include information on the type of match the geocoder achieved in the response.

entityType'Country' | 'CountrySubdivision' | 'CountrySecondarySubdivision' | 'CountryTertiarySubdivision' | 'Municipality' | 'MunicipalitySubdivision' | 'Neighbourhood' | 'PostalCodeArea'

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

../../../Common/preview/1.0/common.json#/components/parameters/ClientId — unresolved $ref
../../../Common/preview/1.0/common.json#/components/parameters/ResponseFormat — unresolved $ref
../../../Common/preview/1.0/common.json#/components/parameters/Language — unresolved $ref
../../../Common/preview/1.0/common.json#/components/parameters/View — unresolved $ref

Response

OK

Changes