{ "openapi": "3.0.1", "info": { "title": "Rightmove Property Discovery Scraper", "description": "Discover public Rightmove property listings by location, sale or rent, and property type. Extract prices, descriptions, areas, rooms, images, agents, and URLs.", "version": "0.1", "x-build-id": "jH5mBAdf9z6y9nHQZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/trovevault~rightmove-property-discovery-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-trovevault-rightmove-property-discovery-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/trovevault~rightmove-property-discovery-scraper/runs": { "post": { "operationId": "runs-sync-trovevault-rightmove-property-discovery-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/trovevault~rightmove-property-discovery-scraper/run-sync": { "post": { "operationId": "run-sync-trovevault-rightmove-property-discovery-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", "required": [ "location", "operation", "propertyType" ], "properties": { "location": { "title": "Location", "minLength": 1, "type": "string", "description": "Major UK city to search. Examples: London, Manchester, Birmingham, Leeds, Liverpool, Bristol, Edinburgh, Glasgow. Default: London. City-level searches are more stable than broad regions.", "default": "London" }, "operation": { "title": "Operation", "enum": [ "sale", "rent" ], "type": "string", "description": "Choose the listing operation to discover. Use sale for properties offered for purchase or rent for rental listings. Default: sale.", "default": "sale" }, "propertyType": { "title": "Property Type", "enum": [ "any", "apartment", "house", "land", "commercial" ], "type": "string", "description": "Choose the property category to discover. Options: any, apartment, house, land, commercial. Default: apartment. Use any for the broadest listing set supported by Rightmove.", "default": "apartment" }, "maxItems": { "title": "Maximum Items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of property listings to save, from 1 to 1000. Default: 3. Use small values for quick checks and higher values for broader city-level market discovery.", "default": 3 }, "datasetId": { "title": "Dataset ID", "type": "string", "description": "Optional existing Apify dataset ID to append each saved listing to, in addition to this run's default dataset. Leave empty to write only to the default dataset. Use this when chaining multiple discovery actors into one shared dataset." }, "runId": { "title": "Run ID", "type": "string", "description": "Optional external or Apify run ID copied into each output row and RUN_SUMMARY. Leave empty to omit run tracing. Use this to connect listings back to a parent workflow run." } } }, "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 } } } } } } } } } }