{ "openapi": "3.0.1", "info": { "title": "Rightmove Scraper - UK Property Listings", "description": "Search UK property for sale or to rent and get one clean row per listing: price, bedrooms, bathrooms, size, tenure, coordinates, key features and the listing agent. Type a place name, no login and no API key.", "version": "0.0", "x-build-id": "dyCh8hjFYYi7hAVKr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/goat255~rightmove-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-goat255-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/goat255~rightmove-scraper/runs": { "post": { "operationId": "runs-sync-goat255-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/goat255~rightmove-scraper/run-sync": { "post": { "operationId": "run-sync-goat255-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", "required": [ "locations" ], "properties": { "locations": { "title": "Locations", "type": "array", "description": "Towns, cities, postcodes or areas. One search per entry. Plain text is resolved automatically, so \"Manchester\" or \"SW1A\" both work.", "default": [ "London" ], "items": { "type": "string" } }, "channel": { "title": "For sale or to rent", "enum": [ "buy", "rent" ], "type": "string", "description": "Which market to search.", "default": "buy" }, "sort": { "title": "Sort by", "enum": [ "newest", "oldest", "lowestPrice", "highestPrice" ], "type": "string", "description": "Order the listings are returned in.", "default": "newest" }, "maxResultsPerLocation": { "title": "Max listings per location", "minimum": 1, "maximum": 1008, "type": "integer", "description": "Cap per location. A single search returns at most 1008 listings, which is a limit of the source. Split a large area into smaller searches to go past it.", "default": 100 }, "radius": { "title": "Search radius (miles)", "enum": [ "0.0", "0.25", "0.5", "1.0", "3.0", "5.0", "10.0", "15.0", "20.0", "30.0", "40.0" ], "type": "string", "description": "How far beyond the location to include. Only these steps are accepted.", "default": "0.0" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Lowest price to include. For rentals this is the monthly figure." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Highest price to include. For rentals this is the monthly figure." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Fewest bedrooms to include." }, "maxBedrooms": { "title": "Maximum bedrooms", "minimum": 0, "type": "integer", "description": "Most bedrooms to include." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Leave empty for every type.", "items": { "type": "string", "enum": [ "flat", "detached", "semi-detached", "terraced", "bungalow", "land", "park-home", "farm", "private-halls" ], "enumTitles": [ "Flat or apartment", "Detached", "Semi-detached", "Terraced", "Bungalow", "Land", "Park home", "Farm", "Private halls" ] }, "default": [] }, "mustHave": { "title": "Must have", "type": "array", "description": "Only return listings with these.", "items": { "type": "string", "enum": [ "garden", "parking", "newHome", "retirement", "sharedOwnership", "auction" ], "enumTitles": [ "Garden", "Parking", "New home", "Retirement", "Shared ownership", "Auction" ] }, "default": [] }, "dontShow": { "title": "Exclude", "type": "array", "description": "Leave these out of the results.", "items": { "type": "string", "enum": [ "newHome", "retirement", "sharedOwnership" ], "enumTitles": [ "New homes", "Retirement", "Shared ownership" ] }, "default": [] }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Enable to spread requests across IPs." } } }, "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 } } } } } } } } } }