/onthemarket/properties/search

POST /api/onthemarket/properties/search

Price: 5 credits

Search OnTheMarket properties for sale, to rent or new homes within a location. Returns property cards: id, url, address, property title and type, price, bedroom/bathroom counts, listing features, images, coordinates, status labels and the marketing agent. Filter by radius, price range, bedrooms, property types, keywords, how recently the listing was added, tenancy terms and a large set of include/exclude flags.

How to use it

Search OnTheMarket (UK) property listings. Provide location_id from onthemarket/locations/search (e.g. bath) and search_type (for-sale, to-rent or new-homes). Each result has id (feed to onthemarket/properties for full detail), url, address, property_title, property_type, price (numeric GBP) plus display_price/short_price/price_qualifier, bedroom_count, bathroom_count, features, image+images, latitude/longitude, main_label, added_reduced_label, is_spotlight and the marketing agent (agent_id, agent_name, agent_alias, agent_phone, agent_image). Narrow with radius, min_price/max_price, price_frequency, min_bedrooms/max_bedrooms, property_type, keywords, added_since, furnished, let_length and sort. The flag filters (auction, shared_ownership, new_build, retirement, student, shared_accommodation, pet_friendly, accessible_features, greener_choice, recently_reduced, matterport_tour, virtual_tour, video) are tri-state: true returns only matching properties, false excludes them, omitting the field applies no filter. Set include_under_offer or include_let_agreed to also see properties that are already under offer or let agreed.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location_id string required — Location slug from the locations/search endpoint, or a postcode (examples: "bath", "central-bath", "london"; minLength: 1)
• search_type string required — Which listing channel to search. (one of: "for-sale", "to-rent", "new-homes")
• count integer required — Max number of results to return (min: 1)
• radius string nullable — Search radius in miles around the location. (one of: "0", "0.25", "0.5", "1", "2", "3", "4", "5", "7.5", "10", "15", "20", "30", "40")
• min_price integer nullable — Minimum price in GBP. (min: 0)
• max_price integer nullable — Maximum price in GBP. (min: 0)
• price_frequency string nullable — Whether rental prices are per calendar month or per week. (one of: "pcm", "pw")
• min_bedrooms integer nullable — Minimum number of bedrooms (0 means studio). (min: 0)
• max_bedrooms integer nullable — Maximum number of bedrooms. (min: 0)
• property_type array nullable — Restrict results to these property types. (one of: "detached", "semi-detached", "terraced", "bungalow", "flats-apartments", "farms-land", "park-homes")
• keywords string nullable — Free-text keywords a listing must mention. (examples: "garden", "garage")
• added_since string nullable — Only listings added within this window. (one of: "24-hours", "3-days", "7-days")
• sort string — Result ordering. (default: "recommended"; one of: "recommended", "price_high", "price_low", "recent")
• include_under_offer boolean nullable — Include properties that are already under offer or sold subject to contract.
• include_let_agreed boolean nullable — Include rental properties that are already let agreed.
• furnished string nullable — Furnishing state of a rental property. (one of: "furnished", "part-furnished", "unfurnished")
• let_length string nullable — Tenancy length of a rental property. (one of: "long-term", "short-term")
• auction boolean nullable — True returns only auction properties, false excludes them.
• shared_ownership boolean nullable — True returns only shared-ownership properties, false excludes them.
• new_build boolean nullable — True returns only new-build homes, false excludes them.
• retirement boolean nullable — True returns only retirement properties, false excludes them.
• student boolean nullable — True returns only student accommodation, false excludes it.
• shared_accommodation boolean nullable — True returns only shared accommodation, false excludes it.
• pet_friendly boolean nullable — True returns only pet-friendly properties, false excludes them.
• accessible_features boolean nullable — True returns only properties with accessible features, false excludes them.
• greener_choice boolean nullable — True returns only energy-efficient properties, false excludes them.
• recently_reduced boolean nullable — True returns only recently reduced properties, false excludes them.
• matterport_tour boolean nullable — True returns only properties with a Matterport 3D tour.
• virtual_tour boolean nullable — True returns only properties with a virtual tour.
• video boolean nullable — True returns only properties with a video tour.

Response

• @type string (default: "OnthemarketPropertyCard")
• id string required
• url string nullable
• address string nullable
• property_title string nullable
• property_type string nullable
• price number nullable
• display_price string nullable
• short_price string nullable
• price_qualifier string nullable
• bedroom_count integer nullable
• bathroom_count integer nullable
• features array (default: [])
• image string nullable
• images array (default: [])
• latitude number nullable
• longitude number nullable
• main_label string nullable
• added_reduced_label string nullable
• is_spotlight boolean nullable
• agent_id integer nullable
• agent_name string nullable
• agent_alias string nullable
• agent_phone 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 — Location 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.