Skip to main content

​
Autocomplete response

The autocomplete endpoint returns a structured response containing a list of matching addresses. Each response includes:
  • A list of address results (hits)
  • The maximum number of results requested (limit)
The response model is consistent across all supported countries. Country-specific differences in address structure are expressed through typed address components, rather than different response schemas.

​
Address results

Each item in hits represents a single, normalized address. An address consists of:
  • A country code
  • A list of typed address components
  • Human-readable address lines
  • A geographic location
This structure allows clients to display addresses directly to users, while also working with individual address parts when needed.

​
Typed components

Address components are returned as a list of { type, value } pairs. Component types are country-specific and describe the semantic meaning of each value (for example, street name, house number, postal code, or locality). This avoids forcing all countries into a single rigid address format. For a detailed breakdown of component types and semantics, see the Addressing model.

Address autocomplete result set.

​
hits
object[]
required
​
limit
integer
required

Maximum number of results requested.