# Address and Location AutoComplete

**POST /v2/AutoComplete**

Search for addresses, cities, neighborhoods, and other location types with autocomplete functionality.
Supports various search types including addresses, streets, cities, neighborhoods, counties, APNs, states, and ZIP codes.



## Servers
- Production server: https://api.realestateapi.com (Production server)


## Authentication methods
- Api key


## Parameters
### Headers
- **x-api-key** (string)
  API key for authentication
- **x-user-id** (string)
  Optional user identifier for tracking and analytics



### Body: application/json (object)
AutoComplete search request
- **search** (string)
  The search query string (minimum 2 characters)
- **search_types** (string | array[string])
  Search type codes:
  - A: Address
  - S: Street
  - C: City
  - G: Neighborhood
  - N: County
  - P: APN (Assessor's Parcel Number)
  - T: State
  - Z: ZIP Code
- **latitude** (number)
  Latitude to bias the search results
- **longitude** (number)
  Longitude to bias the search results
- **precision** (integer)
  Number of precision digits for coordinates


## Responses
### 200
Successful response with autocomplete suggestions

#### Body: application/json (object)
- **input** (object)
  Echo of the input parameters
- **data** (array[object])
  Array of autocomplete suggestions
- **totalResults** (integer)
  Total number of suggestions found
- **returnedResults** (integer)
  Number of suggestions returned
- **statusCode** (integer)
  HTTP status code
- **live** (boolean)
  Indicates if data is live

### 400
Bad Request - Invalid input parameters

#### Body: application/json (object)
- **error** (string)

- **message** (string)

- **statusCode** (integer)

- **details** (object)
  Additional error details

### 401
Unauthorized - Invalid or missing API key

#### Body: application/json (object)
- **error** (string)

- **message** (string)

- **statusCode** (integer)


### 500
Internal Server Error

#### Body: application/json (object)
- **error** (string)

- **message** (string)

- **statusCode** (integer)



[Powered by Bump.sh](https://bump.sh)