{ "openapi": "3.0.1", "info": { "title": "Rightmove Scraper — UK Property Listings & Prices API | $0.8/1k", "description": "Scrape Rightmove property listings for sale and to rent: price, address, postcode district, bedrooms, bathrooms, type, tenure, key features, dates, status, photos, map position and agent branch. Search by URL or by location. Export CSV or JSON.", "version": "0.1", "x-build-id": "4vJofannK1nvHI4Jf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/glasswing~rightmove-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-glasswing-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/glasswing~rightmove-scraper/runs": { "post": { "operationId": "runs-sync-glasswing-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/glasswing~rightmove-scraper/run-sync": { "post": { "operationId": "run-sync-glasswing-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": { "startUrls": { "title": "Rightmove search URLs", "type": "array", "description": "Search result pages copied from rightmove.co.uk (for sale, to rent or new homes), one per line. Every filter in the URL is kept: price, bedrooms, property type, radius, keywords, must-haves. The Actor follows the pages of each search. Leave the example here if you use Locations below; it is skipped automatically.", "default": [ "https://www.rightmove.co.uk/property-for-sale/find.html?searchType=SALE&locationIdentifier=REGION%5E904&sortType=6" ], "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Towns, cities, areas, postcodes or stations, one per line, e.g. \"Leeds\", \"Clapham\", \"SW1A\", \"M1 1AE\". Each one is looked up with Rightmove's own location search and searched with the filters below. A place Rightmove does not know gives one free not_found row.", "items": { "type": "string" } }, "listingType": { "title": "Buy or rent", "enum": [ "sale", "rent" ], "type": "string", "description": "Search homes for sale or to rent. Applies to Locations. Default: for sale." }, "minPrice": { "title": "Minimum price (£)", "minimum": 0, "type": "integer", "description": "Lowest asking price in GBP, e.g. `200000` for £200,000. For rentals this is the monthly rent in pounds, e.g. `1000` for £1,000 pcm." }, "maxPrice": { "title": "Maximum price (£)", "minimum": 0, "type": "integer", "description": "Highest asking price in GBP, e.g. `500000` for £500,000. For rentals this is the monthly rent in pounds, e.g. `2000` for £2,000 pcm." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "At least this many bedrooms, e.g. `2` (range 0-10; 0 = studio)." }, "maxBedrooms": { "title": "Maximum bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "At most this many bedrooms, e.g. `4` (range 0-10; 0 = studios only)." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Only these property types, e.g. `flat`, `terraced`. Leave empty for all.", "items": { "type": "string", "enum": [ "detached", "semi-detached", "terraced", "flat", "bungalow", "land", "park-home" ], "enumTitles": [ "Detached", "Semi-detached", "Terraced", "Flat / apartment", "Bungalow", "Land", "Park home" ] } }, "radius": { "title": "Search radius (miles)", "minimum": 0, "maximum": 40, "type": "number", "description": "Also include listings this many miles around the location. Rightmove's steps are 0.25, 0.5, 1, 3, 5, 10, 15, 20, 30 and 40; other values snap to the nearest step. Default: this area only." }, "maxDaysSinceAdded": { "title": "Added in the last (days)", "minimum": 1, "maximum": 14, "type": "integer", "description": "Only listings added to Rightmove in the last 1, 3, 7 or 14 days (other values round up to the next step). Leave empty for any time." }, "includeUnavailable": { "title": "Include Sold STC / Let agreed", "type": "boolean", "description": "Also return listings that are Sold STC (for sale) or Let agreed (to rent). Under offer listings are always included, as on the website." }, "sort": { "title": "Sort by", "enum": [ "newest", "oldest", "price_high", "price_low" ], "type": "string", "description": "Order of the results. Default: newest listed first." }, "maxItems": { "title": "Maximum results", "minimum": 1, "type": "integer", "description": "Stop after this many rows in total. Each saved listing (status ok) is one billable result. One search returns at most about 1,000 listings (Rightmove shows 42 pages); split big areas by price or bedrooms to get more.", "default": 20 }, "maxItemsPerSearch": { "title": "Maximum results per search", "minimum": 1, "type": "integer", "description": "Optional cap for each search URL or location, so one big city cannot use up Maximum results before the next location runs." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. The Actor is HTTP-only and works without a proxy. Apify Proxy (datacenter) can be switched on if you run very large jobs; residential proxies are not needed.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }