{
"openapi": "3.0.1",
"info": {
"title": "Rightmove Scraper",
"description": "Scrape Rightmove properties for sale or to rent anywhere in the UK: price, bedrooms, address, coordinates, agent and phone, photos, key features, date added. Description, tenure, council tax, floorplans and stations free. Export JSON/CSV/Excel, use the API, schedule it or connect n8n or Zapier.",
"version": "0.1",
"x-build-id": "W656VmjwUHfCyY9kH"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/lergassy~rightmove-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-lergassy-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/lergassy~rightmove-scraper/runs": {
"post": {
"operationId": "runs-sync-lergassy-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/lergassy~rightmove-scraper/run-sync": {
"post": {
"operationId": "run-sync-lergassy-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": "Give this or startUrls. One UK place per line, typed the way you would type it in Rightmove's search box: a town or city (Manchester), an area (Clapham, South West London), a postcode (SW1A 1AA), a postcode district (M1) or a station (Cambridge Station). All places are searched in one run.",
"items": {
"type": "string"
}
},
"listingType": {
"title": "๐ For sale or to rent",
"enum": [
"forSale",
"forRent"
],
"type": "string",
"description": "Search properties for sale, or properties to rent (monthly or weekly rent).",
"default": "forSale"
},
"maxItems": {
"title": "๐ฏ Max properties in total",
"minimum": 1,
"type": "integer",
"description": "Stop after this many properties across all locations. Rightmove itself shows at most 1,008 properties per search; ask for more and the Actor splits a big search by price range by itself. With several locations the limit is shared fairly.",
"default": 1000
},
"includeDetails": {
"title": "๐ Add property page details (free)",
"type": "boolean",
"description": "Also open every property's own page and add its full description, full postcode, tenure and lease years left, council tax band, service charge and ground rent, size in sq ft / sq m, floorplans, EPC graph, brochures, nearest stations, rooms, utilities and (for rentals) deposit, furnishing and minimum term. No extra charge; the run is slower (one more page per property).",
"default": false
},
"minPrice": {
"title": "Min price (ยฃ)",
"minimum": 0,
"type": "integer",
"description": "Only properties priced at least this much in pounds โ the asking price for sale, the monthly rent (pcm) to rent."
},
"maxPrice": {
"title": "Max price (ยฃ)",
"minimum": 0,
"type": "integer",
"description": "Only properties priced at most this much in pounds (monthly rent to rent)."
},
"minBedrooms": {
"title": "Min bedrooms",
"minimum": 0,
"maximum": 10,
"type": "integer",
"description": "At least this many bedrooms (0 = studio, up to 10)."
},
"maxBedrooms": {
"title": "Max bedrooms",
"minimum": 0,
"maximum": 10,
"type": "integer",
"description": "At most this many bedrooms (0 = studios only, up to 10)."
},
"propertyTypes": {
"title": "Property types",
"type": "array",
"description": "Only these kinds of property โ Rightmove's own groups. Leave empty for all.",
"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",
"Student halls (to rent)"
]
}
},
"radiusMiles": {
"title": "Search radius (miles)",
"minimum": 0,
"maximum": 40,
"type": "number",
"description": "Also include properties up to this many miles around the place. Rightmove's choices are 0.25, 0.5, 1, 3, 5, 10, 15, 20, 30 and 40 โ another number is rounded to the nearest. Empty or 0 = this area only."
},
"addedWithinDays": {
"title": "Added in the last N days",
"minimum": 1,
"maximum": 14,
"type": "integer",
"description": "Only properties added โ or reduced in price โ on Rightmove in the last N days (Rightmove's own \"Added to site\" filter). Rightmove's choices are 1, 3, 7 and 14 days โ another number is rounded up to the next one."
},
"includeSoldSTC": {
"title": "Include Sold STC / Under offer / Let agreed",
"type": "boolean",
"description": "Rightmove hides properties already sold subject to contract or under offer (for sale) and let agreed (to rent) by default. Switch on to include them too โ their status is in the status field.",
"default": false
},
"mustHave": {
"title": "Must have",
"type": "array",
"description": "Only properties with all of these, as Rightmove tags them.",
"items": {
"type": "string",
"enum": [
"garden",
"parking",
"newHome",
"retirement",
"sharedOwnership",
"auction",
"student",
"houseShare"
],
"enumTitles": [
"Garden",
"Parking",
"New home",
"Retirement home",
"Shared ownership",
"Auction",
"Student (to rent)",
"House share (to rent)"
]
}
},
"dontShow": {
"title": "Don't show",
"type": "array",
"description": "Leave out properties of these kinds.",
"items": {
"type": "string",
"enum": [
"newHome",
"retirement",
"sharedOwnership",
"auction",
"student",
"houseShare"
],
"enumTitles": [
"New homes",
"Retirement homes",
"Shared ownership",
"Auctions",
"Student lets (to rent)",
"House shares (to rent)"
]
}
},
"furnishTypes": {
"title": "Furnishing (to rent)",
"type": "array",
"description": "To rent only: furnished, part furnished or unfurnished. Leave empty for all.",
"items": {
"type": "string",
"enum": [
"furnished",
"partFurnished",
"unfurnished"
],
"enumTitles": [
"Furnished",
"Part furnished",
"Unfurnished"
]
}
},
"sort": {
"title": "Sort by",
"enum": [
"newest",
"priceDesc",
"priceAsc",
"oldest"
],
"type": "string",
"description": "Order in which Rightmove returns properties โ matters when you take fewer than all of them. \"Newest\" is Rightmove's \"Newest listed\" (recently added or reduced first).",
"default": "newest"
},
"startUrls": {
"title": "๐ Rightmove URLs",
"type": "array",
"description": "Give this or locations. Paste Rightmove pages exactly as you set them up in the browser: a search with its filters (https://www.rightmove.co.uk/property-for-sale/find.html?locationIdentifier=REGION%5E904&minBedrooms=2), a to-rent search, a page like โฆ/property-for-sale/London-87490/2-bed-houses.html, or single property pages (https://www.rightmove.co.uk/properties/94402467). Filters in the address win over the fields above.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"onlyNewRowsStore": {
"title": "๐ Only new properties โ memory name",
"pattern": "^[A-Za-z0-9-]{0,63}$",
"type": "string",
"description": "Give this run a name โ my-manchester-watch โ and the Actor remembers every property it delivered under that name. Every later run with the same name writes and charges only properties you have not received before. Schedule the Actor daily to get a feed of new listings. Leave empty to get everything found, every time."
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Not needed: the Actor reaches Rightmove directly and switches to a residential proxy, then to an unblocker, by itself only for search pages that get blocked. Set your own proxy only if you must โ then it is used for every request."
},
"includeRunSummary": {
"title": "๐งพ Add a free summary row at the end of the run",
"type": "boolean",
"description": "One extra free row at the end with the run's totals: rows delivered, free rows, what was charged and how much in US dollars. It carries type \"notice\", so a filter on the data rows skips it. Switch off if your pipeline cannot tolerate an extra row.",
"default": 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
}
}
}
}
}
}
}
}
}
}