Response Structure
The Geocoder Autocomplete API response is in JSON format.
The table below documents the elements of the response.
Element | Description | Example |
---|---|---|
suggestions | Top-most element holding list of suggestions. The element is absent in case of an error. | |
label | Formatted response label including support for match highlights. | |
language | Language of the match. 2-letter ISO language code. | |
countryCode | Country of the location. 3-letter ISO country code. | |
locationId | Client applications use the locationId for location lookup. | |
address | Structured address block. The address elements support match highlighting. | For addresses from Australia, New Zealand and Canada a unit number can be included in the result if it was part of the query. |
distance | Distance in meters from the search center. Only available for queries with mapview or prox parameter. | |
matchLevel | Match precision. One of: houseNumber , intersection , street , postalCode , district , city , county , state , country | |