v1

latestOpenAPI 3.1.02026-07-26320320.3 KB

(*BETA*) MLS Search API (v3)

post/v3/MLSSearch

Request body

countboolean
listing_ids_onlyboolean
ids_onlyboolean
sizeinteger
resultIndexinteger
field_sectionsstring[]

ref: https://developer.realestateapi.com/reference/no-more-bloated-responses (Note: max allowable sections for MLS Search object response schema is 5; past that please use the MLS Detail Bulk API)

publicboolean

By default, no public record data will be returned. If this is set to "true" and your account has an active Starter, Growth, Pro, or Enterprise plan, then you can return the .public object or use the field selector options to return select fields from .public schema

include_photosboolean
excludeobject[]
andobject[]

initiate a compound query

mls_board_codestring

Scope your searches by the MLS Region. MLS Plans are metered by regions of access.

mls_board_namestring
mls_numberstring

Only works when accompanied by "mls_board_code" or "mls_board_name"

citystring

Needs to be paired with "state"

countystring

Needs to be paired with "state"

statestring

Accepts 2 character state codes

zipstring

Accepts 5 digit zip codes

addressstring

ONLY use with "radius"

listing_idstring

ONLY use with "radius"

assessor_idstring

ONLY use with "radius"

apnstring

ONLY use with "radius"

latitudenumber float

ONLY use with "longitude" + "radius"

longitudenumber float

ONLY use with "latitude"+"radius"

radiusnumber float

Accepts values 1 to 100

polygonobject[]

Get a result set of listings inside your polygon shape (array of lat/lng pairs in objects). Can be applied with any other filters

multi_polygonobject[]

Provide an array of polygon shapes to get results that appear in any of the given polgyons

statusstring

Primary status lookup field

listing_date_minstring date
listing_date_maxstring date
days_on_market_mininteger
days_on_market_maxinteger
listing_property_typestring
property_sub_typestring
listing_price_mininteger
listing_price_maxinteger
modification_timestamp_minstring date
modification_timestamp_maxstring date
price_change_timestamp_minstring date
price_change_timestamp_maxstring date
status_change_timestamp_minstring date
status_change_timestamp_maxstring date
average_days_between_price_changes_mininteger
average_days_between_price_changes_maxinteger
bathroomsinteger
bathrooms_mininteger
bathrooms_maxinteger
bedroomsinteger
bedrooms_mininteger
bedrooms_maxinteger
living_area_mininteger
living_area_maxinteger
lot_size_mininteger
lot_size_maxinteger
builder_modelstring
builder_namestring
buyer_financingstring
coolingstring
cooling_typestring
current_financingstring
current_price_per_sqft_mininteger
current_price_per_sqft_maxinteger
delta_from_last_list_price_mininteger
delta_from_last_list_price_maxinteger
delta_from_original_list_price_mininteger
delta_from_original_list_price_maxinteger
development_statusstring
electricstring
exterior_featuresstring
fencingstring
fencing_typestring
fireplaces_mininteger
fireplaces_maxinteger
flooringstring
flooring_typestring
garage_spaces_mininteger
garage_spaces_maxinteger
has_appliancesboolean
has_basementboolean
has_builder_databoolean
has_colisting_databoolean
has_coselling_databoolean
has_exterior_featuresboolean
has_fencingboolean
has_fireplaceboolean
has_garageboolean
has_green_databoolean
has_green_energy_efficientboolean
has_green_energy_generationboolean
has_green_indoor_air_qualityboolean
has_green_water_conservationboolean
has_hoaboolean
has_inclusionsboolean
has_linked_listingsboolean
has_matterportboolean
has_open_housesboolean
has_past_listingsboolean
has_photosboolean
has_poolboolean
has_price_changesboolean
has_schoolsboolean
has_security_featuresboolean
has_seller_databoolean
has_special_listing_conditionsboolean
has_status_changesboolean
has_upcoming_open_housesboolean
has_virtual_tourboolean
heatingstring
heating_typestring
hoa_amenitiesstring
hoa_association_namestring
hoa_association_name2string
hoa_fee_minstring
hoa_fee_maxstring
hoa_fee2_minstring
hoa_fee2_maxstring
hoa_fee_frequencystring
hoa_fee_frequency2string
is_city_viewboolean
is_mountain_viewboolean
is_park_viewboolean
is_water_frontboolean
is_water_viewboolean
last_price_change_delta_mininteger
last_price_change_delta_maxinteger
new_constructionboolean
new_list_price_mininteger
new_list_price_maxinteger
number_of_price_changes_mininteger
number_of_price_changes_maxinteger
number_of_status_changes_mininteger
number_of_status_changes_maxinteger
open_house_date_minstring date
open_house_date_maxstring date
original_listing_price_mininteger
original_listing_price_maxinteger
original_to_current_listing_price_delta_mininteger
original_to_current_listing_price_delta_maxinteger
patio_featuresstring
previous_list_price_mininteger
previous_list_price_maxinteger
previous_statusstring
price_per_sqft_mininteger
price_per_sqft_maxinteger
property_conditionstring
roofstring
roof_typestring
school_districtstring
security_featuresstring
sewerstring
sewer_typestring
soldboolean
sold_date_minstring date
sold_date_maxstring date
sold_price_mininteger
sold_price_maxinteger
storiesinteger
subdivisionstring
water_sourcestring
window_featuresstring
year_builtinteger
zoningstring
listing_agent_emailstring
listing_agent_phonestring
listing_agent_namestring
listing_agent_mls_codestring
listing_office_addressstring
listing_office_mls_codestring
listing_office_emailstring
listing_office_phonestring
listing_price_low_mininteger
listing_price_low_maxinteger
listing_price_high_mininteger
listing_price_high_maxinteger
selling_agent_emailstring
selling_agent_phonestring
selling_agent_mls_codestring
selling_agent_namestring
selling_office_emailstring
selling_office_phonestring
selling_office_namestring
selling_office_mls_codestring
colisting_agent_emailstring
colisting_agent_mls_codestring
colisting_agent_namestring
colisting_agent_phonestring
colisting_office_emailstring
colisting_office_mls_codestring
colisting_office_namestring
colisting_office_phonestring
coselling_agent_emailstring
coselling_agent_mls_codestring
coselling_agent_namestring
coselling_agent_phonestring
coselling_office_emailstring
coselling_office_mls_codestring
coselling_office_namestring
coselling_office_phonestring
standard_status_derivedboolean
closed_date_derivedboolean
is_listedboolean
listing_contract_date_derivedboolean
sold_derivedboolean
sold_price_derivedboolean
stale_check_affectedboolean