/compass/listings/history

POST /api/compass/listings/history

Price: 20 credits

Get the price and status history of a Compass listing by its detail URL. Returns chronological events (listed, price changed, sold, etc.) with status, price, event date and data source.

How to use it

Fetch the price/status history timeline for a Compass listing by URL/path (must contain /homedetails/.../{id}_pid/ or _lid/). Each item has status, status_code, price, event_at (unix seconds), source_name, source_url and feed_listing_id.

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/"; minLength: 1)

Response

• @type string (default: "CompassListingHistoryEvent")
• status string nullable
• status_code integer nullable
• price number nullable
• event_at integer nullable
• source_name string nullable
• source_url string nullable
• feed_listing_id 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.