{ "openapi": "3.0.1", "info": { "title": "Rightmove Property Scraper — UK Sale & Rent Listings", "description": "Rightmove property listings for AI agents and analysts: any UK location (town, outcode, postcode, station), for sale / to rent / new homes / commercial, with all site filters, exact listing timestamps, price per sq ft, agent & phone, optional full property pages. Location lookup built in.", "version": "0.1", "x-build-id": "xoaQbNNAQBexaLHo9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yadroo~rightmove-uk/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yadroo-rightmove-uk", "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/yadroo~rightmove-uk/runs": { "post": { "operationId": "runs-sync-yadroo-rightmove-uk", "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/yadroo~rightmove-uk/run-sync": { "post": { "operationId": "run-sync-yadroo-rightmove-uk", "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": { "location": { "title": "Location", "type": "string", "description": "Town, area, outcode or station as you would type it on rightmove.co.uk: \"Manchester\", \"Leeds LS1\", \"SW1A\", \"Clapham Junction\". The first match is used (see locationType / mode \"locations\")." }, "locationIdentifier": { "title": "Location identifier (advanced)", "type": "string", "description": "Exact Rightmove identifier, e.g. REGION^904 (Manchester), OUTCODE^2506 (SW1A), POSTCODE^123456, STATION^5462 (Leeds Station), STREET^. Overrides location. Find it with mode \"locations\" or in the site URL (locationIdentifier=...)." }, "locationType": { "title": "Preferred location type", "enum": [ "REGION", "OUTCODE", "POSTCODE", "STATION", "STREET" ], "type": "string", "description": "When the free-text location has several matches, prefer this type (e.g. OUTCODE for \"M3\", STATION for \"Leeds\"). Without it the first non-street match is used." }, "mode": { "title": "Mode", "enum": [ "search", "locations" ], "type": "string", "description": "\"locations\" returns the typeahead candidates for the text in \"location\" (type, id, displayName, locationIdentifier) without searching; when nothing matches, the run ends with a status that says so and saves no rows.", "default": "search" }, "channel": { "title": "Channel", "enum": [ "buy", "rent", "new-homes", "commercial-buy", "commercial-rent" ], "type": "string", "description": "Which Rightmove search to run.", "default": "buy" }, "minPrice": { "title": "Min price (£)", "minimum": 0, "type": "integer", "description": "Sale price, or monthly rent (pcm) for rentals." }, "maxPrice": { "title": "Max price (£)", "minimum": 0, "type": "integer", "description": "Sale price, or monthly rent (pcm) for rentals." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "0 = studio." }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum number of bedrooms (0 = studio). Ignored on commercial channels." }, "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": "Search radius around the location, in miles (the only values the site accepts). 0.0 = inside the area only.", "default": "0.0" }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Residential types (ignored on commercial channels). Empty = any.", "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 only)" ] } }, "mustHave": { "title": "Must have", "type": "array", "description": "Only properties with these features.", "items": { "type": "string", "enum": [ "garden", "parking", "newHome", "retirement", "sharedOwnership", "auction" ], "enumTitles": [ "Garden", "Parking / garage", "New home", "Retirement home", "Shared ownership", "Auction property" ] } }, "dontShow": { "title": "Don't show", "type": "array", "description": "Exclude these property kinds.", "items": { "type": "string", "enum": [ "newHome", "retirement", "sharedOwnership", "auction", "houseShare" ], "enumTitles": [ "New homes", "Retirement homes", "Shared ownership", "Auction properties", "House shares (rent only)" ] } }, "maxDaysSinceAdded": { "title": "Added to site within", "enum": [ "1", "3", "7", "14" ], "type": "string", "description": "Server-side recency filter (the only values the site accepts). For a finer cut-off use sinceHours." }, "furnishTypes": { "title": "Furnishing (rent)", "type": "array", "description": "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": "Rentals only." }, "includeSSTC": { "title": "Include Sold STC (sale)", "type": "boolean", "description": "Include properties already sold subject to contract / under offer (sales channels).", "default": false }, "includeLetAgreed": { "title": "Include Let Agreed (rent)", "type": "boolean", "description": "Include properties already let agreed (rental channels).", "default": false }, "keywords": { "title": "Keywords", "type": "array", "description": "Words that must appear in the listing, e.g. [\"garage\", \"annexe\"]. Rightmove marks matches in keywordMatchType.", "items": { "type": "string" } }, "sortType": { "title": "Sort", "enum": [ "6", "10", "1", "2" ], "type": "string", "description": "6 newest listed (best for monitoring), 10 oldest, 1 lowest price, 2 highest price.", "default": "6" }, "sinceHours": { "title": "Only listings newer than (hours)", "minimum": 1, "maximum": 720, "type": "integer", "description": "Client-side cut-off on firstVisibleDate (or listingUpdateDate with sinceField \"updated\"). Exact timestamps come with every list item — no detail needed. With sortType 6 the run stops as soon as older organic listings appear." }, "sinceField": { "title": "sinceHours applies to", "enum": [ "added", "updated" ], "type": "string", "description": "Which timestamp sinceHours compares against: \"added\" = firstVisibleDate (new listings), \"updated\" = listingUpdateDate (also catches price reductions and re-listings).", "default": "added" }, "detail": { "title": "Open each property page", "type": "boolean", "description": "Open every property page for the full description, key features, outcode/incode, size (sq ft / m²) and computed price per sq ft / m², tenure & lease years, council tax band, service charge, ground rent, deposit/furnishing (rent), nearest stations, floorplans, brochures, EPC and all photos. One request per property, 0.7 s apart (about 50 properties a minute); rows are saved every 10 properties. A property page that cannot be read keeps the list fields and gets detailError. On a 403 block or 3 failed pages in a row, property pages stop: the rest of the current results page is saved with list data only and detailError \"skipped: …\", no further pages are read, and the status says \"detail k/N\". Listings with 15-digit ids (most commercial ones) use a newer page that has no council tax, deposit, furnishing, agent company or feature lists: those fields stay empty there.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stop after this many properties (24 per results page plus the page's featured property; Rightmove serves at most ~1,000 results per search — narrow the filters for full coverage). Mode locations returns every match (at most 10).", "default": 40 }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 42, "type": "integer", "description": "Hard cap on result pages (24 listings plus one featured property each).", "default": 42 }, "fields": { "title": "Output fields", "type": "array", "description": "Keep only these top-level fields per item, in this order, e.g. [\"price\",\"bedrooms\",\"displayAddress\",\"url\"]. Every row keeps id (mode locations: locationIdentifier), and with detail: true also detailError when a property page was not read; they come first unless you list them. A different letter case or a near miss (\"bedroms\") is read as the output field and noted in the status; detail-only fields without detail: true and unknown names are ignored with a note; if no name is an output field the run fails and lists the valid names. Empty = all.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }