/onthemarket/prices/search

POST /api/onthemarket/prices/search

Price: 10 credits

List sold house prices for a full UK postcode, sourced from HM Land Registry and Registers of Scotland. Each address returns its property type, tenure, coordinates, photos and the complete transaction history recorded for it, with the price and date of every sale.

How to use it

Look up sold house prices for a full UK postcode (e.g. KT4 8EB). Each result is one address with id (feed to onthemarket/prices for the full record), url, address, postcode, property_type, tenure, price (most recent sale, numeric GBP) plus display_price/short_price, latitude/longitude, image+images and transactions - the complete list of recorded sales for that address, each with price, display_price and sale_date. This is registry data covering every sale of the address, not just listings that appeared on the site.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• postcode string required — Full UK postcode to look up sold prices for (examples: "KT4 8EB", "BA1 2ED"; minLength: 5)
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "OnthemarketSoldProperty")
• id string required
• url string nullable
• address string nullable
• postcode string nullable
• property_type string nullable
• tenure string nullable
• price number nullable
• display_price string nullable
• short_price string nullable
• latitude number nullable
• longitude number nullable
• image string nullable
• images array (default: [])
• transactions array (default: [])
  • @type string (default: "OnthemarketSoldTransaction")
  • price number nullable
  • display_price string nullable
  • sale_date 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 — Postcode not found or no sold prices recorded 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.