{ "openapi": "3.0.1", "info": { "title": "Rightmove Scraper", "description": "Scrape Rightmove.co.uk UK property data — listings, full property details, branches (estate agents), Land Registry sold-price history, postcode to address lookup, and search-box autocomplete. Search by location, postcode, lat/lng radius, or paste-a-URL.", "version": "1.0", "x-build-id": "23HuhXL0qaVfRykAh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/one-api~rightmove-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-one-api-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/one-api~rightmove-scraper/runs": { "post": { "operationId": "runs-sync-one-api-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/one-api~rightmove-scraper/run-sync": { "post": { "operationId": "run-sync-one-api-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": { "property_inputs": { "title": "Property ID, Rightmove URL, or full Address (one per line)", "type": "array", "description": "Auto-detects each entry: digits → property_id, http(s) URL → listing URL, anything else → address. Each row = 1 property detail call.", "items": { "type": "string" } }, "search_inputs": { "title": "Location, postcode, lat/lng radius, or Rightmove search URL (one per line)", "type": "array", "description": "Auto-detects each entry. Examples:\n• `London` (location)\n• `SW1A 1AA` or `SW1A` (UK postcode / outcode)\n• `51.5074,-0.1278,3` (lat,lng,radius_miles)\n• `https://www.rightmove.co.uk/property-for-sale/find.html?locationIdentifier=REGION%5E87490` (search URL)\n\nFilters below apply to every search. Each LISTING is pushed as one dataset item.", "items": { "type": "string" } }, "searchType": { "title": "Search Type", "enum": [ "BUY", "RENT" ], "type": "string", "description": "BUY (default) or RENT. RENT returns lettings with `monthlyRent` populated; price ranges are interpreted as £/month.", "default": "BUY" }, "propertyType": { "title": "Property Type", "type": "string", "description": "Comma-separated. Leave empty for all. Allowed: house, detached, semi_detached, terraced, flat, bungalow, commercial, land, park_home, student_halls, other. Example: `detached,flat`.", "default": "" }, "priceRange": { "title": "Price Range (£)", "type": "string", "description": "`min:500000`, `max:1500000`, or `min:500000,max:1500000`. For RENT channel, values are £/month.", "default": "" }, "bedroomsRange": { "title": "Bedrooms Range", "type": "string", "description": "Examples: `min:2`, `max:4`, `min:2,max:4`.", "default": "" }, "bathroomsRange": { "title": "Bathrooms Range", "type": "string", "description": "Examples: `min:1`, `max:3`, `min:1,max:3`.", "default": "" }, "radius": { "title": "Search Radius (miles)", "type": "string", "description": "Radius in miles around the resolved location centre (0-40). Default empty = region only. Used by bylocation / byzip searches.", "default": "" }, "sortOrder": { "title": "Sort Order", "enum": [ "highest_price", "lowest_price", "newest", "oldest", "distance" ], "type": "string", "description": "How to sort search results.", "default": "newest" }, "pages": { "title": "Pages to fetch per query", "minimum": 1, "maximum": 50, "type": "integer", "description": "1-based. Each page = up to `Result Count` listings.", "default": 1 }, "resultCount": { "title": "Results per page", "minimum": 1, "maximum": 40, "type": "integer", "description": "Min 1, Max 40 (Rightmove server cap). Default 25.", "default": 25 }, "mustHave": { "title": "Must Have", "type": "string", "description": "Comma-separated characteristics listings must have. Accepted: garden, parking, new_home, retirement, house_share, shared_ownership, auction, student. Example: `garden,parking`.", "default": "" }, "dontShow": { "title": "Don't Show", "type": "string", "description": "Comma-separated characteristics to exclude. Same vocabulary as Must Have. Example: `retirement,shared_ownership`.", "default": "" }, "furnishType": { "title": "Furnish Type (RENT only)", "type": "string", "description": "Comma-separated. Accepted: furnished, part_furnished, unfurnished.", "default": "" }, "letType": { "title": "Let Type (RENT only)", "enum": [ "", "long_term", "short_term", "student" ], "type": "string", "description": "Letting term.", "default": "" }, "keywords": { "title": "Keywords", "type": "string", "description": "Free-text keyword search over the listing description. Comma-separate multiple. Examples: `garden`, `loft conversion,balcony`, `period property`.", "default": "" }, "daysSinceAdded": { "title": "Days Since Added", "enum": [ "", "1", "3", "7", "14" ], "type": "string", "description": "Restrict to listings added in the last N days. Common values: 1, 3, 7, 14.", "default": "" }, "includeUnavailable": { "title": "Include Unavailable", "type": "boolean", "description": "Include sold / let-agreed / unavailable listings.", "default": false }, "autocomplete_inputs": { "title": "Autocomplete query (one per line)", "type": "array", "description": "Rightmove search-box typeahead. Returns region / outcode / station suggestions for each query, each with a `locationIdentifier` ready to feed into a search URL.", "items": { "type": "string" } }, "sold_price_inputs": { "title": "Sold-price query — location, postcode, or outcode (one per line)", "type": "array", "description": "UK sold-price history via Land Registry. Examples: `London`, `SW1A`, `Manchester`. Filters below (sold-price filters section) apply to all queries.", "items": { "type": "string" } }, "soldPriceType": { "title": "Sold Property Type", "enum": [ "", "detached", "semi_detached", "terraced", "flat", "other" ], "type": "string", "description": "Filter sold-price results to a single property type.", "default": "" }, "soldTenure": { "title": "Sold Tenure", "enum": [ "", "FREEHOLD", "LEASEHOLD" ], "type": "string", "description": "Freehold or Leasehold sales.", "default": "" }, "soldIn": { "title": "Sold In (last N years)", "minimum": 0, "maximum": 50, "type": "integer", "description": "Last N years to include (1, 3, 5).", "default": 0 }, "branch_inputs": { "title": "Branch ID (one per line)", "type": "array", "description": "Rightmove branch (estate agent) numeric id. Source from `branch.id` on any /search or /details result. Returns branch name, address, telephone, opening hours, logo URLs, lettings/sale counts.", "items": { "type": "string" } }, "postcode_inputs": { "title": "UK Postcode (one per line)", "type": "array", "description": "Returns the list of full UK addresses (with internal `id`) for each postcode. Useful for address-level resolution before a /details/* call.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }