{ "openapi": "3.0.1", "info": { "title": "Rightmove Scraper — UK Property Listings & Prices, Cheap", "description": "Rightmove Scraper for the UK: houses and flats for sale or to rent, plus sold prices. Search by town, postcode or search URL with price, bedroom and type filters; splits past the 1,000-result cap. Optional details: tenure, council tax, EPC, floorplans. From US$0.60 per 1,000 properties.", "version": "0.1", "x-build-id": "PWWmHO1xG4RoWNJdS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fabrikit~rightmove-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fabrikit-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/fabrikit~rightmove-scraper/runs": { "post": { "operationId": "runs-sync-fabrikit-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/fabrikit~rightmove-scraper/run-sync": { "post": { "operationId": "run-sync-fabrikit-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": { "mode": { "title": "What to scrape", "enum": [ "sale", "rent", "sold" ], "type": "string", "description": "Properties for sale, properties to rent, or sold house prices (Land Registry history shown on Rightmove).", "default": "sale" }, "locations": { "title": "Locations", "type": "array", "description": "Towns, areas, postcodes or outcodes, one search per entry (for example: Manchester, Leeds, M4 7FD, SW1A). You can also use a Rightmove locationIdentifier such as REGION^904. Sold prices mode accepts towns, outcodes and full postcodes.", "items": { "type": "string" } }, "startUrls": { "title": "Rightmove URLs (optional)", "type": "array", "description": "Search result URLs (…/find.html?locationIdentifier=…, all their filters are kept), single listing URLs (/properties/123456789, works for commercial too) or sold prices pages (/house-prices/m4-7fd.html).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max properties", "minimum": 1, "type": "integer", "description": "Stop after this many properties in total. Searches with more than ~1,000 results are split into price bands automatically.", "default": 50 }, "includeDetails": { "title": "Include details (extra cost)", "type": "boolean", "description": "Open each listing page to add full description, key features, tenure, council tax band, ground rent and service charge, EPC, floorplans, nearest stations and agency details. Charged per listing with details. Not used in sold mode.", "default": false }, "minPrice": { "title": "Min price (£)", "minimum": 0, "type": "integer", "description": "Minimum price for sale, or monthly rent when searching to rent." }, "maxPrice": { "title": "Max price (£)", "minimum": 0, "type": "integer", "description": "Maximum price for sale, or monthly rent when searching to rent." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum number of bedrooms (0 = studio)." }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum number of bedrooms." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Only these property types. Leave empty for all.", "items": { "type": "string", "enum": [ "detached", "semi-detached", "terraced", "flat", "bungalow", "land", "park-home" ], "enumTitles": [ "Detached", "Semi-detached", "Terraced", "Flat / apartment", "Bungalow", "Land", "Park home" ] } }, "radius": { "title": "Search radius (miles)", "enum": [ "0", "0.25", "0.5", "1", "3", "5", "10", "15", "20", "30", "40" ], "type": "string", "description": "Extend the search around each location. Default: this area only.", "default": "0" }, "maxDaysSinceAdded": { "title": "Added within", "enum": [ "", "1", "3", "7", "14" ], "type": "string", "description": "Only listings added or reduced in the last N days. Leave on Anytime for all.", "default": "" }, "includeSoldSTC": { "title": "Include sold subject to contract", "type": "boolean", "description": "For sale mode: also return properties that are under offer / sold STC.", "default": false }, "furnishTypes": { "title": "Furnishing (rent only)", "type": "array", "description": "Only for rentals. Leave empty for all.", "items": { "type": "string", "enum": [ "furnished", "partFurnished", "unfurnished" ], "enumTitles": [ "Furnished", "Part furnished", "Unfurnished" ] } }, "mustHave": { "title": "Must have", "type": "array", "description": "Only listings with these features.", "items": { "type": "string", "enum": [ "garden", "parking", "newHome", "retirement", "sharedOwnership", "auction" ], "enumTitles": [ "Garden", "Parking", "New home", "Retirement home", "Shared ownership", "Auction" ] } }, "dontShow": { "title": "Hide", "type": "array", "description": "Hide these kinds of listings.", "items": { "type": "string", "enum": [ "newHome", "retirement", "sharedOwnership", "houseShare", "student" ], "enumTitles": [ "New homes", "Retirement homes", "Shared ownership", "House shares (rent)", "Student (rent)" ] } }, "sortType": { "title": "Sort order", "enum": [ "6", "1", "2", "10" ], "type": "string", "description": "How Rightmove sorts the results before they are collected.", "default": "6" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings. The default (datacenter) usually works for Rightmove; the Actor switches to a UK residential proxy by itself if it gets blocked.", "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 } } } } } } } } } }