OnTheMarket estate agent
GET https://api.api.sh/onthemarket/v1/agent
An estate agent branch on OnTheMarket: branch id, name, phone, address, postcode, coordinates, logo, description, sales and lettings, affiliations (ARLA, NAEA...), social links, opening hours, testimonials, team size, and its listings for sale or to rent with paging.
Every response includes credits_used: the credits this call cost.
Parameters
| name | type | description |
|---|---|---|
urlrequired | string | The branch's onthemarket.com/agents/branch/ link or its name part (agent.url of a listing). Example: ellis-and-co-bounds-green |
type | for-sale | to-rent | Listings for sale or to rent. Example: for-sale |
page | integer | Result page (1 = first). Example: 1 |
Every endpoint also takes fresh, raw, fields (see lean responses and caching).
Example
curl "https://api.api.sh/onthemarket/v1/agent?url=ellis-and-co-bounds-green" \
-H "x-api-key: $APISH_KEY" import os, requests
res = requests.get(
"https://api.api.sh/onthemarket/v1/agent",
params={"url": "ellis-and-co-bounds-green"},
headers={"x-api-key": os.environ["APISH_KEY"]},
timeout=120,
)
res.raise_for_status()
data = res.json() const url = new URL("https://api.api.sh/onthemarket/v1/agent");
url.searchParams.set("url", "ellis-and-co-bounds-green");
const res = await fetch(url, { headers: { "x-api-key": process.env.APISH_KEY } });
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json(); Response
A JSON object with the fields described above, plus raw (the source's own data), cached, fetched_at and credits_used. Errors return {"success": false, "error": "…"} with the HTTP status (see errors). A lookup that ran but found nothing (404) costs the price above; refused calls and errors on our side are free (what's charged).
The fastest way to see the full response is the playground: it runs this endpoint with your account and shows the exact JSON.