OnTheMarket listing
One OnTheMarket property: title, type, price and qualifier, labels (reduced, chain-free...), added or reduced, views, bedrooms, bathrooms, floor area, address, postcode, coordinates, description, key information (tenure, ground rent, service charge, council tax...), EPC rating, area statistics, mobile reception, photos, floor plans, virtual tours, videos, documents, nearby stations and schools, similar sold properties nearby, and the estate agent (branch id, name, phone, address, logo, page, description). Give id, an onthemarket.com/details/ link as url, or latest=true with the search params to open the first current result.
Every response includes credits_used: the credits this call cost.
Parameters
| name | type | description |
|---|---|---|
id | string | OnTheMarket listing id (id of a search result). |
url | string | An onthemarket.com/details/ link. |
latest | boolean | true: run the search with the other params and open its first current result. Example: true |
location | string | With latest=true: the search place. Example: manchester |
type | for-sale | to-rent | With latest=true: buy or rent. |
Every endpoint also takes fresh, raw, fields (see lean responses and caching).
Example
curl "https://api.api.sh/onthemarket/v1/listing" \
-H "x-api-key: $APISH_KEY" import os, requests
res = requests.get(
"https://api.api.sh/onthemarket/v1/listing",
params={},
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/listing");
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).