# OnTheMarket - UK Real Estate (`swerve/onthemarket-scraper`) Actor Used by UK real estate investors monitoring London, Manchester, Birmingham, and Edinburgh, plus lettings agents tracking competitor inventory and PropTech analysts. Pulls rent and sale listings with price, bedrooms, postcode, agent, and image gallery from onthemarket.com. - **URL**: https://apify.com/swerve/onthemarket-scraper.md - **Developed by:** [Swerve](https://apify.com/swerve) (community) - **Categories:** Real estate - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $2.00 / 1,000 results This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. 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 - UK Real Estate API Extract real estate listings from [onthemarket.com](https://www.onthemarket.com/), one of the UK's three major property portals. Returns rich structured data per listing: price, bedrooms, bathrooms, postcode, agent, full image gallery, and "recently added" status. ### What you get per listing - `listingId`, `url` — unique ID and direct link - `listingType` — `rent` or `sale` - `propertyType` — Flat, House, Studio, Maisonette, Bungalow, etc. - `title`, `address` — listing headline + full address as published - `city`, `postcode` — parsed from address (UK postcode regex) - `price` (GBP, integer) — monthly for rent, total for sale - `priceText` — as published (e.g. `"£1,475 pcm"`, `"Offers in excess of £500,000"`) - `priceQualifier` — qualifier label if any (`"Offers in excess of"`, `"Guide price"`) - `bedrooms`, `bathrooms` - `features[]` — bullet feature list (e.g. `"1 bedroom"`, `"Garden"`, `"Parking"`) - `agentName` — listing agent or agency - `imageUrl`, `imageUrls[]` — cover + full gallery - `isRecentlyAdded`, `daysSinceAdded` — freshness signals from OnTheMarket - `currency` (always GBP), `scrapedAt` ### How to use **Easy mode (recommended):** type a UK city name and pick listing type. ```json { "city": "London", "listingType": "rent", "maxItems": 200 } ```` Other examples: ```json { "city": "Manchester", "listingType": "sale", "maxItems": 100 } { "city": "Birmingham", "listingType": "rent", "maxItems": 100 } { "city": "Edinburgh", "listingType": "sale", "maxItems": 50 } { "city": "Bristol", "listingType": "rent", "maxItems": 100 } ``` **Power-user mode:** for finer filters (price range, bedrooms, sub-area, property sub-type), set them on onthemarket.com, copy the URL from your browser, paste into `searchUrl`. The structured inputs are bypassed. ### Common use cases - **Investor monitoring** — track new listings across London, Manchester, Birmingham, Edinburgh; snapshot rent yields by postcode. - **Lettings agencies** — pull competitor listings + agency activity for your market. - **PropTech analytics** — supply, average price/bedroom, recently-added share by city. - **Lead generation** — `agentName` aggregates the high-volume agencies in each market. ### Data quality In testing across London, Manchester, Birmingham, and Edinburgh (sample of 100+ listings, both rent and sale): | Field | Fill rate | |---|---| | price, priceText, propertyType | 100% | | address, city, postcode | 100% | | bedrooms | 95-100% (some studios legitimately have no `bedrooms` value) | | bathrooms | 80-95% (not always published in the search response) | | imageUrl, imageUrls | ~99% | | agentName | 100% | | isRecentlyAdded, daysSinceAdded | populated when OnTheMarket flags the listing as fresh | `pricePerSqm` is always null — OnTheMarket does not publish floor area in the search response. ### Pricing Pay per result. See the Pricing tab. Failed runs cost nothing. ### Notes - The actor uses Apify's residential proxy (UK) for reliable access. - Pagination is automatic — set your desired `maxItems` and the actor walks through pages until it has enough or runs out. - Postcode is extracted from the address using the standard UK postcode pattern (handles outward and inward codes including space-separated and concatenated forms). Found a bug or have a feature request? Open an issue and I respond within 24h. # Actor input Schema ## `city` (type: `string`): UK city or town name (e.g. 'London', 'Manchester', 'Birmingham', 'Edinburgh', 'Bristol'). Required unless 'Search URL' is set. ## `listingType` (type: `string`): To rent or for sale. ## `maxItems` (type: `integer`): Maximum number of listings to return. ## `searchUrl` (type: `string`): Optional. Power-user override. Set your filters on onthemarket.com (price range, bedrooms, sub-area, etc.), copy the URL from your browser, paste here. Bypasses the structured inputs above. ## Actor input object example ```json { "city": "London", "listingType": "rent", "maxItems": 100 } ``` # 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 = { "city": "London" }; // Run the Actor and wait for it to finish const run = await client.actor("swerve/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 = { "city": "London" } # Run the Actor and wait for it to finish run = client.actor("swerve/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 '{ "city": "London" }' | apify call swerve/onthemarket-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=swerve/onthemarket-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "OnTheMarket - UK Real Estate", "description": "Used by UK real estate investors monitoring London, Manchester, Birmingham, and Edinburgh, plus lettings agents tracking competitor inventory and PropTech analysts. Pulls rent and sale listings with price, bedrooms, postcode, agent, and image gallery from onthemarket.com.", "version": "1.0", "x-build-id": "iUlGSgEUMQ4tsTuLs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/swerve~onthemarket-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-swerve-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/swerve~onthemarket-scraper/runs": { "post": { "operationId": "runs-sync-swerve-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/swerve~onthemarket-scraper/run-sync": { "post": { "operationId": "run-sync-swerve-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", "properties": { "city": { "title": "City or area", "type": "string", "description": "UK city or town name (e.g. 'London', 'Manchester', 'Birmingham', 'Edinburgh', 'Bristol'). Required unless 'Search URL' is set." }, "listingType": { "title": "Listing type", "enum": [ "rent", "sale" ], "type": "string", "description": "To rent or for sale.", "default": "rent" }, "maxItems": { "title": "Max listings", "minimum": 1, "type": "integer", "description": "Maximum number of listings to return.", "default": 100 }, "searchUrl": { "title": "Search URL (advanced)", "type": "string", "description": "Optional. Power-user override. Set your filters on onthemarket.com (price range, bedrooms, sub-area, etc.), copy the URL from your browser, paste here. Bypasses the structured inputs above." } } }, "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 } } } } } } } } } } ```