{ "openapi": "3.0.1", "info": { "title": "Rightmove Properties Discovery By Location", "description": "This actor collects detailed properties information from Rightmove UK by location. It collects comprehensive data including properties details, prices, bedrooms, bathrooms, state agent contact and more. This actor is for buy properties.", "version": "0.1", "x-build-id": "k3ndepvWbdKFd7pew" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datacach~rightmove-properties-discovery-by-location/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datacach-rightmove-properties-discovery-by-location", "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/datacach~rightmove-properties-discovery-by-location/runs": { "post": { "operationId": "runs-sync-datacach-rightmove-properties-discovery-by-location", "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/datacach~rightmove-properties-discovery-by-location/run-sync": { "post": { "operationId": "run-sync-datacach-rightmove-properties-discovery-by-location", "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": { "location": { "title": "🔍 Location (City, Postcode or Area)", "type": "string", "description": "The location to search for properties. Please do not use full address, only use city name or postcode or area name", "default": "London" }, "flats_and_apartments": { "title": "Flats and Apartments", "type": "boolean", "description": "If checked then flats and apartments will be included in the search.", "default": false }, "bungalows": { "title": "Bungalows", "type": "boolean", "description": "If checked then bungalows will be included in the search.", "default": false }, "detached_houses": { "title": "Detached Houses", "type": "boolean", "description": "If checked then detached houses will be included in the search.", "default": false }, "semi_detached_houses": { "title": "Semi-Detached Houses", "type": "boolean", "description": "If checked then semi-detached houses will be included in the search.", "default": false }, "terraced_houses": { "title": "Terraced Houses", "type": "boolean", "description": "If checked then terraced houses will be included in the search.", "default": false }, "lands": { "title": "Lands", "type": "boolean", "description": "If checked then lands will be included in the search.", "default": false }, "park_homes": { "title": "Park Homes", "type": "boolean", "description": "If checked then park homes will be included in the search.", "default": false }, "min_price": { "title": "💰 Min Price", "enum": [ "0", "50000", "60000", "70000", "80000", "90000", "100000", "110000", "120000", "125000", "130000", "140000", "150000", "160000", "170000", "175000", "180000", "190000", "200000", "210000", "220000", "230000", "240000", "250000", "260000", "270000", "280000", "290000", "300000", "325000", "350000", "375000", "400000", "425000", "450000", "475000", "500000", "550000", "600000", "650000", "700000", "800000", "900000", "1000000", "1250000", "1500000", "1750000", "2000000", "2500000", "3000000", "4000000", "5000000", "7500000", "10000000", "15000000", "20000000" ], "type": "string", "description": "The minimum price to search for properties." }, "max_price": { "title": "💰 Max Price", "enum": [ "0", "50000", "60000", "70000", "80000", "90000", "100000", "110000", "120000", "125000", "130000", "140000", "150000", "160000", "170000", "175000", "180000", "190000", "200000", "210000", "220000", "230000", "240000", "250000", "260000", "270000", "280000", "290000", "300000", "325000", "350000", "375000", "400000", "425000", "450000", "475000", "500000", "550000", "600000", "650000", "700000", "800000", "900000", "1000000", "1250000", "1500000", "1750000", "2000000", "2500000", "3000000", "4000000", "5000000", "7500000", "10000000", "15000000", "20000000" ], "type": "string", "description": "The maximum price to search for properties." }, "min_bedrooms": { "title": "🏠 Min Bedrooms", "enum": [ "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10" ], "type": "string", "description": "The minimum number of bedrooms to search for properties." }, "max_bedrooms": { "title": "🏠 Max Bedrooms", "enum": [ "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10" ], "type": "string", "description": "The maximum number of bedrooms to search for properties." }, "min_bathrooms": { "title": "🚽 Min Bathrooms", "enum": [ "0", "1", "2", "3", "4", "5" ], "type": "string", "description": "The minimum number of bathrooms to search for properties." }, "max_bathrooms": { "title": "🚽 Max Bathrooms", "enum": [ "0", "1", "2", "3", "4", "5" ], "type": "string", "description": "The maximum number of bathrooms to search for properties." }, "search_radius": { "title": "🔍 Search Radius", "enum": [ "0", "0.25", "0.5", "1", "3", "5", "10", "15", "20", "30", "40" ], "type": "string", "description": "The radius to search for properties." }, "include_under_offer_and_stc": { "title": "Include Under Offer and STC", "type": "boolean", "description": "If checked then under offer and STC properties will be included in the search. Subject to contract (STC): Offers are accepted subject to contract meaning that they are finalised once contracts are signed and exchanged. Under offer: Where the vendor has accepted an offer from a buyer and the exchange of contracts is awaited.", "default": false }, "max_results": { "title": "🔍 Max Results", "enum": [ "0", "10", "20", "30", "40", "50", "100", "200", "300", "400", "500", "1000", "2000", "3000", "4000", "5000" ], "type": "string", "description": "The maximum number of results to return.", "default": "10" }, "max_days_since_added": { "title": "🔍 Max Days Since Added", "enum": [ "0", "1", "3", "7", "14" ], "type": "string", "description": "The maximum number of days since the property was added to Rightmove." } } }, "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 } } } } } } } } } }