/compass/listings/search

POST /api/compass/listings/search

Price: 20 credits

Search Compass listings for sale or rent in a location. Returns listing cards with price, address, beds, baths, sqft, status, latitude/longitude, photos and the page_link for full details. Filter by property type, price, beds, baths, square feet, lot size, year built and HOA.

How to use it

Search Compass homes for sale or rent within a location. location is a numeric Compass location id (resolve text to an id with the locations search endpoint) or a state/geo slug. Each item has id, price, price_label, address, beds, baths, sqft, status, latitude/longitude, image+images and page_link (use it with the listing details endpoint). Use listing_type and sale_statuses to switch between sale/rent and active/coming-soon/sold, property_types to restrict to single family / condo / co-op / townhouse / multi-family / land, and min_lot_size_acres / max_lot_size_acres for lot size.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location string required — Location to search in: a numeric Compass location id (from the locations search endpoint) or a state/geo slug (e.g. 'utah'). ZIP/neighborhood/city ids come from the locations search endpoint. (examples: "21429", "utah"; minLength: 1)
• listing_type integer — Whether to search homes for sale or for rent (default: 2; one of: 2, 1)
• sale_statuses array — Listing statuses to include (active, coming soon, sold) (default: [9]; one of: 9, 12, 7)
• property_types array nullable — Property types to include (single family, condo, co-op, townhouse, multi-family, land) (one of: "single_family", "condo", "co_op", "townhouse", "multi_family", "land", "mobile_manufactured")
• min_price integer nullable — Minimum price (min: 0)
• max_price integer nullable — Maximum price (min: 0)
• min_beds integer nullable — Minimum bedrooms (min: 0)
• max_beds integer nullable — Maximum bedrooms (min: 0)
• min_baths integer nullable — Minimum bathrooms (min: 0)
• min_sqft integer nullable — Minimum square feet (min: 0)
• max_sqft integer nullable — Maximum square feet (min: 0)
• min_year_built integer nullable — Minimum year built (min: 0)
• max_year_built integer nullable — Maximum year built (min: 0)
• max_hoa integer nullable — Maximum monthly HOA / common charges (min: 0)
• min_lot_size_acres number nullable — Minimum lot size in acres (min: 0)
• max_lot_size_acres number nullable — Maximum lot size in acres (min: 0)
• count integer required — Max number of listings to return (min: 1)

Response

• @type string (default: "CompassListingCard")
• id string required
• price number nullable
• price_label string nullable
• address string nullable
• region string nullable
• beds number nullable
• baths number nullable
• sqft integer nullable
• lot_acres number nullable
• status_code integer nullable
• badges array (default: [])
• latitude number nullable
• longitude number nullable
• image string nullable
• images array (default: [])
• page_link string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.