Autocomplete Addresses

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.

A ZIP code is returned with an address when the provider supplies one, but ZIP is not used to select the normalized city or county. City matching uses city and state, then falls back to county and state.

GET /v1/locations/autocomplete remains available as a deprecated compatibility alias. New integrations should use this addresses Endpoint.

Query Parameters

query qstringrequired

At least two characters of a street address, city, county, state, or ZIP code. Maximum 200 characters.

query scopestringdefault: all

Choose all, address, or location. Use address for a street-address input and location for a city, county, state, or ZIP picker.

query statestring

Optional two-letter state abbreviation used to prefer and normalize results in one state.

query limitintegerdefault: 5

Maximum suggestions to return. Minimum 1 and maximum 10.

query latitudenumber

Optional latitude for nearby address ranking. longitude is required when this parameter is supplied.

query longitudenumber

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. Keep limit=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.

Request example

12curl "https://api.v2.dealmachine.com/v1/addresses/autocomplete?q=1200%20Barton%20Springs&state=TX&limit=5" \
  -H "Authorization: Bearer dm_sk_live_xxx"

Response example

1234567891011121314151617181920212223242526272829303132333435{
  "data": [
    {
      "suggestion_id": "addr_address_123",
      "kind": "address",
      "label": "1200 Barton Springs Rd, Austin, Texas 78704, United States",
      "address": {
        "address": "1200 Barton Springs Rd",
        "city": "Austin",
        "county": "Travis County",
        "state": "TX",
        "zip": "78704",
        "full_address": "1200 Barton Springs Rd, Austin, Texas 78704, United States",
        "latitude": 30.2638,
        "longitude": -97.7714
      },
      "location": {
        "location_id": "loc_city_7333",
        "type": "city",
        "code": "7333",
        "name": "Austin",
        "property_count": 460000,
        "state": "TX",
        "state_name": "Texas"
      }
    }
  ],
  "meta": {
    "query": "1200 Barton Springs",
    "scope": "all",
    "limit": 5,
    "returned": 1,
    "partial_results": false
  }
}