{ "openapi": "3.0.1", "info": { "title": "Purplebricks Scraper", "description": "Scrape UK property listings from Purplebricks (purplebricks.co.uk). Search by location with price, bedroom, and property-style filters; fetch full property details by ID; get location suggestions.", "version": "1.0", "x-build-id": "yAiFMpkDinhI9Pwqf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~purplebricks-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-purplebricks-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/crawlerbros~purplebricks-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-purplebricks-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/crawlerbros~purplebricks-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-purplebricks-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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "byIds", "suggestLocations" ], "type": "string", "description": "What to fetch.", "default": "search" }, "location": { "title": "Location (mode=search)", "type": "string", "description": "UK location to search, e.g. `london`, `manchester`, `edinburgh`, or a full path like `greater-london/london`. Use mode=suggestLocations to find valid names.", "default": "london" }, "ids": { "title": "Property IDs (mode=byIds)", "type": "array", "description": "Purplebricks property IDs, e.g. `1911812`.", "default": [], "items": { "type": "string" } }, "searchText": { "title": "Search text (mode=suggestLocations)", "type": "string", "description": "Location text to get suggestions for, e.g. `manchester`." }, "suggestionCount": { "title": "Suggestion count (mode=suggestLocations)", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many location suggestions to return.", "default": 10 }, "priceFrom": { "title": "Price (min)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Drop properties priced below this (GBP)." }, "priceTo": { "title": "Price (max)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Drop properties priced above this (GBP)." }, "bedroomsFrom": { "title": "Bedrooms (min)", "minimum": 1, "maximum": 20, "type": "integer", "description": "Drop properties with fewer bedrooms than this." }, "bedroomsTo": { "title": "Bedrooms (max)", "minimum": 1, "maximum": 20, "type": "integer", "description": "Drop properties with more bedrooms than this." }, "propertyStyle": { "title": "Property style", "enum": [ "", "6", "7", "8", "9", "11", "12", "14", "15", "23", "27" ], "type": "string", "description": "Restrict to one property style (e.g. `9` = Detached house, `27` = Apartment).", "default": "" }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "highestPrice", "lowestPrice", "newest" ], "type": "string", "description": "Sort order for search results.", "default": "relevance" }, "includeSold": { "title": "Include sold properties", "type": "boolean", "description": "Also return properties that have already sold (mode=search).", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records.", "default": 50 } } }, "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 } } } } } } } } } }