{ "openapi": "3.0.1", "info": { "title": "Rightmove UK Property & London Real Estate Scraper API (MCP)", "description": "Rightmove scraper & data API: UK real estate — property for sale & to rent in London and nationwide, houses & apartments. Price with Rightmove's own new / reduced flag, bedrooms, GPS, photos + agent phone. Beats the 1 008-result cap. Monitor mode = only new, price-changed & sold listings.", "version": "0.0", "x-build-id": "wcSCIX6zWxUefwBVv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/amygraphics~rightmove-uk-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-amygraphics-rightmove-uk-property-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/amygraphics~rightmove-uk-property-scraper/runs": { "post": { "operationId": "runs-sync-amygraphics-rightmove-uk-property-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/amygraphics~rightmove-uk-property-scraper/run-sync": { "post": { "operationId": "run-sync-amygraphics-rightmove-uk-property-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": "Mode", "enum": [ "search", "monitor" ], "type": "string", "description": "search = return every matching property. monitor = compare with the previous run (Apify key-value store) and return only what is new, changed (price cut included) or gone — ideal for a daily schedule.", "default": "search" }, "channel": { "title": "Market", "enum": [ "buy", "rent", "new-homes" ], "type": "string", "description": "For sale, to rent, or new homes for sale.", "default": "buy" }, "locations": { "title": "Locations (names as Rightmove uses them)", "type": "array", "description": "One location per item: a city or area name (London, Manchester, Birmingham), a postcode district (SW1W, EH1, M20) or a Rightmove identifier (REGION^87490). Spaces are allowed. Leave empty to use the default UK search or your own search URLs.", "items": { "type": "string" }, "default": [] }, "searchUrls": { "title": "Rightmove search URLs (optional, advanced)", "type": "array", "description": "Paste full rightmove.co.uk search URLs (with filters, maps or estate-agent searches). The Actor scrapes them as-is and applies the same automatic splitting when the 1 008-result cap is hit.", "items": { "type": "string" }, "default": [] }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Leave empty for all types. Used both as a filter and as the second splitting dimension when a query is truncated.", "items": { "type": "string", "enum": [ "detached", "semi-detached", "terraced", "flat", "bungalow", "land", "park-home" ] }, "default": [] }, "minBedrooms": { "title": "Min bedrooms", "type": "integer", "description": "Optional. Minimum number of bedrooms.", "default": null }, "maxBedrooms": { "title": "Max bedrooms", "type": "integer", "description": "Optional. Maximum number of bedrooms.", "default": null }, "minPrice": { "title": "Min price (£)", "type": "integer", "description": "Optional. Minimum asking price (or rent per month).", "default": null }, "maxPrice": { "title": "Max price (£)", "type": "integer", "description": "Optional. Maximum asking price (or rent per month).", "default": null }, "radius": { "title": "Radius around the location (miles)", "type": "string", "description": "Optional. Works with postcodes and area names: 0.0 = exact, 0.25, 0.5, 1.0, 3.0, 5.0, 10.0, 15.0, 20.0, 30.0, 40.0.", "default": "" }, "addedWithinDays": { "title": "Added within (days)", "type": "integer", "description": "Optional. Only listings first advertised in the last N days (Rightmove supports 1, 3, 7, 14). Great for a lightweight daily watch.", "default": null }, "sortType": { "title": "Sort order", "type": "integer", "description": "Rightmove sort code. 6 = newest first (recommended, used by default). 1 = price high→low, 2 = price low→high, 4 = most reduced, 5 = oldest first.", "default": 6 }, "autoSplit": { "title": "Auto-split when Rightmove truncates a search", "type": "boolean", "description": "Recommended. Rightmove cuts every search at 1 008 results; the Actor splits such queries by price band → property type → bedrooms so a city-wide scan is complete.", "default": true }, "maxResults": { "title": "Max properties to return", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Global cap on rows returned (and charged).", "default": 200 }, "fetchDetails": { "title": "Fetch detail pages (EPC image + floorplans)", "type": "boolean", "description": "Adds each property's EPC certificate image URL and its floorplan image URLs. Everything else (agency phone, price, features, coordinates) already comes from the search payload without extra requests.", "default": false }, "includeImages": { "title": "Include property image URLs", "type": "boolean", "description": "Adds up to 20 high-resolution photo URLs per property.", "default": true }, "onlyChanges": { "title": "Monitor: keep unchanged properties out of the output", "type": "boolean", "description": "Monitor mode only. Unchanged properties are not returned and not charged.", "default": true }, "detectClosed": { "title": "Monitor: detect removed / sold-STC properties", "type": "boolean", "description": "Monitor mode only. Properties that disappeared from the portal are returned once with changeType='closed', then forgotten. Runs only when the scan was complete and error-free (never guesses).", "default": true }, "stateKey": { "title": "Monitor state key (advanced)", "type": "string", "description": "Leave empty: the key is derived from your search scope, so each different search keeps its own history.", "default": "" } } }, "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 } } } } } } } } } }