{ "openapi": "3.0.1", "info": { "title": "Rightmove Scraper - UK Property Data", "description": "Rightmove UK property listings for sale, to rent, new homes and commercial: price, beds, baths, address, coordinates, agent name and phone, photos, key features. Optional full details: description, postcode, tenure, EPC, floorplans, stations. No browser, no login. JSON, CSV or Excel.", "version": "1.0", "x-build-id": "RsywDhqPKDXSjuDen" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/benthepythondev~rightmove-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-benthepythondev-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/benthepythondev~rightmove-scraper/runs": { "post": { "operationId": "runs-sync-benthepythondev-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/benthepythondev~rightmove-scraper/run-sync": { "post": { "operationId": "run-sync-benthepythondev-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": { "location": { "title": "Locations", "type": "array", "description": "UK places to search: a town, city, borough, area, outcode (NW8) or postcode (SW1A 1AA), resolved through Rightmove's own place search. A Rightmove location id such as REGION^87490 is used as it is.", "items": { "type": "string" } }, "searchUrls": { "title": "Search URLs", "type": "array", "description": "Rightmove search links, copied from the browser with your filters (price, bedrooms, radius, property type, added in the last N days). For sale, to rent, new homes and commercial links all work, and so do place pages such as https://www.rightmove.co.uk/property-for-sale/London.html.", "items": { "type": "string" } }, "channel": { "title": "For sale or to rent", "enum": [ "BUY", "RENT", "NEW_HOME", "COMMERCIAL_BUY", "COMMERCIAL_RENT" ], "type": "string", "description": "What a location search looks for: for sale, to rent, new homes, or commercial property for sale or to let. A search link keeps its own choice.", "default": "BUY" }, "maxResults": { "title": "Max results per search", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Most listings to save per location or link. One Rightmove list ends after 1,008 listings; above that the run reads the search in price bands, lowest prices first, until it has this many or the search is exhausted.", "default": 50 }, "maxProperties": { "title": "Max properties per search (alias)", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Same as Max results per search, under the name other Rightmove Actors use; when set it wins. Leave empty to use Max results per search." }, "includeDetails": { "title": "Include property details", "type": "boolean", "description": "Also read each listing's page: full description, postcode, tenure and lease, council tax band, service charge and ground rent, deposit and furnishing for rentals, all photos, floorplans, EPC, brochures, nearest stations and the agent's address. Charged as one extra event per listing that has them.", "default": false }, "includePriceHistory": { "title": "Include price history", "type": "boolean", "description": "Add priceHistory to each listing: the address's past sales from HM Land Registry as Rightmove shows them (year, price, percent change from the sale before), newest first. Reads the property page, so it also turns on property details and is charged as the details event. England and Wales only; an empty list means no recorded sale.", "default": false }, "monitoringMode": { "title": "Monitoring mode (only new listings)", "type": "boolean", "description": "For scheduled runs: save only listings this watch has not delivered before. The first run saves the current listings up to the limit; later runs save only listings that appeared since. The memory is kept per saved task (or per set of locations, links and channel) in the key-value store rightmove-scraper-monitor. Known listings are not charged.", "default": false } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }