{ "openapi": "3.0.1", "info": { "title": "🏠 Rightmove Scraper", "description": "🏠 Rightmove Scraper (rightmove-scraper) extracts UK property listings, prices, locations & key details fast. 🚀 Perfect for real estate analytics, lead gen, market research & investors. 🔍 Reliable, efficient & easy to automate.", "version": "0.1", "x-build-id": "HiIicwJW5r7ao48LP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/simpleapi~rightmove-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-simpleapi-rightmove-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/simpleapi~rightmove-scraper/runs": { "post": { "operationId": "runs-sync-simpleapi-rightmove-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/simpleapi~rightmove-scraper/run-sync": { "post": { "operationId": "run-sync-simpleapi-rightmove-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": { "listUrls": { "title": "🔗 Search (list) URLs", "type": "array", "description": "Rightmove search-result page URLs (for sale or to rent). Each one is paginated automatically. Example: https://www.rightmove.co.uk/property-for-sale/find.html?locationIdentifier=OUTCODE%5E2445", "items": { "type": "string" } }, "propertyUrls": { "title": "🏡 Direct property URLs", "type": "array", "description": "Individual property page URLs, e.g. https://www.rightmove.co.uk/properties/169711034", "default": [], "items": { "type": "string" } }, "fullScrape": { "title": "📦 Full scrape (every run)", "type": "boolean", "description": "Scrape ALL properties matching your input on every run. Turn this OFF when you enable monitoring mode below.", "default": true }, "monitoringMode": { "title": "🆕 Monitoring mode (only new listings)", "type": "boolean", "description": "If checked, only properties that are brand-new compared to previous runs are scraped. Please turn OFF full scrape above when using this.", "default": false }, "deduplicateAtTaskLevel": { "title": "🧩 Deduplicate & monitor at task level", "type": "boolean", "description": "Track 'seen' listings per task instead of per account. Useful only when running multiple tasks of this scraper.", "default": false }, "fullPropertyDetails": { "title": "🔬 Include full property details", "type": "boolean", "description": "Visit each property page for the rich record (council tax, lease, floorplans, stations, EPC, etc.). Leaving it off is much faster.", "default": false }, "includePriceHistory": { "title": "📈 Include price history (if available)", "type": "boolean", "description": "Fetch sold-price history. Automatically enables full property details.", "default": false }, "includeNearestSchools": { "title": "🏫 Include nearest schools (if available)", "type": "boolean", "description": "Fetch nearby schools. Automatically enables full property details.", "default": false }, "enableDelistingTracker": { "title": "🗂️ Enable delisting tracker (KV store)", "type": "boolean", "description": "Stamp every property with a lastSeen date in a key-value store so you can spot delisted properties. (Enabling this has an impact on billing.)", "default": false }, "addEmptyTrackerRecord": { "title": "➕ Add tracker ID record in incremental mode", "type": "boolean", "description": "In monitoring mode, push an id-only tracker record for still-listed properties so a custom loader can detect delistings.", "default": false }, "email": { "title": "📧 Email address (notifications / errors)", "type": "string", "description": "Receive a run report or an error notification at this address.", "default": "" }, "maxProperties": { "title": "🔢 Max properties per list URL", "minimum": 1, "type": "integer", "description": "Maximum number of properties to scrape per input search URL.", "default": 10 }, "proxyConfiguration": { "title": "🛡️ Proxy configuration", "type": "object", "description": "The scraper starts with a direct connection and automatically escalates to datacenter, then residential proxies only if Rightmove blocks it. Residential (country GB) is recommended for reliability.", "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 } } } } } } } } } }