MLS Search API

post

https://api.realestateapi.com/v2/MLSSearch

Find a list of property listings on-the-market that fit your specific criteria.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

count

boolean

Enable "count" mode to only receive the number of results ("resultCount") matching your input payload, not the actual listing records. Default: false

size

int32

Specify the number of results you'd like returned in your MLS Search API Call. Values of 1-250 accepted for record pulling mode (default). Values of 1-10,000 accepted for "ids_only": true mode.

resultIndex

int32

"resultIndex" is your pagination parameter for MLS Search API. Each API call will a resultIndex value in the response you can use to fetch subsequent pages by adding it and its value in the input of the next request with the same query as before.

listing_ids_only

boolean

return a list of all the listing IDs, with which you can hit MLS Detail (or MLS Detail Bulk) with to get additional info (max of 10,000 listing IDs per request)

ids_only

boolean

Receive an array of RealEstateAPI unique "ID"s to assist with calling Property Detail or Property Detail Bulk API as your Step 2 to get public record data for your listing. Max size with ids_only mode is 10,000

include_photos

boolean

return full list of photos for each MLS Search response object, without having to call MLS Detail for each

latest_only

boolean

use along with "active": true to eliminate closed listings still showing as active issue

sort

object

for info on what is sortable: https://developer.realestateapi.com/reference/step-3-set-modes-search-settings#sort

int32

"id" + "radius" will allow you to do a search radius search around a given property through it's RealEstateAPI ID

listing_id

int32

mls_number

string

Find a single listing by it's official MLS Number. Check here for a code sample: https://developer.realestateapi.com/reference/mls-number-search

address

string

"address" can be used instead of "latitude"/"longitude" for search radius searches. Another use is to find any listing record matching for a specific address across different statuses (a previously sold, current active, etc.)

house

string

unit

string

unit_type

string

street

string

Filter for listings on a specific street - works best when combined with "city", "zip", "state", "county"

city

string

Filter for listings in a specific city - required dependency is "state" field

state

string

Accepts the 2 Character State Code, ALL CAPS. Filter for listings in a specific state - or combine with "county", "city" or "street" to narrow your search.

zip

string

Filter for listings in a specific zip code or an array of zip codes

county

string

mls_board_code

string

Accepts a single "string" value or array of "string" values. MLS Board Codes for searching by specific boards can be provided by our team.

latitude

float

Required dependency fields: "longitude", "radius"

longitude

float

Required dependency fields: "latitude", "radius"

radius

float

Use along with "latitude"/"longitude" to perform a search radius search around a specific location point with your other MLS Search filters applied. Values between 1-100 miles are accepted.

polygon

array of objects

Accepts an array of objects where each object consists of "lat"/"lon" fields.

polygon

multi_polygon

array

multi_polygon

listing_property_type

string

enum

Check possible values here: https://developer.realestateapi.com/reference/listing-property-type

property_sub_type

string

Check possible values: https://developer.realestateapi.com/reference/property-sub-types

property_type

string

SFR, MFR, LAND, CONDO, MOBILE, OTHER (from Public Record property types)

active

boolean

Filter for listings with a status of "Active"

cancelled

boolean

Filter for listings with a status of "Cancelled"

failed

boolean

Filter for listings with a status of "Failed"

pending

boolean

Filter for only pending listings

sold

boolean

Please use "sold_date_min"/"sold_date_max" instead

has_photos

boolean

Only return listings that have photos

has_pool

boolean

A true/false flag that indicates whether the listed property has a pool

has_basement

boolean

A true/false flag that indicates whether the listed property has a basement structure

is_city_view

boolean

A true/false flag that indicates whether the listed property has a view of a city landscape

is_mountain_view

boolean

A true/false flag that indicates whether the listed property has a view of a mountain

is_park_view

boolean

A true/false flag that indicates whether the listed property has a view of a public park

is_water_view

boolean

A true/false flag that indicates whether the listed property has a view of a pond, lake, river, or other body of water

is_water_front

boolean

A true/false flag that indicates whether the listed property has direct access to a body of water

custom_status

string

status

string

Filter by the statuses of your choice: https://developer.realestateapi.com/reference/current-status-searches

listing_agent_email

string

See examples of how to call for listings by listing agent email: https://developer.realestateapi.com/reference/search-for-agent-listings-by-email

listing_agent_mls_code

string

listing_agent_phone

string

selling_agent_email

string

See examples of how to call for listings by selling agent email: https://developer.realestateapi.com/reference/search-for-agent-listings-by-email

selling_agent_mls_code

string

selling_agent_phone

string

listing_office_email

string

listing_office_mls_code

string

listing_office_name

string

listing_office_phone

string

selling_office_email

string

selling_office_mls_code

string

selling_office_name

string

selling_office_phone

string

mls_type

string

bathrooms

int32

Exact value bathroom count search param. Do NOT use along with "bathrooms_min"/"bathrooms_max"

bathrooms_min

int32

Use along with "bathrooms_max" to search for listings with a range of bathrooms falling between your min & max

bathrooms_max

int32

Use along with "bathrooms_min" to search for listings with a range of bathrooms falling between your min & max

bedrooms

int32

Exact value bedroom count search param. Do NOT use along with "bedrooms_min"/"bedrooms_max"

bedrooms_min

int32

Use along with "bedrooms_max" to search for listings with a range of bedrooms falling between your min & max

bedrooms_max

int32

Use along with "bedrooms_min" to search for listings with a range of bathrooms falling between your min & max

days_on_market_min

int32

Use along with "days_on_market_max" to search for listings with that have been on-market for the number of days falling between your min & max

days_on_market_max

int32

Use along with "days_on_market_min" to search for listings with that have been on-market for the number of days falling between your min & max

listing_price_min

int32

Use along with "listing_price_max" to search for listings with a current listing price range between your min & max

listing_price_max

int32

Use along with "listing_price_min" to search for listings with a current listing price range between your min & max

living_area

int32

Exact value living square feet search param. Do NOT use along with "living_area_min"/"living_area_max"

living_area_min

int32

Use along with "living_area_max" to search for listings with a living square footage between your min & max

living_area_max

int32

Use along with "living_area_min" to search for listings with a living square footage between your min & max

lot_size

int32

Exact value lot square feet search param. Do NOT use along with "lot_size_min"/"lot_size_max"

lot_size_min

int32

Use along with "lot_size_max" to search for listings with a lot square footage between your min & max

lot_size_max

int32

Use along with "lot_size_min" to search for listings with a lot square footage between your min & max

price_per_sqft_min

int32

price_per_sqft_max

int32

sold_price

int32

Exact value sold price search param.

sold_price_min

integer

sold_price_max

integer

stories

int32

Exact value stories count search param.

year_built

int32

Exact value year built search param. Useful for getting new construction - year_built: . Do NOT use along with "year_built_min"/"year_built_max"

year_built_min

int32

Use along with "year_built_max" to search for listings with built in the years between your min & max

year_built_max

int32

Use along with "year_built_min" to search for listings with built in the years between your min & max

last_status_change_date_min

date

Check examples here: https://developer.realestateapi.com/reference/listing-status-change-date-searches

last_status_change_date_max

date

listing_date_min

date

YYYY-MM-DD date format

listing_date_max

date

YYYY-MM-DD date format

listing_contract_date_min

date

listing_contract_date_max

date

modification_timestamp_min

date

Filter for any listing changes with the modification timestamp search: https://developer.realestateapi.com/reference/listing-detail-update-searches

modification_timestamp_max

date

price_change_timestamp_min

date

Check examples here: https://developer.realestateapi.com/reference/listing-price-change-date-searches

price_change_timestamp_max

date

sold_date_min

date

Check code sample here: https://developer.realestateapi.com/reference/sold-date-searches

sold_date_max

date

listing_association_fee_min

integer

listing_association_fee_max

integer

exclude

array

currently only works with "listing_property_type" field, e.g. { exclude: [ {listing_property_type: "RENTAL" } ] }

exclude

public_absentee_type

boolean

Filters against the public record data field: "absentee_owner" (bool)

public_basement

boolean

public_basement_type

string

enum

Allowed:

public_basement_square_feet_min

integer

public_basement_square_feet_max

integer

public_basement_sqft_finished_min

integer

public_basement_sqft_finished_max

integer

public_basement_sqft_unfinished_min

integer

public_basement_sqft_unfinished_max

integer

public_building_size_min

integer

public_building_size_max

integer

public_corporate_owned

boolean

public_document_type

string

Filters against the County Tax Recorder data field that indicates the deed type of the current owner's mortgage.

public_document_type_code

string

Filters against the public record deed type code corresponding with the corresponding mortgage document type descriptor: https://developer.realestateapi.com/reference/document-type-codes

public_garage

boolean

public_investor_buyer

boolean

public_land_use

string

Filters against the County Assessor's classification for the listing parcel's land use. Common values include "Residential" and "Commercial"

public_pool

boolean

public_private_lender

boolean

public_properties_owned_min

integer

public_properties_owned_max

integer

public_property_use

string

public_property_use_code

int32

Accepts an integer or array of integers of the valid County Assessor classifications for property use that can be found here: https://developer.realestateapi.com/reference/property-use-codes-reference

public_stories_min

integer

public_stories_max

integer

public_units_min

integer

public_units_max

integer

public_vacant

boolean

public_years_owned_min

integer

public_years_owned_max

integer

Responses

200200

400400