/onthemarket/prices

POST /api/onthemarket/prices

Price: 5 credits

Get the full sold-price record for one UK address by record ID (or sold-price detail URL): address, postcode and outcode, photos, the complete price timeline of every recorded sale, and the recorded sales of neighbouring addresses.

How to use it

Fetch one OnTheMarket (UK) sold-price record by its ID or detail URL. Returns a single item with id, url, address, postcode, outcode, labels, images, timeline (every recorded sale with event_type, price, display_price and event_date) and nearby_sales (recorded sales of neighbouring addresses, each with id, address, property_type, bedroom_count, price and sale_date). Get record IDs from onthemarket/prices/search.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• price_record string required — OnTheMarket sold-price record ID, or a sold-price detail URL containing it (examples: "7182f9d0ebe42bcaeeebe79b637a74f6", "https://www.onthemarket.com/uk-house-prices/details/7182f9d0ebe42bcaeeebe79b637a74f6/"; minLength: 1)

Response

• @type string (default: "OnthemarketSoldPrice")
• id string required
• url string nullable
• address string nullable
• postcode string nullable
• outcode string nullable
• labels array (default: [])
• images array (default: [])
• timeline array (default: [])
  • @type string (default: "OnthemarketPriceEvent")
  • event_type string nullable
  • price number nullable
  • display_price string nullable
  • event_date string nullable
• nearby_sales array (default: [])
  • @type string (default: "OnthemarketNeighbourSale")
  • id string required
  • url string nullable
  • address string nullable
  • property_type string nullable
  • bedroom_count integer nullable
  • bathroom_count integer nullable
  • price number nullable
  • display_price string nullable
  • sale_date string nullable
  • image 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 — Sold-price record not found 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.