Address autocomplete

Fetch enriched address suggestions. Requires a partial address.

To use this endpoint from the browser, you’ll need to specify the /profile-enrichment.read scope when generating a token.

GET

/enrichment/address

cURL

1
2


curl -X GET "https://api.moov.io/enrichment/address" \
  -H "Authorization: Bearer {token}" \

200 429

Address suggestions

[
  {
    "addressLine1": "123 Main St",
    "addressLine2": "Apt",
    "city": "Honolulu",
    "entries": 75,
    "postalCode": "96818",
    "stateOrProvince": "HI"
  }
]

Request was refused due to rate limiting.

Retry-After


      number

Query parameters

search


      string

required

Partial or complete address to search.

maxResults


      integer

Maximum number of results to return.

includeCities


      string

Limits results to a list of given cities.

includeStates


      string

Limits results to a list of given states.

includeZipcodes


      string

Limits results to a list of given zipcodes.

excludeStates


      string

Exclude list of states from results. No include pararmeters may be used with this parameter.

preferCities


      string

Display results with the listed cities at the top.

preferStates


      string

Display results with the listed states at the top.

preferZipcodes


      string

Display results with the listed zipcodes at the top.

preferRatio


      integer

Specifies the percentage of address suggestions that should be preferred and will appear at the top of the results.

preferGeolocation


      string

If omitted or set to city it uses the sender’s IP address to determine location, then automatically adds the city and state to the preferCities value. This parameter takes precedence over other include or exclude parameters meaning that if it is not set to none you may see addresses from areas you do not wish to see.

selected


      string

Useful for narrowing results with addressLine2 suggestions such as Apt (denotes an apartment building with multiple residences).

source


      string

Include results from alternate data sources. Allowed values are – all (non-postal addresses) or postal (postal addresses only).

Response

application/json

addressLine1


        string

addressLine2


        string

city


        string

entries


        integer

postalCode


        string

stateOrProvince


        string