/onthemarket/agents/properties

POST /api/onthemarket/agents/properties

Price: 10 credits

List every property an OnTheMarket agent branch currently markets, for sale, to rent or overseas. Returns the same property cards as the search endpoint: id, url, address, price, bedroom/bathroom counts, features, images, coordinates and status labels.

How to use it

List the live listings of one OnTheMarket (UK) agent branch. Provide agent (branch slug such as allen-and-harris-bath, or a branch profile URL) and transaction_type (for-sale, to-rent or overseas). Each result has id (feed to onthemarket/properties), url, address, property_title, property_type, price, bedroom_count, bathroom_count, features, image+images, latitude/longitude, main_label, added_reduced_label and the agent fields. Set include_unavailable to also see properties already under offer or let agreed. Use onthemarket/agents/search to discover branch slugs.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• agent string required — OnTheMarket agent branch slug or a branch profile URL containing it (examples: "allen-and-harris-bath", "https://www.onthemarket.com/agents/branch/savills-bath/"; minLength: 1)
• transaction_type string required — Which of the branch's listing channels to return. (one of: "for-sale", "to-rent", "overseas")
• count integer required — Max number of results to return (min: 1)
• sort string — Result ordering. (default: "recent"; one of: "recommended", "price_high", "price_low", "recent")
• include_unavailable boolean nullable — Include listings that are already under offer or let agreed.

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 — Agent branch 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.