{ "openapi": "3.0.1", "info": { "title": "Rightmove Properties Scraper", "description": "UK properties for sale and to rent from Rightmove: address, price, bedrooms, tenure, geo coordinates, selling agent, images and listing dates. Search by place name - locations are resolved for you.", "version": "0.1", "x-build-id": "bQjGSRd57egdkl5ZI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapyx~rightmove-properties-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapyx-rightmove-properties-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/scrapyx~rightmove-properties-scraper/runs": { "post": { "operationId": "runs-sync-scrapyx-rightmove-properties-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/scrapyx~rightmove-properties-scraper/run-sync": { "post": { "operationId": "run-sync-scrapyx-rightmove-properties-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": { "channel": { "title": "Channel", "enum": [ "buy", "rent" ], "type": "string", "description": "Properties for sale or to rent. Rent rows carry a price frequency (monthly) that sale rows do not - comparing a rent amount to a sale amount without reading it compares a month of rent to a purchase price.", "default": "buy" }, "locations": { "title": "Locations", "type": "array", "description": "Where to search. Accepts a plain place name (London, Bath, Manchester), a Rightmove identifier (REGION^87490), or a Rightmove search URL. Names are resolved through Rightmove's own location lookup; when a name is ambiguous the runners-up are reported in the summary, so you can see whether you got the Richmond you meant.", "default": [ "London" ], "items": { "type": "string" } }, "sortBy": { "title": "Sort by", "enum": [ "default", "priceAsc", "priceDesc", "newest", "oldest" ], "type": "string", "description": "Result ordering. Note Rightmove places featured and premium listings FIRST regardless of sort, so the top rows of a sorted page are routinely out of order - every row carries isFeatured so you can filter them before sorting yourself.", "default": "default" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Lower price bound in GBP. For rent this is per month. Verified to genuinely narrow results." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Upper price bound in GBP. For rent this is per month." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Lower bedroom bound. Verified: a value of 4 returned only 4+ bed properties." }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "type": "integer", "description": "Upper bedroom bound." }, "radius": { "title": "Search radius (miles)", "minimum": 0, "maximum": 40, "type": "integer", "description": "How far beyond the location to search, in miles. Only Rightmove's own steps are accepted: 0, 0.25, 0.5, 1, 3, 5, 10, 15, 20, 30, 40 — any other value is refused. 0 is the location itself; larger values genuinely widen the result set (London at 0 miles = 59,420 matches, at 10 miles = 102,280).", "default": 0 }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Optional filter: bungalow, detached, flat, land, park-home, semi-detached, terraced. An unrecognised type is refused here, because Rightmove answers one with an empty page rather than an error - which would read as nothing matched. Note Rightmove's own categories are loose: a bungalow search returns some rows sub-typed Land or Detached.", "default": [], "items": { "type": "string" } }, "maxPages": { "title": "Max pages per location", "minimum": 1, "maximum": 45, "type": "integer", "description": "Pages to fetch per location; each page is 25 properties. Paging is capped by Rightmove at roughly 1,025 properties per search no matter how many matches it reports - see the actor README.", "default": 5 }, "maxItems": { "title": "Max properties", "minimum": 1, "type": "integer", "description": "Optional cap on total property rows across the run, shared across every location. Counted after de-duplication." }, "maxConcurrency": { "title": "Max concurrent requests", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many requests may be in flight at once. Only matters when several locations are listed; paging within one is sequential.", "default": 2 }, "minRequestInterval": { "title": "Minimum interval between requests (seconds)", "minimum": 0.1, "maximum": 15, "type": "number", "description": "The honest speed control: the shortest gap between two request starts. Search pages are about 1.2 MB each.", "default": 1 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential with no country pin is the cloud default. Rightmove is UK-only and prices are GBP, so the proxy country does not change your data. Note the actor uses a fixed allowlist of TLS fingerprints - some Chrome and Firefox builds are refused outright by the site.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }