Decide what type of MLS Search you want to perform by configuring one or multiple of these modes
"count" Mode
- returns a count for the number of search results that match your query
- will not pull back the full response objects
"listing_ids_only" Mode
- returns an array of the unique listingId's from all the search results from MLS Search
"ids_only" Mode
- To be used when wanting to pull the Property Detail API record for each listing
- not all listings in the MLS Search/Detail APIs will have an "id"
Exclude
- currently only works with the "listing_property_type" input field
Sort
Use the "sort" field on one of the accepted sort params and get your results back just how you want them without the post-processing
| Field Name for "sort" Input Parm | Field That Sort Gets Applied To |
|---|---|
| bathrooms | listing.property.bathroomsTotal |
| bedrooms | listing.property.bedroomsTotal |
| contract_date | listing.listingContractDate |
| listing_association_fee | listing.property.associationFee |
| listing_date | listing.leadTypes.mlsListingDate |
| listing_price | listing.leadTypes.mlsListingPrice |
| living_area | listing.property.livingArea |
| lot_size | listing.property.lotSizeSquareFeet |
| modification_timestamp | modificationTimestamp |
| price_change | listing.priceChangeTimestamp |
| sold_date | listing.soldDate |
| sold_price | listing.leadTypes.mlsSoldPrice |
| year_built | listing.property.yearBuilt |
Note: these sorts will override the default geo-distance (closest first) order when using "latitude"/"longitude" or "address" and "radius" together.
{
"city": "Richmond",
"state": "VA",
"active": true,
"sort": {
"listing_price": "asc"
}
}
{
"city": "Richmond",
"state": "VA",
"active": true,
"sort": {
"modification_timestamp": "desc"
}
}