Address Autocomplete

The Address Autocomplete API provides intelligent address suggestions as users type, helping them quickly find and select valid US addresses. This endpoint returns standardized addresses along with their component breakdowns.

The address suggestions model

The address suggestion model returns an array of potential address matches, each containing both the standardized full address and its individual components.

Address Suggestions Properties

Name
suggestions
Type
array
Description
Array of address suggestions matching the input query (AddressSuggestion).

AddressSuggestion Properties

Name
standardized_address
Type
string
Description
Complete standardized address string.
Name
components
Type
AddressSuggestionComponents
Description
Breakdown of address components (AddressSuggestionComponents).

AddressSuggestionComponents Properties

Name
street_address
Type
string
Description
The street line of the address.
Name
apt_suite_other
Type
string
Description
The apartment, suite, or space number (if any).
Name
city
Type
string
Description
Name of the city.
Name
state
Type
string
Description
Two-letter state abbreviation.
Name
zip_code
Type
string
Description
The ZIP code.

GET/v1/addresses/autocomplete

Get address suggestions

This endpoint returns address suggestions based on partial input text. It's designed to provide real-time suggestions as users type their address. Be sure to have the query param to URL-encoded format.

Required parameters

Name
query
Type
string
Description
The partial address input to get suggestions for. This can be any part of an address.

Request

GET

/v1/addresses/city-state-zip

curl https://us-address.addressfully.com/address-lookup/v1/addresses/autocomplete \
    -H "Authorization: Bearer {api_key}" \
    -G \
    -d "query=123%20Main%20St%2C%20Spring"

Response

{
    "suggestions": [
        {
            "standardized_address": "123 Main St, Springfield, IL 62701",
            "components": {
                "street_address": "123 Main St",
                "apt_suite_other": "",
                "city": "Springfield",
                "state": "IL",
                "zip_code": "62701"
            }
        },
        {
            "standardized_address": "123 Main St, Spring Valley, NY 10977",
            "components": {
                "street_address": "123 Main St",
                "apt_suite_other": "",
                "city": "Spring Valley",
                "state": "NY",
                "zip_code": "10977"
            }
        },
        {
            "standardized_address": "123 Main St, Spring Hill, FL 34609",
            "components": {
                "street_address": "123 Main St",
                "apt_suite_other": "",
                "city": "Spring Hill",
                "state": "FL",
                "zip_code": "34609"
            }
        }
    ]
}