{ "openapi": "3.0.1", "info": { "title": "Rightmove Property Page Scraper", "description": "Collect comprehensive information about properties listed on Rightmove, including details such as location, price, features, and any other relevant specifications available on the listing pages. pages.", "version": "0.0", "x-build-id": "KjL659keFL6TuIfpp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/moving_beacon-owner1~rightmove-property-page-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-moving_beacon-owner1-rightmove-property-page-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~rightmove-property-page-scraper/runs": { "post": { "operationId": "runs-sync-moving_beacon-owner1-rightmove-property-page-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~rightmove-property-page-scraper/run-sync": { "post": { "operationId": "run-sync-moving_beacon-owner1-rightmove-property-page-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": { "mode": { "title": "Scrape mode", "enum": [ "area", "urls" ], "type": "string", "description": "Choose 'Search by area' to scrape a Rightmove search URL, or 'Specific property URLs' to scrape a list of property detail URLs directly.", "default": "area" }, "searchUrl": { "title": "Rightmove search URL", "type": "string", "description": "Paste the full Rightmove search URL from your browser after setting filters on rightmove.co.uk (location, radius, price, sort, etc.). The actor extracts locationIdentifier, radius, sortType, etc. from this URL and paginates it with &index=. Used when mode = 'Search by area'.", "default": "https://www.rightmove.co.uk/property-for-sale/find.html?searchLocation=Newport%2C+South+Wales&useLocationIdentifier=true&locationIdentifier=REGION%5E991&radius=40.0&_includeSSTC=on&sortType=2&channel=BUY&transactionType=BUY&displayLocationIdentifier=Newport.html" }, "propertyUrls": { "title": "Property URLs", "type": "array", "description": "Rightmove property detail URLs to scrape directly (one per line). Example: https://www.rightmove.co.uk/properties/144751253. Used when mode = 'Specific property URLs'.", "default": [], "items": { "type": "string" } }, "maxListings": { "title": "Maximum listings", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stop after this many unique listings have been pushed to the dataset. (Area mode only — URL mode scrapes everything you provide.)", "default": 100 }, "fetchDetails": { "title": "Fetch detail pages", "type": "boolean", "description": "If enabled, visits each property's detail page to extract tenure, council tax, full description, agent address, etc. Slower but much richer output. (Always on in URL mode.)", "default": true }, "listingDelay": { "title": "Delay between listing pages (s)", "minimum": 0, "maximum": 60, "type": "integer", "description": "Sleep between paginated search-result pages.", "default": 2 }, "detailDelay": { "title": "Delay between detail requests (s)", "minimum": 0, "maximum": 60, "type": "integer", "description": "Sleep between individual property detail-page fetches.", "default": 1 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Apify Residential proxies are strongly recommended — Rightmove sits behind Cloudflare and datacenter IPs get challenged quickly.", "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 } } } } } } } } } }