/onthemarket/agents/search

POST /api/onthemarket/agents/search

Price: 5 credits

Find OnTheMarket estate and letting agent branches operating in a location. Returns agent cards with the branch slug, name, parent company, address, phone, logo, coordinates and which services and property types the branch currently advertises. Narrow by radius or agent name.

How to use it

Search OnTheMarket (UK) estate and letting agents by location. Provide location_id from onthemarket/locations/search (e.g. bath). Each result has id, alias (feed to onthemarket/agents, onthemarket/agents/properties and onthemarket/agents/local), url, name, company_name, address, phone, image, latitude/longitude, rank, is_sales_agent/is_lettings_agent/is_overseas_agent, has_sale_properties/has_rent_properties/has_overseas_properties and is_enhanced. Narrow with radius (miles) and agent_name.

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", "london"; minLength: 1)
• 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")
• agent_name string nullable — Only return agents whose name matches this text. (examples: "savills")

Response

• @type string (default: "OnthemarketAgentCard")
• id integer nullable
• alias string required
• url string nullable
• name string nullable
• company_name string nullable
• address string nullable
• phone string nullable
• image 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
• has_sale_properties boolean nullable
• has_rent_properties boolean nullable
• has_overseas_properties boolean nullable
• is_enhanced boolean 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.