/onthemarket/agents

POST /api/onthemarket/agents

Price: 10 credits

Get an OnTheMarket estate agent branch profile by slug (or branch profile URL): branch name, address, postcode, phone, description, website, logo and banner images, coordinates, which services the branch offers and how many sale and rental properties it is currently showcasing.

How to use it

Fetch a single OnTheMarket (UK) estate agent branch by slug (e.g. allen-and-harris-bath) or branch profile URL. Returns one item with id, alias, url, name, address, postcode, phone, description, website_url, image, cover, latitude/longitude, rank, is_sales_agent/is_lettings_agent/is_overseas_agent, is_virtual, is_enhanced and sale_property_count/rent_property_count. Get the alias from onthemarket/agents/search or from the agent_alias field on property cards. Use the alias with onthemarket/agents/properties to list every listing the branch markets, and with onthemarket/agents/local for nearby amenities.

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)

Response

• @type string (default: "OnthemarketAgent")
• id integer nullable
• alias string required
• url string nullable
• name string nullable
• address string nullable
• postcode string nullable
• phone string nullable
• description string nullable
• website_url string nullable
• image string nullable
• cover string nullable
• latitude number nullable
• longitude number nullable
• rank integer nullable
• is_sales_agent boolean nullable
• is_lettings_agent boolean nullable
• is_overseas_agent boolean nullable
• is_virtual boolean nullable
• is_enhanced boolean nullable
• sale_property_count integer nullable
• rent_property_count integer 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.