v7

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-121372601.5 MB
International API

Returns address completion previews for a partial address string, suitable for populating an autocomplete dropdown.

Regular mode — supply partialStreet to search by partial street address. Results may include directly-resolvable Address results and non-Address results (e.g. BuildingNumber) that represent buildings/complexes requiring a follow-up call.

Advanced mode — supply advanced=true and a container ID (the id of a non-Address result from a previous regular call) to drill into a building or complex and retrieve individual unit addresses.

Results with type: "Address" can be fully resolved by passing their id to POST /completions.

  • Results are biased by the caller's IP address by default; pass disableIPBiasing=true to turn this off.
  • Does not consume a lookup.
get/v1/intl_addver/completions

Query parameters

partialStreetstring
containerstring
countriesFilterstring
limitinteger
languagestring
cityFilterstring
streetFilterstring
postalOrZipFilterstring
advancedboolean
disableIPBiasingboolean
standardFallbackboolean
useEnhancedChinaDatasetboolean

Response

The request has succeeded.

status'success' | 'error' required
messagestring required