/onthemarket/overseas/search

POST /api/onthemarket/overseas/search

Price: 10 credits

Search overseas property listings advertised on OnTheMarket by UK agents. Returns listings with id, url, address, title, price in GBP alongside the original local currency price, bedroom count, description, cover image and the marketing agent. Filter by price range, bedrooms and how recently the listing was added.

How to use it

Search overseas properties advertised on OnTheMarket. Provide country (use global for worldwide) and optionally region to narrow to an area within it. Each result has id (feed to onthemarket/properties), url, address, property_title, price (converted to GBP) plus display_price, local_price (the original currency amount) and price_qualifier, bedroom_count, description, image and agent_id/agent_name/agent_image. Narrow with min_price/max_price (GBP), min_bedrooms/max_bedrooms, added_since and sort.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• country string required — Country or area to search listings in. (one of: "global", "anguilla", "antigua-and-barbuda", "australia", "austria", "barbados", "belgium", "cambodia", "canada", "cayman-islands", "costa-rica", "croatia", "cyprus", "dominican-republic", "ecuador", "fiji", "france", "germany", "gibraltar", "greece", "grenada", "hong-kong", "iceland", "india", "indonesia", "ireland", "italy", "jamaica", "kenya", "malaysia", "maldives", "malta", "mauritius", "mexico", "monaco", "montenegro", "morocco", "norway", "portugal", "puerto-rico", "romania", "saint-lucia", "saint-vincent-and-the-grenadines", "south-africa", "spain", "sri-lanka", "sweden", "switzerland", "taiwan", "thailand", "turkey", "turks-and-caicos-islands", "united-arab-emirates", "united-states-of-america")
• region string nullable — Narrow to a region within the country, using the region slug shown on the country page. (examples: "andalusia", "catalonia", "provence-alpes-cote-dazur")
• count integer required — Max number of results to return (min: 1)
• min_price integer nullable — Minimum price in GBP. (min: 0)
• max_price integer nullable — Maximum price in GBP. (min: 0)
• min_bedrooms integer nullable — Minimum number of bedrooms. (min: 0)
• max_bedrooms integer nullable — Maximum number of bedrooms. (min: 0)
• added_since string nullable — Only listings added within this window. (one of: "24-hours", "3-days", "7-days")
• sort string — Result ordering. (default: "price_high"; one of: "recommended", "price_high", "price_low", "recent")

Response

• @type string (default: "OnthemarketOverseasProperty")
• id string required
• url string nullable
• address string nullable
• property_title string nullable
• price number nullable
• display_price string nullable
• local_price string nullable
• price_qualifier string nullable
• bedroom_count integer nullable
• description string nullable
• image string nullable
• agent_id integer nullable
• agent_name 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 — No listings found for the country or region 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.