{ "openapi": "3.0.1", "info": { "title": "Rightmove Scraper: UK Property for Sale & Rent", "description": "UK property from Rightmove for any town, area or search URL: price, beds, baths, type, size, address, GPS, agent and phone, key features, listing dates. Optional full description, postcode, tenure and lease, service charge, council tax, stations. Past the 1,000 cap. $0.001 per property.", "version": "0.1", "x-build-id": "I1ctlC5ymYY98wcBh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapemint~rightmove-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapemint-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/scrapemint~rightmove-scraper/runs": { "post": { "operationId": "runs-sync-scrapemint-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/scrapemint~rightmove-scraper/run-sync": { "post": { "operationId": "run-sync-scrapemint-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": "One search per town, city, area or postcode district, e.g. Manchester, Clapham, Bristol, SW11, Cornwall. Matched with Rightmove's own place search.", "default": [], "items": { "type": "string" } }, "operation": { "title": "Buy or rent", "enum": [ "buy", "rent" ], "type": "string", "description": "Property for sale or to rent.", "default": "buy" }, "searchUrls": { "title": "Or Rightmove search URLs", "type": "array", "description": "Search pages copied from rightmove.co.uk with your area and filters set (drawn areas, keywords, any filter). Filters below do not apply to these.", "default": [], "items": { "type": "string" } }, "radiusMiles": { "title": "Radius (miles)", "enum": [ "", "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": "" }, "minPrice": { "title": "Minimum price (£)", "minimum": 0, "type": "integer", "description": "Optional. For rent this is per calendar month." }, "maxPrice": { "title": "Maximum price (£)", "minimum": 0, "type": "integer", "description": "Optional. For rent this is per calendar month." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Optional." }, "maxBedrooms": { "title": "Maximum bedrooms", "minimum": 0, "type": "integer", "description": "Optional." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Any of: detached, semi-detached, terraced, flat, bungalow, land, park-home. Empty keeps all.", "default": [], "items": { "type": "string" } }, "mustHave": { "title": "Must have", "type": "array", "description": "Any of: garden, parking, newHome, retirement, sharedOwnership, auction.", "default": [], "items": { "type": "string" } }, "addedWithinDays": { "title": "Added to site within", "enum": [ "", "1", "3", "7", "14" ], "type": "string", "description": "Only properties added in this window. Last 24 hours on a daily schedule collects new listings.", "default": "" }, "includeUnderOffer": { "title": "Include under offer / let agreed", "type": "boolean", "description": "Also include properties that are sold subject to contract, under offer or let agreed.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "newest", "price_asc", "price_desc", "oldest" ], "type": "string", "description": "Order of results.", "default": "newest" }, "includeDetails": { "title": "Full description and property details", "type": "boolean", "description": "Reads each property page for the full description, floor area, full postcode, tenure and lease length, service charge, ground rent, council tax band, nearest stations, parking, garden, heating, floorplans and EPC. Costs $0.003 per property instead of $0.001.", "default": false }, "maxItemsPerSearch": { "title": "Max properties per search", "minimum": 1, "type": "integer", "description": "Stop each search after this many properties. Rightmove shows about 1,000 per search; bigger searches are split by price automatically.", "default": 300 } } }, "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 } } } } } } } } } }