Get Autocomplete Previews

client.addressVerification.getAutocompletePreviews(, ?): AddressVerificationGetAutocompletePreviewsResponse { data, message, status }

GET/v1/addver/completions

Returns address completion previews for a partial street address, suitable for populating an autocomplete dropdown without consuming a lookup per keystroke.

Each result contains a partial address preview (street, city, and — for non-US addresses — only the first 3 digits of the postal code, to avoid revealing the full code before a lookup is charged).

Does not consume a lookup.
Use POST /completions to resolve a full address once the user selects a result.

ParametersExpand Collapse

query: AddressVerificationGetAutocompletePreviewsParams { partialStreet, cityFilter, countryFilter, 7 more }

partialStreet: string

cityFilter?: string

countryFilter?: string

filterExact?: boolean

limit?: number

pcFilter?: string

properCase?: boolean

provInsteadOfPC?: boolean

stateFilter?: string

verifiedOnly?: boolean

ReturnsExpand Collapse

AddressVerificationGetAutocompletePreviewsResponse { data, message, status }

data: Array<Data>

preview: Preview { address, city, pc, prov }

A partial view of the address, suitable for display in an autocomplete dropdown.

address: string

The street address line.

city?: string

The city.

pc?: string

For US addresses, the full postal code. For non-US addresses, only the first 3 digits are returned to avoid consuming a lookup.

prov?: string

The province or state abbreviation. Returned instead of pc when provInsteadOfPC=true.

message: string

status: "success" | "error"

One of the following:

"success"

"error"

Get Autocomplete Previews

import PostGrid from 'postgrid-node';

const client = new PostGrid({
  addressVerificationAPIKey: process.env['POSTGRID_ADDRESS_VERIFICATION_API_KEY'], // This is the default and can be omitted
});

const response = await client.addressVerification.getAutocompletePreviews({
  partialStreet: 'partialStreet',
});

console.log(response.data);

{
  "data": [
    {
      "preview": {
        "address": "address",
        "city": "city",
        "pc": "pc",
        "prov": "prov"
      }
    }
  ],
  "message": "message",
  "status": "success"
}

Returns Examples

{
  "data": [
    {
      "preview": {
        "address": "address",
        "city": "city",
        "pc": "pc",
        "prov": "prov"
      }
    }
  ],
  "message": "message",
  "status": "success"
}