Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Listing V2

Search Listings

Search listings by location keywords and optional filters (price, bedrooms, bathrooms, sqft, property type, listing status, purchase type).

post/v2.0/listings/search

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

searchScope'my' | 'office' | 'all'

Search scope. 'my' = agent's own listings, 'office' = office-level listings, 'all' = all listings the agent has access to. Default 'all'.

soldFlagboolean

Whether to search sold listings. Default false (active listings).

filterConditionsobject

Advanced search filter conditions. Keys must match condition names in the property.condition table. Examples:

  • "location": {"city": ["Seattle"]} (suggestion type)
  • "price": "100000,500000" (inputBox range: "min,max")
  • "beds": "2," (inputBox range: min only)
  • "baths": ",3" (inputBox range: max only)
  • "sqFt": "1000,3000" (inputBox range)
  • "daysOnSite": ",30" (inputBox days: within last N days)
  • "propertyType": ["Condo", "Townhouse"] (multiSelect labels)
  • "purchaseType": ["For Sale"] (singleSelect label)
sortFieldsstring[]

Sort fields. Values from ListingSortEnum, e.g. MLS_LIST_DATE_L_DESC, PRICE_DESC, PRICE_ASC, BEDROOMS_DESC, BATHS_DESC, BUILT_YEAR_DESC, SQFT_DESC, RELEVANCE, QUALITY_DESC, OPEN_HOUSE_DESC.

returnFieldsstring[]

Return fields. If empty, uses default fields for the listing type.

pageNuminteger

Page number, starting from 1. Default 1.

pageSizeinteger

Page size, 1–100. Default 25.

Response

successful operation

Example response

{
  "listing": [
    {
      "listingId": "1179625482",
      "mlsListingId": "ML82040728",
      "listingStreetName": "5164 Montreal DR",
      "listingCity": "San Jose",
      "listingState": "CA",
      "county": "Santa Clara",
      "area": "Campbell",
      "price": "1950000",
      "beds": 3,
      "baths": 2,
      "sqft": 1408,
      "builtYear": 1959,
      "totalAvailableAcres": "6000",
      "listingStatus": "Active",
      "purchaseType": "For Sale",
      "propertyTypePrimary": "Residential",
      "propertyTypeSecondary": "Single Family Home",
      "openHouseSchedules": "Sat Apr 04, 1:00pm - 4:00pm",
      "openHouseSchedulesStart": "2026-04-04 13:00:00",
      "openHouseSchedulesEnd": "2026-04-04 16:00:00",
      "agentId": "5106715",
      "agentName": "Dawn Thorburn",
      "agentOrgId": "6043409",
      "agentOrgName": "Rocky Properties Inc.",
      "hoaFee": -1,
      "condoFee": -1,
      "garageParkingSpaces": 2
    }
  ]
}