{ "openapi": "3.0.1", "info": { "title": "Rightmove Scraper & API - UK Property for Sale & Rent, Agents", "description": "Rightmove scraper and API: UK property listings by place name, outcode or search URL, for sale, to rent, commercial. One result = one property: address, price, beds, type, status, dates, agent + phone, lat/lng, images; optional full details. No start fee. $0.50 per 1,000.", "version": "1.0", "x-build-id": "NHxOmI0VhUm2mkfZv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rel8ble~rightmove-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rel8ble-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/rel8ble~rightmove-scraper/runs": { "post": { "operationId": "runs-sync-rel8ble-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/rel8ble~rightmove-scraper/run-sync": { "post": { "operationId": "run-sync-rel8ble-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": { "locations": { "title": "Locations", "type": "array", "description": "Where to search, one per line: a town or city (\"Manchester\", \"Bristol\"), a postcode district (\"SW1A\", \"M1\"), a place with its county (\"Leeds, West Yorkshire\"), a station (\"Clapham Junction Station\"), or a Rightmove location identifier from a rightmove.co.uk search URL (\"REGION^904\", \"OUTCODE^2506\"). Names are resolved through Rightmove's own location search (the first matching region / outcode / postcode / station wins); the identifier form is exact. Typical: 1-50 lines.", "items": { "type": "string" } }, "listingType": { "title": "Listing type", "enum": [ "sale", "rent", "commercial-sale", "commercial-rent" ], "type": "string", "description": "What to list for every location: \"sale\" (property for sale, default), \"rent\" (property to rent), \"commercial-sale\" or \"commercial-rent\". Pasted search URLs keep their own type.", "default": "sale" }, "startUrls": { "title": "Rightmove URLs", "type": "array", "description": "Optional. Rightmove links, one per line: a search results page (any \".../property-for-sale/find.html?locationIdentifier=...\", \".../property-to-rent/find.html?...\" or commercial find.html link - its own filters are kept, all pages are read) or a property page (\"https://www.rightmove.co.uk/properties/171910151\", one full row each with details).", "items": { "type": "string" } }, "radius": { "title": "Radius (miles)", "enum": [ "0.0", "0.25", "0.5", "1.0", "3.0", "5.0", "10.0", "15.0", "20.0", "30.0", "40.0" ], "type": "string", "description": "How far around the location to search, as on Rightmove: \"0.0\" (default, this area only) to \"40.0\" miles.", "default": "0.0" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Optional. In GBP: a sale price (e.g. 150000) or, for rentals, pounds per calendar month (e.g. 800). Applied by Rightmove." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Optional. In GBP: a sale price (e.g. 350000) or, for rentals, pounds per calendar month (e.g. 1500). Applied by Rightmove." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Optional. 0 = studio and up. Applied by Rightmove." }, "maxBedrooms": { "title": "Maximum bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Optional. Applied by Rightmove." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Optional. Leave empty for all types. Residential searches only; commercial searches ignore it.", "items": { "type": "string", "enum": [ "detached", "semi-detached", "terraced", "flat", "bungalow", "land", "park-home", "private-halls" ], "enumTitles": [ "Detached", "Semi-detached", "Terraced", "Flat / apartment", "Bungalow", "Land", "Park home", "Private halls (rent)" ] } }, "maxDaysSinceAdded": { "title": "Added to site", "enum": [ "", "1", "3", "7", "14" ], "type": "string", "description": "Optional. Only listings added (or reduced) within the last N days, as on Rightmove.", "default": "" }, "sortBy": { "title": "Sort", "enum": [ "default", "highestPrice", "lowestPrice", "newestListed", "oldestListed" ], "type": "string", "description": "Rightmove's sort order. \"newestListed\" is the one to use with a results cap when you want the latest listings.", "default": "default" }, "includeSoldOrLetAgreed": { "title": "Include sold STC / let agreed", "type": "boolean", "description": "Default false: Rightmove hides properties that are sold subject to contract (sale) or let agreed (rent). True: include them; the row then carries status \"Sold STC\" / \"Let agreed\" and isSoldSTC / isLetAgreed.", "default": false }, "mustHave": { "title": "Must have", "type": "array", "description": "Optional. Rightmove's \"must have\" filters.", "items": { "type": "string", "enum": [ "garden", "parking", "newHome", "retirement", "sharedOwnership", "auction" ], "enumTitles": [ "Garden", "Parking", "New home", "Retirement home", "Shared ownership", "Auction property" ] } }, "dontShow": { "title": "Don't show", "type": "array", "description": "Optional. Rightmove's \"don't show\" filters.", "items": { "type": "string", "enum": [ "newHome", "retirement", "sharedOwnership" ], "enumTitles": [ "New homes", "Retirement homes", "Shared ownership" ] } }, "furnishTypes": { "title": "Furnishing (rent)", "type": "array", "description": "Optional, rentals only.", "items": { "type": "string", "enum": [ "furnished", "partFurnished", "unfurnished" ], "enumTitles": [ "Furnished", "Part furnished", "Unfurnished" ] } }, "letType": { "title": "Let type (rent)", "enum": [ "", "longTerm", "shortTerm", "student" ], "type": "string", "description": "Optional, rentals only.", "default": "" }, "keywords": { "title": "Keywords", "type": "string", "description": "Optional. Rightmove keyword filter, comma-separated (\"garage, conservatory\"): only listings whose description mentions them." }, "includeDetails": { "title": "Include property details", "type": "boolean", "description": "Default false: one row per property from the search results (about 24 properties per request): address, price, beds, baths, type, status, dates, agent name / branch / phone, lat / lng, images, summary, key features, flags. True: also open every property page (one request each, about 0.4 MB) and add the full description, floorplans, EPC images, brochures, council tax band, tenure and lease years, ground rent / service charge, size in sq ft / sq m, postcode, deposit / furnishing / let term (rentals), nearest stations, utilities / parking / garden features, agent address and description.", "default": false }, "deepSearch": { "title": "Deep search (past Rightmove's 1,000-result cap)", "type": "boolean", "description": "Rightmove serves at most about 1,000 results per search. True: when a search has more, it is split into price bands (each under 1,000) and every band is read, so large areas come back complete. Costs one extra request per split; duplicates across bands are skipped and never charged.", "default": false }, "maxResultsPerSearch": { "title": "Max results per search", "minimum": 0, "type": "integer", "description": "Properties to save per location / pasted search URL. 0 = everything Rightmove serves (up to its 1,000 cap, or all of it with deep search).", "default": 100 }, "maxResults": { "title": "Max results in total", "minimum": 0, "type": "integer", "description": "Stop the run after this many properties across all searches. 0 = no limit (the maximum cost per run still applies).", "default": 1000 }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many requests run at once. 3 is safe; higher is faster for big detail runs but more likely to be rate-limited.", "default": 3 }, "maxRequestRetries": { "title": "Max retries per request", "minimum": 0, "maximum": 20, "type": "integer", "description": "Retries on a blocked, rate-limited or failed request, each on a new session / IP.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy by default (Rightmove serves it). You can also pass your own proxy URLs.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }