{ "openapi": "3.0.1", "info": { "title": "Rightmove Scraper - UK Sale & Rent Property Listings", "description": "Scrape Rightmove.co.uk across residential, new homes, student, commercial, overseas, and retirement searches by location or URL. Extract prices, beds, baths, tenure, agents, photos, and detail fields as a Rightmove API alternative.", "version": "0.2", "x-build-id": "g30TJhRrZ0VpwnGKK" }, "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 (SRP) or property detail (LDP) URLs. Search URLs override location/channel when provided.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "location": { "title": "Location", "type": "string", "description": "Place name resolved via Rightmove typeahead (e.g. Edinburgh, Manchester). For searchCategory=overseas, use an overseas country/region (e.g. Spain) which resolves to WORLD_REGION^… — UK place names are rejected. You may also paste a locationIdentifier (WORLD_REGION^169) or use an overseas startUrl. Ignored when startUrls contain a search URL.", "default": "Edinburgh" }, "channel": { "title": "Channel", "enum": [ "BUY", "RENT" ], "type": "string", "description": "BUY (for sale) or RENT (to rent). Used when building a search from location. Student forces RENT; new homes / retirement / overseas force BUY.", "default": "BUY" }, "searchCategory": { "title": "Search category", "enum": [ "residential", "new_homes", "student", "commercial", "overseas", "retirement" ], "type": "string", "description": "Rightmove listing search category: residential, new_homes, student, commercial, overseas, retirement. Aliases: homes→residential. Builds the matching find.html path with channel. startUrls override this when set.", "default": "residential" }, "maxItems": { "title": "Max listings (max 1,050; free users capped at 1,000/run)", "minimum": 1, "maximum": 1050, "type": "integer", "description": "Maximum property records to save (1–1050). Free Apify plan users are limited to 1,000 results per run and 10 total runs of this Actor — limits set by the Actor developer.", "default": 1 }, "maxPages": { "title": "Max search pages", "minimum": 1, "maximum": 42, "type": "integer", "description": "Maximum SRP pages to fetch. Rightmove caps at 42 pages (~24 listings/page + featured).", "default": 1 }, "scrapeDetails": { "title": "Scrape detail pages", "type": "boolean", "description": "Fetch each property LDP and hydrate window.__PAGE_MODEL for full propertyData.", "default": true }, "includeRawPayloads": { "title": "Include raw payloads", "type": "boolean", "description": "When true, keep bulky rawSrp/rawLdp fields on each dataset item. Default false to reduce memory and dataset size.", "default": false }, "sortType": { "title": "Sort type", "enum": [ "6", "2", "1", "10" ], "type": "string", "description": "Rightmove sortType query value. 6 = Newest Listed (common default).", "default": "6" }, "requestDelayMillis": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Politeness delay between HTTP requests.", "default": 500 }, "maxConcurrency": { "title": "Request concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Max concurrent HTTP fetches (kept low to reduce 429 risk on LDP).", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify proxy if you mint proxyUrl in the Actor. Ignored when Actor env WORKER_PROVIDES_PROXY=1 (the Cloud Run worker uses its own PROXY_URL). Default off so Store Test does not require the RESIDENTIAL proxy group.", "default": { "useApifyProxy": false } }, "workerBaseUrl": { "title": "Worker base URL (optional)", "type": "string", "description": "Override the Cloud Run worker origin for this run. Defaults to Actor env WORKER_BASE_URL. Use when testing a staging worker; production migrations should update WORKER_BASE_URL in Actor settings (no code change).", "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 } } }, "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 } } } } } } } } } }