Autocomplete a partial US address.
POST {{baseUrl}}/us_autocompletions
Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses.
Request Body
[{"name"=>"address_prefix", "value"=>"1", "datatype"=>"number"}, {"name"=>"city", "value"=>"San Francisco", "datatype"=>"string"}, {"name"=>"state", "value"=>"CA", "datatype"=>"string"}, {"name"=>"zip_code", "value"=>"94107", "datatype"=>"number"}, {"name"=>"geo_ip_sort", "value"=>"true", "datatype"=>"boolean"}]
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"id":"us_auto_a3ac97bcfbb2460ab20c","suggestions":[{"primary_line":"185 BAYSIDE VILLAGE PL","city":"SAN FRANCISCO","state":"CA","zip_code":"94107"},{"primary_line":"185 BRANNAN ST","city":"SAN FRANCISCO","state":"CA","zip_code":"94107"},{"primary_line":"185 BONIFACIO ST","city":"SAN FRANCISCO","state":"CA","zip_code":"94107"},{"primary_line":"185 BLAIR TER","city":"SAN FRANCISCO","state":"CA","zip_code":"94107"},{"primary_line":"185 BLUXOME ST","city":"SAN FRANCISCO","state":"CA","zip_code":"94107"},{"primary_line":"185 BERRY ST","city":"SAN FRANCISCO","state":"CA","zip_code":"94107"},{"primary_line":"185 BRYANT ST","city":"SAN FRANCISCO","state":"CA","zip_code":"94107"}],"object":"us_autocompletion"}