{ "openapi": "3.0.1", "info": { "title": "Rightmove UK Real Estate Scraper", "description": "Scrape Rightmove property listings — id, address, price (numeric+formatted), bedrooms, bathrooms, property type, sale or rent, agent, branch, photos, location coordinates, listing URL, date added or reduced. UK property investors, comparables analysts, lettings agencies, mortgage brokers.", "version": "0.0", "x-build-id": "Jb8gyEs1GJbTQy0LD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgendata~rightmove-uk-real-estate-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgendata-rightmove-uk-real-estate-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/nexgendata~rightmove-uk-real-estate-scraper/runs": { "post": { "operationId": "runs-sync-nexgendata-rightmove-uk-real-estate-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/nexgendata~rightmove-uk-real-estate-scraper/run-sync": { "post": { "operationId": "run-sync-nexgendata-rightmove-uk-real-estate-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": { "searchUrl": { "title": "Pre-built Rightmove search URL (optional)", "type": "string", "description": "If you already have a Rightmove search you've configured in the browser, paste the URL here. The actor will paginate through it. If supplied, the location/searchType/radius/bedrooms_min/price_max fields are ignored." }, "location": { "title": "Location (free text)", "type": "string", "description": "City, neighbourhood, postcode, or region — anything Rightmove's typeahead understands (e.g. 'London', 'Manchester', 'SW11', 'Edinburgh'). Used only when `searchUrl` is empty." }, "searchType": { "title": "Sale or Rent", "enum": [ "sale", "rent" ], "type": "string", "description": "Either 'sale' (property-for-sale) or 'rent' (property-to-rent). Default: sale.", "default": "sale" }, "radius": { "title": "Search radius (miles)", "type": "string", "description": "Radius in miles around the resolved location (0.0 = within the region only; 0.25, 0.5, 1.0, 3.0, 5.0, 10.0, 15.0, 20.0, 30.0, 40.0 are accepted by Rightmove)." }, "bedrooms_min": { "title": "Minimum bedrooms (optional)", "minimum": 0, "maximum": 10, "type": "integer", "description": "Restrict to listings with at least this many bedrooms. Leave blank for any." }, "price_max": { "title": "Maximum price (GBP, optional)", "minimum": 0, "type": "integer", "description": "Cap the price (sale) or monthly rent (rent). Set to 0 or leave blank for no cap." }, "maxResults": { "title": "Max listings", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of listings to return (1–1000). Rightmove paginates 24 per page.", "default": 50 }, "useResidentialProxy": { "title": "Use Apify residential proxy", "type": "boolean", "description": "Recommended. Routes requests through Apify's GB residential proxy to avoid datacenter-IP blocks at Rightmove's CDN. Uncheck only if you've already verified the actor reaches Rightmove from Apify datacenter IPs.", "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 } } }, "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 } } } } } } } } } }