v1

latestOpenAPI 3.1.02026-07-26320320.3 KB

MLS Search API

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

post/v2/MLSSearch

Request body

countboolean

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

sizeinteger

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.

resultIndexinteger

"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_onlyboolean

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_onlyboolean

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_photosboolean

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

latest_onlyboolean

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

idinteger

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

listing_idinteger
mls_numberstring

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

addressstring

"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.)

housestring
unitstring
unit_typestring
streetstring

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

citystring

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

statestring

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.

zipstring

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

countystring
mls_board_codestring

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

latitudenumber float

Required dependency fields: "longitude", "radius"

longitudenumber float

Required dependency fields: "latitude", "radius"

radiusnumber 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.

listing_property_type'RENTAL' | 'MANUFACTURED_IN_PARK' | 'COMMERCIAL_FOR_LEASE' | 'FARM' | 'RESIDENTIAL' | 'RESIDENTIAL_INCOME' | 'BUSINESS_OPPORTUNITY' | 'COMMERCIAL' | 'LAND' | 'RESIDENTIAL_LEASE'
property_sub_typestring
property_typestring

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

activeboolean

Filter for listings with a status of "Active"

cancelledboolean

Filter for listings with a status of "Cancelled"

failedboolean

Filter for listings with a status of "Failed"

pendingboolean

Filter for only pending listings

soldboolean

Please use "sold_date_min"/"sold_date_max" instead

has_photosboolean

Only return listings that have photos

has_poolboolean

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

has_basementboolean

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

is_city_viewboolean

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

is_mountain_viewboolean

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

is_park_viewboolean

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

is_water_viewboolean

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_frontboolean

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

custom_statusstring
statusstring
listing_agent_emailstring

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_codestring
listing_agent_phonestring
selling_agent_emailstring

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_codestring
selling_agent_phonestring
listing_office_emailstring
listing_office_mls_codestring
listing_office_namestring
listing_office_phonestring
selling_office_emailstring
selling_office_mls_codestring
selling_office_namestring
selling_office_phonestring
mls_typestring
bathroomsinteger

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

bathrooms_mininteger

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

bathrooms_maxinteger

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

bedroomsinteger

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

bedrooms_mininteger

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

bedrooms_maxinteger

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

days_on_market_mininteger

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_maxinteger

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_mininteger

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

listing_price_maxinteger

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

living_areainteger

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

living_area_mininteger

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

living_area_maxinteger

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

lot_sizeinteger

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

lot_size_mininteger

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

lot_size_maxinteger

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

price_per_sqft_mininteger
price_per_sqft_maxinteger
sold_priceinteger

Exact value sold price search param.

sold_price_mininteger
sold_price_maxinteger
storiesinteger

Exact value stories count search param.

year_builtinteger

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

year_built_mininteger

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

year_built_maxinteger

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

last_status_change_date_minstring date
last_status_change_date_maxstring date
listing_date_minstring date

YYYY-MM-DD date format

listing_date_maxstring date

YYYY-MM-DD date format

listing_contract_date_minstring date
listing_contract_date_maxstring date
modification_timestamp_minstring date

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

modification_timestamp_maxstring date
price_change_timestamp_minstring date
price_change_timestamp_maxstring date
sold_date_minstring date
sold_date_maxstring date
listing_association_fee_mininteger
listing_association_fee_maxinteger
excludeobject[]

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

public_absentee_typeboolean

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

public_basementboolean
public_basement_type'FINISHED' | 'UNFINISHED' | 'PARTIALLY FINISHED' | 'NO BASEMENT'
public_basement_square_feet_mininteger
public_basement_square_feet_maxinteger
public_basement_sqft_finished_mininteger
public_basement_sqft_finished_maxinteger
public_basement_sqft_unfinished_mininteger
public_basement_sqft_unfinished_maxinteger
public_building_size_mininteger
public_building_size_maxinteger
public_corporate_ownedboolean
public_document_typestring

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

public_document_type_codestring

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_garageboolean
public_investor_buyerboolean
public_land_usestring

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

public_poolboolean
public_private_lenderboolean
public_properties_owned_mininteger
public_properties_owned_maxinteger
public_property_usestring
public_property_use_codeinteger

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_mininteger
public_stories_maxinteger
public_units_mininteger
public_units_maxinteger
public_vacantboolean
public_years_owned_mininteger
public_years_owned_maxinteger

Response

200

listingIdinteger required

Unique identifier for the MLS listing

idstring

Alternative identifier for the listing

modificationTimestampstring

Timestamp of when the listing was last modified