Geocoder Autocomplete API Developer's Guide

Response Structure

The Geocoder Autocomplete API response is in JSON format.

The table below documents the elements of the response.

Table 1. Response Elements
Element	Description	Example
suggestions	Top-most element holding list of suggestions. The element is absent in case of an error.	`suggestions: [ .... ]`
label	Formatted response label including support for match highlights.	`label: "Deutschland, [Berli]n, [Berli]n, 10117, [Berli]n, [Pariser] Platz [1]"`
language	Language of the match. 2-letter ISO language code.	`language: "de"`
countryCode	Country of the location. 3-letter ISO country code.	`countryCode: "DEU"`
locationId	Client applications use the `locationId` for location lookup.	`locationId: "NT_5mGkj3z90Fbj4abzMbUE4C_xA"`
address	Structured address block. The address elements support match highlighting.	`address: { country: "Deutschland", state: "Berlin", county: "Berlin", city: "Berlin", district: "Mitte", street: "Pariser Platz", houseNumber: "1", postalCode: "10117" }` For addresses from Australia, New Zealand and Canada a unit number can be included in the result if it was part of the query. `address: { country: "New Zealand", state: "Canterbury", county: "Christchurch City", city: "Christchurch", district: "Edgeware", street: "Allard St", houseNumber: "9", unit: "3", postalCode: "8013" }`
distance	Distance in meters from the search center. Only available for queries with `mapview` or `prox` parameter.	`suggestions [{ label: "Deutschland, Berlin, Pariser Platz", ... address: { country: "Deutschland", state: "Berlin", county: "Berlin", city: "Berlin", district: "Mitte", street: "Pariser Platz", houseNumber: "1", postalCode: "10117" }, distance: 666, matchLevel: "street" }`
matchLevel	Match precision. One of: `houseNumber`, `intersection`, `street`, `postalCode`, `district`, `city`, `county`, `state`, `country`	`matchLevel: "houseNumber"`