{ "openapi": "3.0.1", "info": { "title": "Rightmove Scraper - UK Sale & Rent Property Listings", "description": "Extract UK residential properties for sale and rent from Rightmove by location or URL. Get prices, bedrooms, photos, tenure and available agency contacts. Pay per delivered listing row plus a start fee.", "version": "0.2", "x-build-id": "u0fmoiiA3rRRyklyV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~rightmove-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-rightmove-property-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/lentic_clockss~rightmove-property-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-rightmove-property-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/lentic_clockss~rightmove-property-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-rightmove-property-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Rightmove search or property URLs as plain strings in the JSON input editor, not objects with a url key. Search URLs need locationIdentifier; set channel separately, and leave this empty to use location.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "location": { "title": "Location", "type": "string", "description": "UK place name, such as Edinburgh or Manchester, used when startUrls is empty. Empty JSON input starts a billed example for Edinburgh with up to 3 rows." }, "channel": { "title": "Channel", "enum": [ "BUY", "RENT" ], "type": "string", "description": "Use BUY for properties for sale or RENT for rentals. Set this for search URLs as well as location searches; a rental URL does not select RENT automatically.", "default": "BUY" }, "searchCategory": { "title": "Search category", "enum": [ "residential" ], "type": "string", "description": "Only residential listings are supported; homes is accepted as an alias. Commercial, overseas, student, new-home and retirement searches are not supported.", "default": "residential" }, "maxItems": { "title": "Max listings per URL or location", "minimum": 1, "maximum": 1050, "type": "integer", "description": "Maximum rows for each start URL, or for the location search when URLs are empty; default 70, with larger requests collected in parts of at most 70 rows. The whole run is bounded by your maximum charge; Free-plan users have at most 200 rows per run and 10 total runs.", "default": 70 }, "maxPages": { "title": "Max search pages", "minimum": 1, "maximum": 42, "type": "integer", "description": "Retained for legacy compatibility: maxItems controls pagination in the current entity-v1 output, and maxPages does not limit pages. Use maxItems to set your per-input row limit.", "default": 1 }, "scrapeDetails": { "title": "Scrape detail pages", "type": "boolean", "description": "Add available property details, such as descriptions, photos and tenure, to search rows. Direct property URLs request details regardless of this setting.", "default": true }, "sortType": { "title": "Sort type", "enum": [ "6", "2", "1", "10" ], "type": "string", "description": "Sort search results by newest listing, highest price, lowest price or oldest listing. Uses the selected sort even when a search URL contains a different sort value.", "default": "6" }, "includeRawPayloads": { "title": "Include raw payloads", "type": "boolean", "description": "Include source records in rawSrp and rawLdp alongside each listing. Lists within raw records are capped at 50 entries, and raw records may be omitted to reduce row size.", "default": false }, "requestDelayMillis": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Pause between enriched search listings in milliseconds, from 0 to 10000. This is not a limit on how long the run can take.", "default": 500 }, "workerBaseUrl": { "title": "Developer testing URL", "pattern": "^(https?://\\S+)?$", "type": "string", "description": "Leave empty. Used only by the developer for testing.", "default": "" } } }, "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 } } } } } } } } } }