# OnTheMarket Scraper (`moving_beacon-owner1/onthemarket-scraper`) Actor Explore UK property listings on OnTheMarket! Use tailored filters to find your ideal home based on price, bedrooms, property type, and whether you're renting or buying. Discover detailed property information to uncover your perfect place! - **URL**: https://apify.com/moving\_beacon-owner1/onthemarket-scraper.md - **Developed by:** [Jamshaid Arif](https://apify.com/moving_beacon-owner1) (community) - **Categories:** Automation, Developer tools, Real estate - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $10.00 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## OnTheMarket Scraper (Apify Actor) Scrape UK property listings from [OnTheMarket](https://www.onthemarket.com/) — for‑sale, to‑rent, or new‑homes — with rich filters and optional detail-page enrichment. ### Input | Field | Type | Default | Description | |---|---|---|---| | `area` | string (required) | `london` | Area slug (`london`, `manchester`, `brighton`, `london-greenwich`, `sw1`, …) | | `mode` | enum (required) | `for-sale` | `for-sale` / `to-rent` / `new-homes` | | `minPrice` / `maxPrice` | int | — | Price range in GBP (per month for rent) | | `minBedrooms` / `maxBedrooms` | int | — | Bedroom range | | `propertyType` | enum | any | `flats`, `detached-houses`, `bungalows`, etc. | | `radius` | enum | `0` | Miles around the area: `0` / `0.25` / `0.5` / `1` / `3` / `5` / `10` / `15` / `20` / `30` / `40` | | `sort` | enum | `featured` | `featured` / `newest` / `price_asc` / `price_desc` | | `furnished` | enum | any | Rent only: `furnished` / `part-furnished` / `unfurnished` | | `includeUnderOffer` | bool | `true` | Include under-offer / sold STC properties (sale mode) | | `includeLetAgreed` | bool | `true` | Include let-agreed properties (rent mode) | | `maxPages` | int (1–50) | `1` | Result pages to fetch (~24 properties per page) | | `includeDetails` | bool | `false` | Per-property detail-page fetch | | `maxListings` | int | `0` | Hard cap on items pushed | | `impersonate` | enum | `chrome124` | curl_cffi TLS profile | | `proxyConfiguration` | object | RESIDENTIAL (GB) | Proxy settings | #### Example input ```json { "area": "london", "mode": "for-sale", "minPrice": 500000, "maxPrice": 1200000, "minBedrooms": 2, "propertyType": "flats", "radius": "1", "sort": "newest", "includeUnderOffer": false, "maxPages": 5, "includeDetails": true, "maxListings": 100 } ```` ### Output #### Search‑only item ```json { "id": 14582341, "price": "£625,000", "price_value": 625000, "address": "Roupell Street, London, SE1", "beds": 2, "baths": 1, "type": "flat", "tenure": "leasehold", "url": "https://www.onthemarket.com/details/14582341/", "image": "https://media.onthemarket.com/properties/14582341/img_01_1024x768.jpg", "agent": "Foxtons - Waterloo", "agent_phone": "020 7846 0000", "summary": "A beautifully presented two-bedroom flat in the heart of...", "new_home": false, "added_or_reduced": "Added today" } ``` #### With `includeDetails: true`, each item additionally carries ```json { "postcode": "SE1 8TB", "latitude": 51.5042, "longitude": -0.1101, "reception": 1, "council_tax_band": "D", "epc_rating": "C", "floor_area": "78 m²", "description": "Spread across the second floor of a charming Victorian conversion...", "features": [ "Two double bedrooms", "Modern kitchen with integrated appliances", "Period features throughout", "Close to Waterloo station" ], "images": ["https://...img_01_1024x768.jpg", "..."], "floorplans": ["https://media.onthemarket.com/.../floorplan.jpg"], "stations": ["Waterloo (0.1 mi)", "Southwark (0.3 mi)", "Lambeth North (0.4 mi)"], "agent": { "name": "Foxtons", "phone": "020 7846 0000", "branch": "Waterloo", "url": "https://www.onthemarket.com/agents/foxtons-waterloo/", "logo": "https://media.onthemarket.com/agents/.../logo.png" } } ``` # Actor input Schema ## `area` (type: `string`): OnTheMarket area slug. Examples: 'london', 'manchester', 'brighton', 'edinburgh', 'cambridge', 'london-greenwich', 'sw1', 'm1'. Browse https://www.onthemarket.com to find the slug for your area. ## `mode` (type: `string`): For-sale, to-rent, or new-homes. ## `minPrice` (type: `integer`): Filter out properties priced below this number. For sale: total price. For rent: per month (pcm). ## `maxPrice` (type: `integer`): Filter out properties priced above this number. For sale: total price. For rent: per month (pcm). ## `minBedrooms` (type: `integer`): Minimum number of bedrooms. ## `maxBedrooms` (type: `integer`): Maximum number of bedrooms. ## `propertyType` (type: `string`): Restrict to a specific property type. Leave as 'Any' to include all. ## `radius` (type: `string`): Miles around the area. 'This area only' = 0. ## `sort` (type: `string`): How OnTheMarket orders the results. ## `furnished` (type: `string`): Only applies when mode is 'to-rent'. Leave as 'Any' to include all. ## `includeUnderOffer` (type: `boolean`): When mode is 'for-sale', include properties marked under-offer or sold subject to contract. ## `includeLetAgreed` (type: `boolean`): When mode is 'to-rent', include properties that have been let-agreed. ## `maxPages` (type: `integer`): How many search pages to fetch (~24 properties per page). ## `includeDetails` (type: `boolean`): If true, the actor visits each property page to extract full description, features, EPC rating, council tax band, floor area, all images, floor plans, nearest stations and agent info. Roughly multiplies runtime by N properties. ## `maxListings` (type: `integer`): Stop after this many properties have been pushed. 0 = no cap. ## `impersonate` (type: `string`): curl\_cffi TLS / JA3 fingerprint to mimic. ## `proxyConfiguration` (type: `object`): Apify Proxy or your own. OnTheMarket uses Cloudflare on top of standard rate limits — residential GB proxies are strongly recommended. ## Actor input object example ```json { "area": "london", "mode": "for-sale", "minPrice": 300000, "maxPrice": 800000, "minBedrooms": 2, "maxBedrooms": 4, "propertyType": "", "radius": "1", "sort": "newest", "furnished": "", "includeUnderOffer": true, "includeLetAgreed": true, "maxPages": 2, "includeDetails": false, "maxListings": 50, "impersonate": "chrome124", "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "GB" } } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "area": "london", "mode": "for-sale", "minPrice": 300000, "maxPrice": 800000, "minBedrooms": 2, "maxBedrooms": 4, "propertyType": "", "radius": "1", "sort": "newest", "furnished": "", "includeUnderOffer": true, "includeLetAgreed": true, "maxPages": 2, "includeDetails": false, "maxListings": 50, "impersonate": "chrome124", "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "GB" } }; // Run the Actor and wait for it to finish const run = await client.actor("moving_beacon-owner1/onthemarket-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "area": "london", "mode": "for-sale", "minPrice": 300000, "maxPrice": 800000, "minBedrooms": 2, "maxBedrooms": 4, "propertyType": "", "radius": "1", "sort": "newest", "furnished": "", "includeUnderOffer": True, "includeLetAgreed": True, "maxPages": 2, "includeDetails": False, "maxListings": 50, "impersonate": "chrome124", "proxyConfiguration": { "useApifyProxy": True, "apifyProxyGroups": ["RESIDENTIAL"], "apifyProxyCountry": "GB", }, } # Run the Actor and wait for it to finish run = client.actor("moving_beacon-owner1/onthemarket-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "area": "london", "mode": "for-sale", "minPrice": 300000, "maxPrice": 800000, "minBedrooms": 2, "maxBedrooms": 4, "propertyType": "", "radius": "1", "sort": "newest", "furnished": "", "includeUnderOffer": true, "includeLetAgreed": true, "maxPages": 2, "includeDetails": false, "maxListings": 50, "impersonate": "chrome124", "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "GB" } }' | apify call moving_beacon-owner1/onthemarket-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=moving_beacon-owner1/onthemarket-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "OnTheMarket Scraper", "description": "Explore UK property listings on OnTheMarket! Use tailored filters to find your ideal home based on price, bedrooms, property type, and whether you're renting or buying. Discover detailed property information to uncover your perfect place!", "version": "0.0", "x-build-id": "gaVg4keCSvwKK7ZZg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/moving_beacon-owner1~onthemarket-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-moving_beacon-owner1-onthemarket-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/moving_beacon-owner1~onthemarket-scraper/runs": { "post": { "operationId": "runs-sync-moving_beacon-owner1-onthemarket-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/moving_beacon-owner1~onthemarket-scraper/run-sync": { "post": { "operationId": "run-sync-moving_beacon-owner1-onthemarket-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "area", "mode" ], "properties": { "area": { "title": "Area", "type": "string", "description": "OnTheMarket area slug. Examples: 'london', 'manchester', 'brighton', 'edinburgh', 'cambridge', 'london-greenwich', 'sw1', 'm1'. Browse https://www.onthemarket.com to find the slug for your area.", "default": "london" }, "mode": { "title": "Listing mode", "enum": [ "for-sale", "to-rent", "new-homes" ], "type": "string", "description": "For-sale, to-rent, or new-homes.", "default": "for-sale" }, "minPrice": { "title": "Min price (£)", "minimum": 0, "type": "integer", "description": "Filter out properties priced below this number. For sale: total price. For rent: per month (pcm)." }, "maxPrice": { "title": "Max price (£)", "minimum": 0, "type": "integer", "description": "Filter out properties priced above this number. For sale: total price. For rent: per month (pcm)." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum number of bedrooms." }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum number of bedrooms." }, "propertyType": { "title": "Property type", "enum": [ "", "flats", "houses", "detached-houses", "semi-detached-houses", "terraced-houses", "end-of-terrace-houses", "bungalows", "cottages", "farms", "land", "parking-garages", "commercial" ], "type": "string", "description": "Restrict to a specific property type. Leave as 'Any' to include all.", "default": "" }, "radius": { "title": "Search radius", "enum": [ "0", "0.25", "0.5", "1", "3", "5", "10", "15", "20", "30", "40" ], "type": "string", "description": "Miles around the area. 'This area only' = 0.", "default": "0" }, "sort": { "title": "Sort order", "enum": [ "featured", "newest", "price_asc", "price_desc" ], "type": "string", "description": "How OnTheMarket orders the results.", "default": "featured" }, "furnished": { "title": "Furnished (rent only)", "enum": [ "", "furnished", "part-furnished", "unfurnished" ], "type": "string", "description": "Only applies when mode is 'to-rent'. Leave as 'Any' to include all.", "default": "" }, "includeUnderOffer": { "title": "Include under-offer / sold STC", "type": "boolean", "description": "When mode is 'for-sale', include properties marked under-offer or sold subject to contract.", "default": true }, "includeLetAgreed": { "title": "Include let-agreed", "type": "boolean", "description": "When mode is 'to-rent', include properties that have been let-agreed.", "default": true }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many search pages to fetch (~24 properties per page).", "default": 1 }, "includeDetails": { "title": "Fetch detail pages", "type": "boolean", "description": "If true, the actor visits each property page to extract full description, features, EPC rating, council tax band, floor area, all images, floor plans, nearest stations and agent info. Roughly multiplies runtime by N properties.", "default": false }, "maxListings": { "title": "Max listings (hard cap)", "minimum": 0, "type": "integer", "description": "Stop after this many properties have been pushed. 0 = no cap.", "default": 0 }, "impersonate": { "title": "Browser impersonation profile", "enum": [ "chrome124", "chrome131", "chrome120", "edge101", "safari17_0" ], "type": "string", "description": "curl_cffi TLS / JA3 fingerprint to mimic.", "default": "chrome124" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy or your own. OnTheMarket uses Cloudflare on top of standard rate limits — residential GB proxies are strongly recommended.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "GB" } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```