/onthemarket/properties/similar

POST /api/onthemarket/properties/similar

Price: 10 credits

List the properties OnTheMarket suggests as similar to a given listing: id, url, address, property type, price, bedroom/bathroom counts, cover image, status flags and the marketing agent. Useful for building a comparable set around a property.

How to use it

Get the comparable properties OnTheMarket shows alongside a UK listing. Provide property (numeric ID or listing URL). Each result has id (feed to onthemarket/properties), url, address, property_title, property_type, price plus display_price/price_qualifier, bedroom_count, bathroom_count, image, is_premium/is_spotlight/is_exclusive/is_recently_added and agent_id/agent_name/agent_alias/agent_image. Not every listing has comparables, so an empty list is a normal result.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• property string required — OnTheMarket property ID or a listing URL containing it (examples: "19047224", "https://www.onthemarket.com/details/19047224/"; minLength: 1)
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "OnthemarketSimilarProperty")
• id string required
• url string nullable
• address string nullable
• property_title string nullable
• property_type string nullable
• price number nullable
• display_price string nullable
• price_qualifier string nullable
• bedroom_count integer nullable
• bathroom_count integer nullable
• image string nullable
• is_premium boolean nullable
• is_spotlight boolean nullable
• is_exclusive boolean nullable
• is_recently_added boolean nullable
• agent_id integer nullable
• agent_name string nullable
• agent_alias string nullable
• agent_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 — Property not found or no longer listed 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.