# Property Search and Filtering

**POST /v2/PropertySearch**

Search and filter properties with advanced criteria including geographic, demographic, and financial filters.
Supports pagination and various output formats. Perfect for list building and property analytics.



## 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)
Property Search Request Body
- **count** (boolean)
  Return only the count of matching properties
- **ids** (array[string | integer])
  List of specific property IDs to retrieve
- **ids_only** (boolean)
  Return only property IDs, not full property data
- **obfuscate** (boolean)
  Obfuscate sensitive property information
- **summary** (boolean)
  Return summarized property data
- **resultIndex** (integer)
  Starting index for pagination
- **size** (integer)
  Number of results to return
- **limit** (integer)
  Maximum number of results
- **county** (string)
  County name to search within
- **state** (string)
  State abbreviation
- **city** (string)
  City name
- **address** (string)
  Full address string
- **latitude** (number)
  Latitude for radius search
- **longitude** (number)
  Longitude for radius search
- **radius** (number)
  Search radius in miles
- **polygon** (array[array])
  Polygon coordinates for geographic search
- **beds_min** (integer)
  Minimum number of bedrooms
- **beds_max** (integer)
  Maximum number of bedrooms
- **baths_min** (number)
  Minimum number of bathrooms
- **baths_max** (number)
  Maximum number of bathrooms
- **value_min** (number)
  Minimum property value
- **value_max** (number)
  Maximum property value
- **year_built_min** (integer)
  Minimum year built
- **year_built_max** (integer)
  Maximum year built
- **lot_size_min** (number)
  Minimum lot size in square feet
- **lot_size_max** (number)
  Maximum lot size in square feet
- **building_size_min** (number)
  Minimum building size in square feet
- **building_size_max** (number)
  Maximum building size in square feet
- **property_type** (array[string])
  Property type filters
- **for_sale** (boolean)
  Filter for properties currently for sale
- **owner_occupied** (boolean)
  Filter for owner-occupied properties
- **absentee_owner** (boolean)
  Filter for absentee owner properties
- **corporate_owned** (boolean)
  Filter for corporate-owned properties
- **high_equity** (boolean)
  Filter for high equity properties
- **foreclosure** (boolean)
  Filter for properties in foreclosure
- **pre_foreclosure** (boolean)
  Filter for properties in pre-foreclosure
- **auction** (boolean)
  Filter for properties going to auction
- **cash_buyer** (boolean)
  Filter for cash buyer properties
- **investor_buyer** (boolean)
  Filter for investor buyer properties


## Responses
### 200
Successful response with property search results

#### Body: application/json (object)
- **live** (boolean)
  Indicates if the data is live from the API
- **input** (object)
  Response input parameters for a Property Search request
- **data** (array[object])
  Array of property results
- **resultCount** (integer)
  Total number of results found
- **resultIndex** (integer)
  Index of the last record returned in the current response data
- **recordCount** (integer)
  Number of records returned in the current response data
- **statusCode** (integer)
  HTTP status code of the response
- **statusMessage** (string)
  Status message corresponding to the status code
- **requestExecutionTimeMS** (string)
  Time taken to execute the request in milliseconds

### 400
Bad Request Response

#### Body: application/json (object)
- **statusCode** (integer)

- **error** (string)

- **message** (string)

- **validation** (object)


### 401
Unauthorized Response

#### Body: application/json (object)
- **statusCode** (integer)

- **error** (string)

- **message** (string)


### 404
Not Found Response

#### Body: application/json (object)
- **live** (boolean)

- **input** (object)
  The input query parameters sent in the request.
- **data** (array[object])
  Array of property records matching the query. Empty if no records found.
- **count** (integer)
  Total number of property records matching the query.
- **statusCode** (integer)

- **statusMessage** (string)

- **requestExecutionTimeMS** (string)
  Time taken to execute the request.


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