Autocomplete a US address
lob_us_autocompletions_createAutocomplete US addresses from a partial input for typeahead UX. Returns up to 10 suggestions based on address prefix, city, state, or zip code.
Instructions
Suggest completed US addresses from a partial input — useful for typeahead UX. Returns up to 10 suggestions.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| address_prefix | Yes | Partial primary address line to autocomplete. | |
| city | No | ||
| state | No | Two-letter US state code. | |
| zip_code | No | ||
| geo_ip_sort | No | Sort suggestions by proximity to the requesting IP. | |
| extra | No | Additional Lob API parameters not enumerated above. Merged into the request body verbatim. See https://docs.lob.com for the full parameter list per resource. |