{ "openapi": "3.0.1", "info": { "title": "Rightmove Scraper: UK Property Listings, Prices & Agents", "description": "Scrape Rightmove.co.uk UK property listings (for sale & to rent): price, bedrooms, bathrooms, type, tenure, address, GPS, agent, size and dates. HTTP-only, no browser. Filter by location, price, bedrooms and radius.", "version": "1.0", "x-build-id": "RmGOCx9vHgSEAIaWj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dltik~rightmove-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dltik-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/dltik~rightmove-scraper/runs": { "post": { "operationId": "runs-sync-dltik-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/dltik~rightmove-scraper/run-sync": { "post": { "operationId": "run-sync-dltik-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": { "searchUrls": { "title": "Search URLs", "type": "array", "description": "One or more Rightmove search URLs you built on the site (any filters/location). Recommended: search on rightmove.co.uk, then copy the URL. Example: https://www.rightmove.co.uk/property-for-sale/find.html?locationIdentifier=REGION%5E87490 . Overrides the fields below if set.", "items": { "type": "string" } }, "locationIdentifier": { "title": "Location identifier", "type": "string", "description": "Rightmove location code, used when 'searchUrls' is empty. Find it in the URL after searching a place on rightmove.co.uk. Examples: REGION^87490 (London), REGION^904 (Manchester), OUTCODE^2520 (a postcode area)." }, "transaction": { "title": "Transaction", "enum": [ "buy", "rent" ], "type": "string", "description": "For sale (buy) or to rent.", "default": "buy" }, "priceMin": { "title": "Min price (£)", "type": "integer", "description": "Minimum price filter (used when building from locationIdentifier)." }, "priceMax": { "title": "Max price (£)", "type": "integer", "description": "Maximum price filter (used when building from locationIdentifier)." }, "minBedrooms": { "title": "Min bedrooms", "type": "integer", "description": "Minimum number of bedrooms (used when building from locationIdentifier)." }, "maxBedrooms": { "title": "Max bedrooms", "type": "integer", "description": "Maximum number of bedrooms (used when building from locationIdentifier)." }, "radius": { "title": "Radius (miles)", "type": "string", "description": "Search radius around the location in miles (e.g. 0, 0.5, 1, 3, 5, 10). Used when building from locationIdentifier." }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of listings to return per run. Note: Rightmove caps each search at ~1000 results — split by area/price for more.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Rightmove needs no proxy and no geo-restriction, but a proxy helps for very large pulls. Leave off for normal use.", "default": { "useApifyProxy": false } }, "customProxyUrl": { "title": "Custom proxy URL (advanced)", "type": "string", "description": "Optional. Route through your own proxy, e.g. http://user:pass@host:port ." } } }, "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 } } } } } } } } } }