/compass/listings

POST /api/compass/listings

Price: 20 credits

Get full Compass listing details by its detail URL: address, price (list/closed/last known), price per sqft, HOA and taxes, beds/baths, square feet, lot size, property type, amenities, description, MLS status, days on market, building info, latitude/longitude, photos, listing agents, open houses, location entities and key details.

How to use it

Fetch a single Compass listing by its URL or path (must contain /homedetails/.../{id}_pid/ or _lid/, e.g. the page_link from the listing search endpoint). Returns one item with id, price, listed_price, closed_price, price_per_sqft, hoa_fee, bedrooms, bathrooms, square_feet, property_type, amenities, full address fields, latitude/longitude, days_on_market, building info, image+images, agents, open_houses, charges, location_entities (id usable in the search endpoint) and key_details.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• listing string required — Compass listing detail URL or path (containing /homedetails/.../{id}_pid/ or _lid/) (examples: "https://www.compass.com/homedetails/148-E-19th-St-Unit-3A-Manhattan-NY-10003/20MMQ1_pid/", "/homedetails/25-Chittenden-Ave-Unit-2B-Manhattan-NY-10033/1348742452508383153_lid/"; minLength: 1)

Response

• @type string (default: "CompassListing")
• id string required
• compass_property_id string nullable
• feed_listing_id string nullable
• listing_type string nullable
• status string nullable
• status_code integer nullable
• mls_status string nullable
• price number nullable
• listed_price number nullable
• closed_price number nullable
• price_per_sqft number nullable
• hoa_fee number nullable
• monthly_charges_with_taxes number nullable
• down_payment_percent number nullable
• description string nullable
• bedrooms number nullable
• full_bathrooms number nullable
• half_bathrooms number nullable
• total_bathrooms number nullable
• square_feet integer nullable
• lot_size integer nullable
• total_rooms number nullable
• legal_room_count integer nullable
• year_built integer nullable
• building_age string nullable
• parking_spaces integer nullable
• property_type string nullable
• amenities array (default: [])
• pretty_address string nullable
• street_number string nullable
• street string nullable
• street_type string nullable
• unit_number string nullable
• neighborhood string nullable
• city string nullable
• state string nullable
• zip string nullable
• county string nullable
• latitude number nullable
• longitude number nullable
• geo_id string nullable
• days_on_market integer nullable
• parcel_number string nullable
• building_name string nullable
• building_id string nullable
• building_floors integer nullable
• building_units integer nullable
• listed_at integer nullable
• contract_at integer nullable
• closed_at integer nullable
• updated_at integer nullable
• is_off_mls boolean nullable
• is_consumer_searchable boolean nullable
• image string nullable
• images array (default: [])
• page_link string nullable
• property_page_link string nullable
• agents array (default: [])
  • @type string (default: "CompassListingAgent")
  • name string nullable
  • company string nullable
  • email string nullable
  • phone string nullable
  • contact_type string nullable
  • license_num string nullable
  • agent_id string nullable
  • profile_url string nullable
  • image string nullable
• charges array (default: [])
  • @type string (default: "CompassCharge")
  • amount number nullable
  • charge_type string nullable
  • charge_type_code integer nullable
• open_houses array (default: [])
  • @type string (default: "CompassOpenHouse")
  • start_at integer nullable
  • end_at integer nullable
  • by_appointment_only boolean nullable
  • is_virtual boolean nullable
• location_entities array (default: [])
  • @type string (default: "CompassLocationEntity")
  • id integer nullable
  • name string nullable
  • seo_id string nullable
  • location_type integer nullable
• key_details array (default: [])
  • @type string (default: "CompassKeyDetail")
  • key string required
  • value 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 — Listing not found (well-formed URL but no listing data for it) 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.