{ "openapi": "3.0.1", "info": { "title": "Rightmove Scraper — Price History, Agent Contacts & EPC", "description": "Scrape Rightmove UK largest property portal via Next.js JSON extraction. Buy, rent, sold, commercial & overseas listings with price history (reduced/new), agent phone, tenure, floorplans, EPC and full descriptions. Pure HTTP, no proxy or login needed.", "version": "0.1", "x-build-id": "OMJE4OLelMWyUvMIz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/haketa~rightmove-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-haketa-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/haketa~rightmove-scraper/runs": { "post": { "operationId": "runs-sync-haketa-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/haketa~rightmove-scraper/run-sync": { "post": { "operationId": "run-sync-haketa-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": { "channel": { "title": "What are you looking for?", "enum": [ "buy", "rent", "sold", "commercial", "overseas" ], "type": "string", "description": "Choose the type of listings to collect: properties for sale, to rent, sold price history, commercial, or overseas.", "default": "buy" }, "location": { "title": "Location", "enum": [ "mixed", "REGION^87490", "REGION^904", "REGION^162", "REGION^787", "REGION^813", "REGION^219", "REGION^475", "REGION^550", "REGION^1195", "REGION^1019", "REGION^281", "REGION^984", "REGION^93554", "REGION^1114", "REGION^274", "REGION^1036", "REGION^789", "REGION^368", "REGION^1231" ], "type": "string", "description": "Pick a UK city or region to search. Leave on \"Mixed sample\" to get a diverse selection of listings from several major cities.", "default": "mixed" }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Only include these property types. Leave empty to include every type.", "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": [] }, "dontShow": { "title": "Hide these listings", "type": "array", "description": "Exclude these categories from your results.", "items": { "type": "string", "enum": [ "newHome", "retirement", "sharedOwnership", "auction" ], "enumTitles": [ "New homes", "Retirement", "Shared ownership", "Auction" ] }, "default": [] }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms. Leave at 0 for any.", "default": 0 }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "type": "integer", "description": "Maximum number of bedrooms. Leave at 0 for any.", "default": 0 }, "minPrice": { "title": "Min price (£)", "minimum": 0, "type": "integer", "description": "Minimum price in GBP. Leave at 0 for any.", "default": 0 }, "maxPrice": { "title": "Max price (£)", "minimum": 0, "type": "integer", "description": "Maximum price in GBP. Leave at 0 for any.", "default": 0 }, "radius": { "title": "Search radius (miles)", "minimum": 0, "maximum": 40, "type": "number", "description": "How far around the chosen location to search. 0 = the location only. Common values: 1, 3, 5, 10, 20 miles.", "default": 0 }, "includeSold": { "title": "Include sold / under offer", "type": "boolean", "description": "Include SSTC (Sold Subject to Contract) and Under Offer listings alongside available ones.", "default": true }, "sortType": { "title": "Sort order", "enum": [ "2", "6", "10", "4", "1" ], "type": "string", "description": "How to order the results.", "default": "2" }, "includeDetails": { "title": "Include full property details", "type": "boolean", "description": "Visit each property page for the full description, key features, EPC rating, floorplans and the complete image gallery. Turn off for a faster, lighter run.", "default": true }, "maxItems": { "title": "Max properties", "minimum": 0, "type": "integer", "description": "Maximum number of properties to collect. Use 0 for no limit (Rightmove caps at ~1,050 results per search).", "default": 100 }, "maxPages": { "title": "Max result pages", "minimum": 0, "type": "integer", "description": "Maximum number of result pages to walk (about 24 properties per page). 0 = no limit.", "default": 0 }, "locationIdentifier": { "title": "Location identifier (advanced)", "type": "string", "description": "Advanced: paste a Rightmove location code (e.g. REGION^93917 or POSTCODE^1013367) to search a location not in the dropdown. Overrides the Location dropdown when set." }, "startUrls": { "title": "Start URLs (advanced)", "type": "array", "description": "Advanced: paste Rightmove search or property page URLs to scrape directly. When set, these take priority over the filters above.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy settings. Residential UK proxy is recommended for reliable results and is enabled by default. You can change the groups/country or turn it off here.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "GB" } }, "requestDelay": { "title": "Request delay (ms)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Pause between requests. Higher values are gentler on large runs.", "default": 300 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 25, "type": "integer", "description": "How many detail pages to fetch in parallel. 5-10 is a good balance.", "default": 10 } } }, "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 } } }, "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 } } } } } } } } } }