Real Estate

OnTheMarket API

The OnTheMarket API returns UK real-estate listings as clean JSON.

3 actionsLive JSON1,000 free creditsMCP-ready

🤖 Using an AI assistant? Copy this link into ChatGPT / Claude / Cursor — it reads every endpoint and parameter instantly and tells you if this API fits your use case.

You first call location_search to resolve a location id, then search returns matching properties and property_detail returns the full listing. It is built for UK proptech and property portals that need OnTheMarket data without a scraper. One ReefAPI key, one shared credit pool, the standard envelope.

Live example

Real request and response JSON

Captured from the indexed primary action, search, on Jul 18, 2026, 5:19 PM UTC.

Captured request

{
  "method": "POST",
  "url": "https://api.reefapi.com/onthemarket/v1/search",
  "headers": {
    "x-api-key": "$REEF_KEY",
    "content-type": "application/json"
  },
  "body": {
    "location": "London"
  }
}

Captured response

{
  "ok": true,
  "meta": {
    "api": "onthemarket",
    "endpoint": "search",
    "mode": "live",
    "latency_ms": 1066.9,
    "record_count": 30,
    "bytes": 603777,
    "cache_hit": false,
    "completeness_pct": 100,
    "stop_reason": "max_pages",
    "method": "ssr_next_data",
    "channel": "for-sale",
    "total_results": 50000,
    "filters_applied": {
      "location-type": "country",
      "location-name": "London",
      "page": 1,
      "exclusive-first": true,
      "under-offer": false,
      "location-id": "london",
      "search-type": "for-sale",
      "frame-size": 30,
      "direction": "desc",
      "view": "list",
      "sort-field": "recommended"
    }
  },
  "data": {
    "items": [
      {
        "property_id": "19308035",
        "title": "2 bedroom detached house for sale",
        "property_type": "Detached house",
        "price_display": "£220,000",
        "price_short": "£220k",
        "price_qualifier": null,
        "bedrooms": 2,
        "address": "Stonehill Woods Park, Old London Road, Sidcup, Kent, DA14",
        "added": "Added > 14 days",
        "features": [
          "Chain Free",
          "Two Bedrooms with En-suite",
          "Large Garden facing Wood Area"
        ],
        "latitude": 51.416557,
        "longitude": 0.15529,
        "spotlight": true,
        "has_virtual_tour": true,
        "cover_image": "https://media.onthemarket.com/properties/19308035/[redacted-phone]/image-0-480x320.jpg",
        "images": [
          "https://media.onthemarket.com/properties/19308035/[redacted-phone]/image-0-480x320.jpg",
          "https://media.onthemarket.com/properties/19308035/[redacted-phone]/image-1-480x320.jpg",
          "https://media.onthemarket.com/properties/19308035/[redacted-phone]/image-2-480x320.jpg"
        ],
        "details_url": "https://www.onthemarket.com/details/19308035/",
        "agent": {
          "id": 74007,
          "name": "[redacted-name]",
          "logo_url": "https://media.onthemarket.com/agents/companies/14676/[redacted-phone]/logo-190x100.jpg",
          "details_url": "https://www.onthemarket.com/agents/branch/mann-swanley/",
          "telephone": "[redacted-phone]"
        }
      },
      {
        "property_id": "18763369",
        "title": "3 bedroom apartment for sale",
        "property_type": "Apartment",
        "price_display": "£1,350,000",
        "price_short": "£1.35m",
        "price_qualifier": null,
        "bedrooms": 3,
        "address": "Oval Village, Oval, Kennington Lane, London SE11",
        "added": "Reduced today",
        "features": [
          "Tenure: Leasehold (999 years remaining)",
          "Fifteenth floor",
          "New build"
        ],
        "latitude": 51.486204,
        "longitude": -0.119321,
        "spotlight": null,
        "has_virtual_tour": true,
        "cover_image": "https://media.onthemarket.com/properties/18763369/[redacted-phone]/image-0-480x320.jpg",
        "images": [
          "https://media.onthemarket.com/properties/18763369/[redacted-phone]/image-0-480x320.jpg",
          "https://media.onthemarket.com/properties/18763369/[redacted-phone]/image-1-480x320.jpg",
          "https://media.onthemarket.com/properties/18763369/[redacted-phone]/image-2-480x320.jpg"
        ],
        "details_url": "https://www.onthemarket.com/details/18763369/",
        "agent": {
          "id": 72371,
          "name": "[redacted-name]",
          "logo_url": "https://media.onthemarket.com/agents/branches/72371/[redacted-phone]/logo-190x100.png",
          "details_url": "https://www.onthemarket.com/agents/branch/londra-estate-london/",
          "telephone": "[redacted-phone]"
        }
      },
      {
        "property_id": "19566766",
        "title": "4 bedroom terraced house for sale",
        "property_type": "Terraced house",
        "price_display": "£500,000",
        "price_short": "£500k",
        "price_qualifier": "Offers in excess of",
        "bedrooms": 4,
        "address": "Berkeley Road, Manor Park, London, E12",
        "added": "Reduced today",
        "features": [
          "Tenure: Freehold",
          "Chain free",
          "Quiet residential turning in Manor Park"
        ],
        "latitude": 51.547114,
        "longitude": 0.05001,
        "spotlight": null,
        "has_virtual_tour": true,
        "cover_image": "https://media.onthemarket.com/properties/19566766/[redacted-phone]/image-0-480x320.jpg",
        "images": [
          "https://media.onthemarket.com/properties/19566766/[redacted-phone]/image-0-480x320.jpg",
          "https://media.onthemarket.com/properties/19566766/[redacted-phone]/image-1-480x320.jpg",
          "https://media.onthemarket.com/properties/19566766/[redacted-phone]/image-2-480x320.jpg"
        ],
        "details_url": "https://www.onthemarket.com/details/19566766/",
        "agent": {
          "id": 73370,
          "name": "[redacted-name]",
          "logo_url": "https://media.onthemarket.com/agents/companies/14646/[redacted-phone]/logo-190x100.jpg",
          "details_url": "https://www.onthemarket.com/agents/branch/bairstow-eves-east-ham/",
          "telephone": "[redacted-phone]"
        }
      }
    ],
    "count": 30,
    "channel": "for-sale",
    "total_results": 50000,
    "filters_applied": {
      "location-type": "country",
      "location-name": "London",
      "page": 1,
      "exclusive-first": true,
      "under-offer": false,
      "location-id": "london",
      "search-type": "for-sale",
      "frame-size": 30,
      "direction": "desc",
      "view": "list",
      "sort-field": "recommended"
    },
    "pages_fetched": 1,
    "stop_reason": "max_pages"
  }
}

Actions

What the OnTheMarket API does

Action	Description	Concrete use case	Key params
location_search	Resolve a text location (town, postcode, borough, area) to OnTheMarket location slug(s). Returns multiple ranked matches; use a result's location_id in search.	Real-estate investors call location_search to resolve a text location (town, postcode, borough, area) to OnTheMarket location slug(s).	query, channel, limit
search	Search UK property listings by location (for sale / to rent) with structured filters: price, beds, property type, radius, keywords, added-within and sort. Paginate with page/max_pages (30 per page).	Brokerage tools call search to search UK property listings by location (for sale / to rent) with structured filters.	location, location_id, channel, for_rent, price_min, ...
property_detail	Full property record: price (+qualifier), beds/baths, description, key features, key-info (tenure, council-tax band), images, floorplans, virtual/video tours, documents, nearby stations & schools, area stats (avg price, crime level), breadcrumbs and the listing agent.	Property dashboards call property_detail to get full property record.	property_id, url

Code samples

Call search from your stack

curl -X POST https://api.reefapi.com/onthemarket/v1/search \
  -H "x-api-key: $REEF_KEY" \
  -H "content-type: application/json" \
  -d '{"location":"London"}'

import requests

r = requests.post(
    "https://api.reefapi.com/onthemarket/v1/search",
    headers={"x-api-key": REEF_KEY},
    json={
  "location": "London"
},
)
print(r.json()["data"])

const res = await fetch("https://api.reefapi.com/onthemarket/v1/search", {
  method: "POST",
  headers: {
    "x-api-key": process.env.REEF_KEY,
    "content-type": "application/json",
  },
  body: JSON.stringify({
  "location": "London"
}),
});
const { ok, data, meta, error } = await res.json();

MCP one-liner

Ask your MCP-connected assistant: call reefapi.onthemarket.search with {"location":"London"}.

Use cases

Who uses this API and why

Property portals call location_search then search to list properties in an area.
Dashboards use property_detail to enrich a listing.
Analysts use search to track UK inventory over time.

FAQ

Questions developers ask before integrating

What is the OnTheMarket API?

OnTheMarket API is a ReefAPI endpoint group for onthemarket It returns live JSON through POST requests under /onthemarket/v1.

Is the OnTheMarket API free to try?

Yes. ReefAPI starts with 1,000 free credits, no card required. OnTheMarket calls use the same shared credit balance as every other ReefAPI engine.

Do I need a OnTheMarket login or account?

No login to OnTheMarket is needed for the API response. You call ReefAPI with your x-api-key header, and the playground can run live examples before you create a production key.

How fresh is the OnTheMarket data?

The page example is captured from a live location_search call, and production requests fetch live data through ReefAPI rather than a static sample.

How many credits does the OnTheMarket API use?

OnTheMarket actions currently cost 1-3 credits per successful call. Failed or blocked calls are free, and all APIs draw from one credit pool.

Can I call OnTheMarket from an AI assistant or MCP client?

Yes. Connect ReefAPI once through MCP and your assistant can call onthemarket actions with the same key, credit pool and JSON envelope used by normal REST requests.

Is the OnTheMarket API a OnTheMarket scraper?

It is the managed alternative to a DIY OnTheMarket scraper. Instead of building and maintaining your own scraper — proxies, headless browsers, captcha and constant breakage — you call one ReefAPI endpoint and get the same onthemarket back as clean JSON.

Why does my OnTheMarket scraper keep getting blocked?

Most OnTheMarket scrapers break on anti-bot defenses, rate limits and IP bans that need rotating residential proxies and browser fingerprinting to clear. ReefAPI handles all of that for you — no proxies, no captchas, no maintenance — and returns live JSON. Blocked or failed calls are free.

docs / onthemarket

OnTheMarket

base /onthemarket/v13 endpoints

post/onthemarket/v1/location_searchfree

Resolve a text location (town, postcode, borough, area) to OnTheMarket location slug(s). Returns multiple ranked matches; use a result's location_id in search.

Parameter		Allowed / range	Description
query	required	—	Free-text place to resolve (town, city, postcode, borough, area).
channel = for-sale	optional	for-sale · to-rent · buy · sale · rent · lettings	Which market to search/resolve (default for-sale). Canonical values + the listed aliases are accepted; any other value is rejected with this list.
limit = 10	optional	1–50	Max location matches to return.

Try in playground →

post/onthemarket/v1/search2 credits

Search UK property listings by location (for sale / to rent) with structured filters: price, beds, property type, radius, keywords, added-within and sort. Paginate with page/max_pages (30 per page).

Parameter		Allowed / range	Description
location	optional	—	Free-text location OR an OnTheMarket location slug (e.g. 'london', 'sw9', 'manchester'). Provide this OR location_id. Use location_search for the exact slug.
location_id	optional	—	An OnTheMarket location slug from location_search (its `location_id`/seo_id, e.g. 'notting-hill', 'bs1'). Most precise. Provide this OR location.
channel = for-sale	optional	for-sale · to-rent · buy · sale · rent · lettings	Which market to search/resolve (default for-sale). Canonical values + the listed aliases are accepted; any other value is rejected with this list.
for_rent	optional	—	Shortcut: true selects the to-rent channel when `channel` is unset.
price_min	optional	0–	Minimum price in GBP (sale price, or monthly rent £pcm for to-rent).
price_max	optional	0–	Maximum price in GBP (sale price, or monthly rent £pcm for to-rent).
beds_min	optional	0–10	Minimum bedrooms (2 = 2+; 0 for studios).
beds_max	optional	0–10	Maximum bedrooms.
property_type	optional	—	Property type(s), comma-separated. One or more of: flat, apartment, houses, detached, semi-detached, terraced, bungalow, studio, cottage, mews, park-home, land (e.g. 'detached,semi-detached'). 'house'=houses.
radius	optional	0–30	Search radius in MILES around the location (0=this area only; 0.25/0.5/1/3/5/10/15/20/30).
added_within_days	optional	1–	Only listings added recently; mapped to the nearest supported window (1, 3, 7 or 14 days).
sort	optional	recommended · newest · price_high · price_low	Result ordering (default = OnTheMarket's recommended order).
keywords	optional	—	Free-text keyword filter (e.g. 'garden', 'garage', 'parking').
retirement_only	optional	—	Only retirement properties.
shared_ownership_only	optional	—	Only shared-ownership properties.
auction_only	optional	—	Only auction properties.
new_homes_only	optional	—	Only new-build homes.
include_under_offer	optional	—	Include Under Offer / Sold STC listings (for-sale).
page = 1	optional	1–	1-based result page (30 listings per page).
max_pages = 1	optional	1–42	How many 30-result pages to fetch and merge, starting at `page`.
filters	optional	—	Advanced escape-hatch: extra raw OnTheMarket query params as a key->value map, merged after the typed filters above.

Try in playground →

post/onthemarket/v1/property_detail3 credits

Full property record: price (+qualifier), beds/baths, description, key features, key-info (tenure, council-tax band), images, floorplans, virtual/video tours, documents, nearby stations & schools, area stats (avg price, crime level), breadcrumbs and the listing agent.

Parameter		Allowed / range	Description
property_id	required	—	OnTheMarket property id (the digits in a /details/<id>/ URL or a search result's property_id).
url	optional	—	Alternatively a full OnTheMarket property detail URL.

Try in playground →

Example request · location_search

curl -X POST https://api.reefapi.com/onthemarket/v1/location_search \
  -H "x-api-key: $REEF_KEY" \
  -H "content-type: application/json" \
  -d '{"query":"London"}'

Response shape

{
  "ok": true,
  "data": { /* the result */ },
  "meta": {
    "latency_ms": 240,
    "record_count": 12,
    "completeness_pct": 100
  },
  "error": null
}