Get Autocomplete Previews

intl_address_verification.get_autocomplete_previews() -> IntlAddressVerificationGetAutocompletePreviewsResponse

GET/v1/intl_addver/completions

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 Address types (resolvable directly) and Container types (buildings/complexes that require a follow-up call).

Advanced mode — supply advanced=true and a container ID (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.

Does not consume a lookup.

ParametersExpand Collapse

advanced: Optional[bool]

city_filter: Optional[str]

container: Optional[str]

countries_filter: Optional[str]

disable_ip_biasing: Optional[bool]

language: Optional[str]

limit: Optional[int]

partial_street: Optional[str]

postal_or_zip_filter: Optional[str]

standard_fallback: Optional[bool]

street_filter: Optional[str]

use_enhanced_china_dataset: Optional[bool]

ReturnsExpand Collapse

class IntlAddressVerificationGetAutocompletePreviewsResponse: …

data: List[Data]

id: Optional[str]

The unique identifier for this result. Pass this to POST /completions to retrieve the full address. If the type is Container, pass it as the container parameter to GET /completions to drill down further.

description: Optional[str]

A secondary description of the result (e.g. city and country).

error: Optional[str]

An error message if the lookup failed for this result.

highlight: Optional[str]

Character ranges within text that match the search input, for bolding in UI.

text: Optional[str]

The human-readable address suggestion text.

type: Optional[str]

The type of result. Address means this can be resolved directly via POST /completions. Container means the result represents a building or complex — perform another GET /completions with this id as container to get individual unit addresses.

message: str

status: Literal["success", "error"]

One of the following:

"success"

"error"

Get Autocomplete Previews

import os
from postgrid import PostGrid

client = PostGrid(
    address_verification_api_key=os.environ.get("POSTGRID_ADDRESS_VERIFICATION_API_KEY"),  # This is the default and can be omitted
)
response = client.intl_address_verification.get_autocomplete_previews()
print(response.data)

{
  "status": "success",
  "message": "Address previews retrieved successfully",
  "data": [
    {
      "id": "GB|RM|A|54186236",
      "type": "Address",
      "text": "Flat 1, One Canada Square",
      "description": "London, E14 5AB"
    }
  ]
}

{
  "status": "success",
  "message": "Address previews retrieved successfully",
  "data": [
    {
      "id": "GB|RM|A|54186236",
      "type": "Address",
      "text": "10 Downing Street",
      "description": "London, SW1A 2AA"
    }
  ]
}

Returns Examples

{
  "status": "success",
  "message": "Address previews retrieved successfully",
  "data": [
    {
      "id": "GB|RM|A|54186236",
      "type": "Address",
      "text": "Flat 1, One Canada Square",
      "description": "London, E14 5AB"
    }
  ]
}

{
  "status": "success",
  "message": "Address previews retrieved successfully",
  "data": [
    {
      "id": "GB|RM|A|54186236",
      "type": "Address",
      "text": "10 Downing Street",
      "description": "London, SW1A 2AA"
    }
  ]
}