{ "openapi": "3.0.1", "info": { "title": "Rightmove Properties Scraper", "description": "Rightmove Properties Scraper SD - Rightmove Properties Scraper is a UK real estate data tool that extracts rightmove.co.uk properties for sale or to rent by place, postcode or search URL: price, address, beds, baths, size, tenure, agent, photos, plus optional full details and sale history.", "version": "1.0", "x-build-id": "Tb0o1zNY3DlVTkInJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neuro-scraper~rightmove-properties-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neuro-scraper-rightmove-properties-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/neuro-scraper~rightmove-properties-scraper/runs": { "post": { "operationId": "runs-sync-neuro-scraper-rightmove-properties-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/neuro-scraper~rightmove-properties-scraper/run-sync": { "post": { "operationId": "run-sync-neuro-scraper-rightmove-properties-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": { "searchLocation": { "title": "Search location", "type": "array", "description": "One per line: a town, area, outcode or postcode as you would type it on rightmove.co.uk (Manchester, Islington, SW1A, SW1A 1AA), or a Rightmove location identifier (REGION^904). The first match of Rightmove's own location search is used.", "items": { "type": "string" } }, "startUrls": { "title": "Rightmove URLs", "type": "array", "description": "Search URLs copied from rightmove.co.uk with your filters (https://www.rightmove.co.uk/property-to-rent/find.html?locationIdentifier=REGION%5E904&maxPrice=1500) or property URLs (https://www.rightmove.co.uk/properties/171634895). A search URL keeps its own filters; the filter fields below apply to Search location only.", "items": { "type": "string" } }, "channel": { "title": "For sale or to rent", "enum": [ "BUY", "RENT", "COMMERCIAL_BUY", "COMMERCIAL_RENT" ], "type": "string", "description": "Which Rightmove search to run for the locations above (residential or commercial).", "default": "BUY" }, "sortType": { "title": "Sort by", "enum": [ "6", "1", "2", "10" ], "type": "string", "description": "Rightmove's own sort order.", "default": "6" }, "radius": { "title": "Search 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": "Include properties within this distance of the location.", "default": "0.0" }, "minPrice": { "title": "Minimum price (GBP)", "minimum": 0, "type": "integer", "description": "Purchase price, or rent per month for To rent. 0 = no minimum.", "default": 0 }, "maxPrice": { "title": "Maximum price (GBP)", "minimum": 0, "type": "integer", "description": "0 = no maximum.", "default": 0 }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "0 = any (0 also includes studios).", "default": 0 }, "maxBedrooms": { "title": "Maximum bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "0 = no maximum.", "default": 0 }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Leave empty for all types.", "items": { "type": "string", "enum": [ "detached", "semi-detached", "terraced", "flat", "bungalow", "land", "park-home" ], "enumTitles": [ "Detached", "Semi-detached", "Terraced", "Flat / apartment", "Bungalow", "Land", "Park home" ] }, "default": [] }, "mustHave": { "title": "Must have", "type": "array", "description": "Only properties with all of these.", "items": { "type": "string", "enum": [ "garden", "parking", "newHome", "retirement", "sharedOwnership", "auction" ], "enumTitles": [ "Garden", "Parking", "New home", "Retirement home", "Shared ownership", "Auction" ] }, "default": [] }, "dontShow": { "title": "Don't show", "type": "array", "description": "Hide these kinds of listing.", "items": { "type": "string", "enum": [ "newHome", "retirement", "sharedOwnership", "auction", "houseShare", "student" ], "enumTitles": [ "New homes", "Retirement homes", "Shared ownership", "Auctions", "House shares (rent)", "Student halls (rent)" ] }, "default": [] }, "furnishTypes": { "title": "Furnishing (to rent)", "type": "array", "description": "Rentals only. Leave empty for any.", "items": { "type": "string", "enum": [ "furnished", "partFurnished", "unfurnished" ], "enumTitles": [ "Furnished", "Part furnished", "Unfurnished" ] }, "default": [] }, "keywords": { "title": "Keywords", "type": "string", "description": "Rightmove's keyword filter, comma separated (e.g. garage, conservatory).", "default": "" }, "maxDaysSinceAdded": { "title": "Added to site", "enum": [ "", "1", "3", "7", "14" ], "type": "string", "description": "Only listings added in this period.", "default": "" }, "includeSSTC": { "title": "Include sold STC / let agreed", "type": "boolean", "description": "Also return properties marked Sold STC / Under offer (for sale) or Let agreed (to rent).", "default": false }, "maxItems": { "title": "Max properties", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stops after this many properties in total. Rightmove shows 24 per page and about 1,000 per search; with 'Split large searches' on, bigger searches are split into price bands to go deeper.", "default": 50 }, "maxPages": { "title": "Max pages per search", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Result pages (24 properties each) per search; 0 = no page limit (Max properties still applies).", "default": 0 }, "splitPriceBands": { "title": "Split large searches by price", "type": "boolean", "description": "When a search has more than ~1,000 results and you want more, run it again in price bands (each under 1,000 results) and remove duplicates. Properties without a price (POA) are not in any band.", "default": true }, "fetchFullDetails": { "title": "Fetch full details", "type": "boolean", "description": "Opens every property page for the full description, council tax band, postcode, size in sq ft / sq m, all photos, floorplans, EPC graphs, brochures, nearest stations, lease / ground rent / service charge and the letting details. One extra request per property.", "default": false }, "includeSaleHistory": { "title": "Include property sale history", "type": "boolean", "description": "Adds the property's past sale prices (Land Registry: year, price, change) as saleHistory. Turns on full details. Two extra requests per property.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential UK proxies (the default) are recommended - Rightmove's web pages sometimes answer a bot check.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "GB" } } } }, "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 } } } } } } } } } }