API EndpointsDiscord CommunityRecipes
API Endpoints

Property Search API

post
https://api.realestateapi.com/v2/PropertySearch

Searchable API for list building, search counts, and advanced filtering on properties. You can also use this API to implement your own comparables API, or property analytics API. Questions? Contact our team to ask us for best practices with using this API.This API implements easy paging so your apps can easily manage filtered results in a results pane with paging. When your user clicks on a result, just use the id from this API to get the full property results using the Property Detail API. Questions on best practices for implementing paged property results in your app? Just contact our team.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
boolean

Set to true to only return the count for the total number of records that would be returned for the search and not the records themselves.

ids
array of int32s

Provide a list of property IDs from past or saved Property Searches to pull back all of the enriched fields

ids
boolean
Defaults to false

Returns up to 10,000 property IDs matching your search criteria. When provided, the "size" and "resultIndex" will be ignored.

boolean
Defaults to false

Will remove the address and name fields on the properties returned

boolean
Defaults to false

Returns an aggregation of all lead types in a summary object. The summary object will return totals for each lead type within the context of the given search.

int32

Used with size to accomplish paging. The server will skip the number of records specified by resultIndex, and return the records starting after the resultIndex. The total number of records returned will not be greater than the size specified, or a max of 250 set by the server.

int32
Defaults to 50

Set to the maximum number of records that the server can return for the search. Used in conjunction with resultIndex for paging results.

string

Fully formatted address for a property search. This should include house, street, city, state and zip

string

Used to search for specific house numbers. Must be accompanied with state or zip to limit results.

string

Used to search searching street names only. Must be accompanied with state or zip to limit results.

string

Used to search within a city only. Must be accompanied with state or zip to limit results.

string

Used to search within a state. Must be accompanied by city, house, or street to limit results.

string

Used to search within a county. Must be accompanied by state, or zip.

string

Used to search within a US zip code. An array of zips (of type:string) can also be provided to this field.

float

If latitude & longitude are provided, the search radius will be calculated with that set of coordinates as center

float

If latitude & longitude are provided, the search radius will be calculated with that set of coordinates as center

float

Provide a search radius between 0.1-100 miles for narrowing your search

polygon
array of objects

Provide an array of latitude/longitude pairs for the Geo portion of your query

polygon
multi_polygon
array of objects

Minimum of 1 polygon

multi_polygon
string
enum

Provide the type of residences/properties you are looking for

Allowed:
int32

Also accepts an Array of Integers, where each integer is one of our accepted Property Use Codes. See all codes here: https://developer.realestateapi.com/reference/property-use-codes-reference

boolean

Find active MLS listings

boolean

Find pending MLS sales that are expected to close

boolean

Find terminated MLS listings

boolean

Find sold MLS listings

int32

Find properties that have been on the market for a certain amount of days. Use with "mls_active": true, "mls_pending": true or "mls_cancelled": true

int32
int32

Lower bound used with mls_listing_max to only find properties with MLS listing prices within a defined range

int32

Minimum value of 1

int32

The official MLS listing price for the property

string
enum

mls_operator is to be used with mls_listing_price to indicate a range less than or greater than starting with that listing price. For example, { mls_listing_price: 100000, mls_operator: 'gte' } would retrieve all properties with an MLS listing price of $100,000 or more

Allowed:
string

AutoComplete Field. Can be a string or an integer. Represents the unique property id in the case of full address autocomplete searches.

string

AutoComplete Field. The Property's unique tax assessor identifier, returned as part of the AutoComplete API response.

string

AutoComplete Field.

string

AutoComplete Field.

int32

Autocomplete field.

string

Autocomplete field.

string
enum

AutoComplete Field. A = full address ; C = city ; N = county; S = street ; Z = zip; G = neighborhood; T = state

Allowed:
string

AutoComplete Field.

string

AutoComplete Field.

string

Filter for properties with a specific USPS mailing state

boolean

Used for searching for properties where the owner is not currently a resident. Generally signifies a tenant or non-owner occupied property.

boolean

Indicates if the current mortgage on the property has an adjustable rate.

boolean

Indicates if the mortgage on a given property is assumable.

boolean
boolean

Used to find properties with an auction date. Used with search_range or a default max of 1 year.

boolean

Used to find properties with a basement.

boolean
boolean

Indicates properties with a carport structure.

boolean

Indicates if the property ownership is subsequent to an all cash transaction

boolean

Used to find properties where one of the owners is company.

boolean

Used to find properties where the property owner on the deed is recently deceased. Can be used for probate lists.

boolean

Used to find properties that have a deck

boolean

Used to find properties with a balcony.

boolean

Used to find properties with registered fire sprinkler fixtures.

boolean

Indicates if the property is in a flood zone area. This flag can be used in conjunction with "flood_zone_type" to get more specific result sets.

boolean

Used to find properties in foreclosure. Used with search_range or a default max of 1 year.

boolean

Used to find properties without an open mortgage.

boolean

Used to find properties with a physical structure marked for garage use.

boolean

Indicates properties with high equity (>39%)

boolean

Filter for properties that have an HOA

boolean

Filter for properties only owned by an Individual (not LLC or Trust)

boolean

Set to true to search inherited properties

boolean

Used to find properties with an owner whose mailing address is in the same state as the property address.

boolean

Signals that the property was cash purchased by an absentee owner/investor, rather than individual like with the cash_buyer flag

boolean

Used to find properties where a lawsuit has been filed against a property owner or a party involved in a real estate transaction, and the court rules in favor of one of the parties, and issued a judgment.

boolean

Setting this to "true" will filter out transfers and other non-arms length transaction types. Use in conjunction with last_sale_date_min/max

boolean

Multi-family homes with 2 to 4 units

boolean

Multi-family homes with 5 or more units

boolean

Used to find properties with an owner whose mailing address is in a different state as the property address.

boolean

Used to find properties with a patio

boolean

Used to find properties with a pool

boolean

Used to find poperties that have received any notice of preforeclosure. Used with search_range or a default max of 1 year.

boolean

Helps determine what properties are the result of a Flip. Use with "prior_owner_months_owned_min"/"prior_owner_months_owned_max"

boolean

Returns all properties that are currently financed by a private lender

boolean

Indicates if the property ownership was subsequent to a quit claim

boolean

Used to find properties owned by a bank, trust, services entity, or tax entity. Used with search_range or a default max of 1 year.

boolean

The property is designated as having RV Parking

boolean

The property is owned by a Trust

boolean

Used to find properties that are vacant

string

Values 1000-5000

string

Values 0-10

string

Official tract number from the U.S. Census Bureau

string

Full list of construction types: https://developer.realestateapi.com/reference/construction-types

string

Used to find a specific document type for more granular searches other than the booleans provided. This field can also be assigned an array of document type codes. Used in conjunction with search_range, or a maximum default value of 1 year.

string

B, C, X (for moderate to low risk areas); A, AE, A1-30, AH, AO, AR, A99, V, VE, V1 - V30 (High Risk - Coastal Areas); D (Undetermined Risk Zone)

string

Refer to the Loan Codes that are searchable://developer.realestateapi.com/reference/loan-type-codes

string
string
string
enum

Search by the Recording Date of the .foreclosureInfo data for the specified notice type

Allowed:
string

e.g. 05-00925.01

int32

Accepts an array or single integer code value. See all possible values here: https://developer.realestateapi.com/reference/roof-construction-codes

int32

Accepts an array or single integer code value. See all possible values here: https://developer.realestateapi.com/reference/roof-materials-codes

string
enum

Used in conjunction for reo, auction, foreclosure, and preforeclosure searches to limit the search to only return records where the event happened within the provided range. All ranges work from NOW back to the provided range.

Allowed:
string

Options: Municipal, Yes, Septic, None, Storm

string

Full list of water source types you can filter by: https://developer.realestateapi.com/reference/water-source-searches

int32

Used in conjunction with the equity_percent_operator to find properties where the estimated equity amount is greater than or less than the value provided. Equity dollar amount is computed as the difference of the estimated value less any known open mortgages.

string
enum

Comparison operator for searches using estimated_equity. Returns properties based on a greater than, or less than operation coupled with the value provided for estimated_equity which is based on total dollars of equity estimated from the estimated value and any known open mortgages.

Allowed:
int32

Used in conjunction with the equity_percent_operator to find properties where the equity percentage is greater than or less than the value provided. Equity percentage is a based on the difference of the computed LTV.

string
enum

Comparison operator for searches using equity_percent. Returns properties based on a greater than, or less than operation coupled with the value provided for equity_percent which is based on the difference of the calculated LTV.

Allowed:
date

Find properties based on the date of the last sale history transaction

string
enum

Used in conjunction with "last_sale_date" to find properties that satisfy the range for when they were last sold in a transaction.

Allowed:
int32

Find properties based on the median income of the Areas that contain the properties

string
enum

Used in conjunction with the "median_income" field in order to specify the range lower or higher you want to look at from the given median_income.

Allowed:
int32

Number value of the years owned you are searching for. To be used with years_owned_operator

string
enum

Operator for less than and greater than searches on years_owned field

Allowed:
int32

Value range search against the county assessed improvement value

int32
int32

Value range search against the county assessed land value

int32
int32

Value range search against the county assessed value

int32
date

filter on dates of upcoming foreclosure auctions (e.g. Current Date "2024-05-01" & set a future date range of "2024-05-15" to "2024-05-30"). Use with "auction": true

date
int32

Used for searching a range of properties with bathrooms between a min and max. Minimum numbers of bathrooms for the given property search

int32

Used for searching a range of properties with bathrooms between a min and max. Maximum numbers of bathrooms for the given property search

int32

Used for searching a range of properties with bedrooms between a min and max. Minimum numbers of bedrooms for the given property search

int32

Used for searching a range of properties with bedrooms between a min and max. Maximum numbers of bedrooms for the given property search

int32

Used for searching a range of properties with an interior, living square footage between a min and max. Minimum square footage of the interior living space for the given property search

int32

Used for searching a range of properties with an interior, living square footage between a min and max. Maximum square footage of the interior living space for the given property search

int32

In sq. ft.

string

In sq. ft.

int32

Filter for properties based on the nominal value of equity owners have in their homes. Works well with "value_min"/"value_max".

int32
date

Filter for properties based on a date range for when a specific Foreclosure document was recorded - use with "foreclosure": true & "notice_type"

date
date

Minimum Date for the last sale transaction date

date

Maximum Date for the last sale transaction date

int32

Filter for properties based on a Last Sale Price range.

int32
date
date
date
date
int32
int32
int32

Used for searching a range of properties with lot sizes between a min and max. Minimum square footage of the exterior lot built for the given property search

int32

Used for searching a range of properties with lot sizes between a min and max. Maximum square footage of the exterior lot built for the given property search

int32

Min. of 0

string

Max of 100

int32

Filter for properties that are within a certain range of median income (Zipcode-level)

int32
int32

Used for searching a range of properties with an estimated total of open mortgages between a min and max. Minimum estimated amount for all open mortgages for the given property search.

int32

Used for searching a range of properties with an estimated total of open mortgages between a min and max. Maximum estimated amount for all open mortgages for the given property search.

int32

Used for setting the minimum on the number of total rooms you want your properties to have.

int32

Used for setting the maximum on the number of total rooms you want your properties to have.

int32

In sq. ft.

int32

In sq. ft.

int32

Used to find properties where the minimum ownership interest or the stake that an investor has in the portfolio is as specified. Portfolio equity is the difference between the total value of the portfolio and any outstanding debts or liabilities related to the portfolio.

int32

Used to find properties where the maximum ownership interest or the stake that an investor has in the portfolio is as specified. Portfolio equity is the difference between the total value of the portfolio and any outstanding debts or liabilities related to the portfolio.

int32

Filter for properties based on the remaining open mortgage balance of the Portfolio for Owners with > 1 property

int32
int32
int32
int32
int32
int32

Filter for properties based on the Total Value of the Portfolio for Owners with > 1 property

int32
date

Filter by the Recording Date of Pre-Foreclosure Related Documents. Use with "pre_foreclosure": true

date
int32

Define the time range for what constitutes a "Flip" period between the last 2 transactions

int32
date
date
date
date
int32
int32
int32

The minimum amount of total properties that any property owner's portfolio will have for each property returned.

int32

The maximum amount of total properties that any property owner's portfolio will have for each property returned.

int32

The minimum amount of floors/stories you want properties in your response to have

int32

The maximum amount of floors/stories you want properties in your response to have

int32

2019 - 2022 range yields most results. Matching Min & Max will give a single year range.

int32

2019 - 2022 range yields most results. Matching Min & Max will give a single year range.

int32

The minimum amount of individual units that the property contains

int32

The maximum amount of individual units that the property contains

int32

Used for searching a range of properties with an estimated value between a min and max. Minimum estimated value for the given property search

int32

Used for searching a range of properties with an estimated value between a min and max. Maximum estimated value for the given property search.

int32

Deprecation Notice (replace with year_built_min). Used for searching a range of properties built between a min and max. Minimum year built for the given property search

int32

Deprecation Notice (replace with year_built_min). Used for searching a range of properties built between a min and max. Maximum year built for the given property search

int32

Used for searching a range of properties built between a min and max. Minimum year built for the given property search

int32

Used for searching a range of properties built between a min and max. Minimum year built for the given property search

int32

Number value for lower bound of a range search for years_owned. Used in conjunction with years_owned_max

int32

Number value for lower bound of a range search for years_owned. Used in conjunction with years_owned_min.

date

fetch property IDs of properties that have been updated in a given time range.

date
boolean

Filter for properties with an AC field populated

boolean

Filter for properties with an MLS price reduction

integer

Filter for properties based on the number of open mortgages - find clean titles or properties with multiple loans

integer
integer
integer
integer
integer
string
date
date
date
date
date
date
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
string
string

AVERAGE, FAIR, GOOD, EXCELLENT, POOR, UNSOUND

string
string
string
string
Headers
string
required

User's API key

string

Denote a unique user identifier to this api call by passing it in this header field

Response

Updated 8 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago