Addresses
Autocomplete Addresses
GET
Return fast, bounded suggestions for US street addresses and normalized DealMachine locations. Use
this endpoint in address inputs, city and county pickers, and workflows where a user has not
supplied an exact DealMachine location.
Autocomplete is free and does not perform property or person enrichment. It does not accept
fields, contact_audience, or other enrichment controls. Address results contain address
components and may include a normalized DealMachine city or county location for a later explicit
search or enrichment request.
GET /v1/locations/autocomplete remains available as a deprecated compatibility alias. New
integrations should use this addresses Endpoint.Query Parameters
string
required
At least two characters of a street address, city, county, state, or ZIP code. Maximum 200 characters.
string
default:"all"
Choose
all, address, or location. Use address for a street-address input and location for a city, county, state, or ZIP picker.string
Optional two-letter state abbreviation used to prefer and normalize results in one state.
integer
default:"5"
Maximum suggestions to return. Minimum 1 and maximum 10.
number
Optional latitude for nearby address ranking.
longitude is required when this parameter is supplied.number
Optional longitude for nearby address ranking.
latitude is required when this parameter is supplied.App integration best practices
Wait until the user has entered at least two characters, debounce requests for about 200 milliseconds, and cancel any previous request when the input changes. Keeplimit=5 for most menus
and use scope=address when the control accepts only a street address.
Treat each suggestion as discovery data. Do not expect fields or enrichment output from this
endpoint. After selection, pass the returned address to an enrichment Endpoint or pass
location.location_id or location.code to a search Endpoint.
partial_results=true means the address provider was unavailable or exceeded its short timeout.
The Endpoint still returns any normalized DealMachine location suggestions that were available, so
the UI can remain usable without waiting on the address provider.