OnTheMarket property search

Homes for sale and to rent in the UK on OnTheMarket with the site's filters: place (town, region or postcode district), property type, price, bedrooms, radius, keywords, date added, under offer or let agreed, new homes, auction, retirement, shared ownership, student, pets, furnishing, let length, greener choice, accessible and character properties, plus sort. Each result has id, link, title, property type, price and qualifier, bedrooms, bathrooms, address, coordinates, key features, labels (reduced, new), photos and the estate agent (id, name, phone, logo, page). Pass next_page back as page; null on the last page.

Every response includes credits_used: the credits this call cost.

Parameters

Every endpoint also takes fresh, raw, fields (see lean responses and caching).

Example

curl "https://api.api.sh/onthemarket/v1/search?location=london" \
  -H "x-api-key: $APISH_KEY"

import os, requests

res = requests.get(
    "https://api.api.sh/onthemarket/v1/search",
    params={"location": "london"},
    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/search");
url.searchParams.set("location", "london");

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).