{ "openapi": "3.0.1", "info": { "title": "PropertyData UK Analytics", "description": "Scrape UK property analytics from PropertyData.co.uk. Get rental yields, price per sqft, commercial rents, average prices, and sold prices for any UK postcode. No API key needed. Batch processing with parallel requests. Export as CSV, JSON, or Excel.", "version": "1.0", "x-build-id": "rqYpZ7hHVnoP2hTdK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~propertydata-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-propertydata-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/parseforge~propertydata-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-propertydata-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/parseforge~propertydata-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-propertydata-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": { "postcodes": { "title": "UK Postcodes", "type": "array", "description": "List of UK postcodes to look up (e.g. W14 9JH, SW1A 2AA). Each postcode returns rental yield, price per sqft, average prices, and more. If empty, the selected city will be used to discover postcodes automatically.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "Select one or more UK cities to automatically discover and scrape all postcode districts. Only used when no postcodes are provided.", "items": { "type": "string", "enum": [ "london", "manchester", "glasgow", "liverpool", "sheffield", "bristol", "coventry", "leeds", "bolton", "nottingham", "birmingham", "edinburgh", "cardiff", "sunderland", "southampton", "newcastle-upon-tyne", "plymouth", "bradford", "reading", "stoke-on-trent", "wolverhampton", "derby", "swansea", "hull", "middlesbrough", "portsmouth", "newport", "luton", "aberdeen", "dundee", "brighton", "york", "cambridge", "oxford", "bath", "exeter", "chester", "norwich" ], "enumTitles": [ "London", "Manchester", "Glasgow", "Liverpool", "Sheffield", "Bristol", "Coventry", "Leeds", "Bolton", "Nottingham", "Birmingham", "Edinburgh", "Cardiff", "Sunderland", "Southampton", "Newcastle upon Tyne", "Plymouth", "Bradford", "Reading", "Stoke-on-Trent", "Wolverhampton", "Derby", "Swansea", "Hull", "Middlesbrough", "Portsmouth", "Newport", "Luton", "Aberdeen", "Dundee", "Brighton", "York", "Cambridge", "Oxford", "Bath", "Exeter", "Chester", "Norwich" ] } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 postcodes (preview). Paid users: Optional, max 1,000,000" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy for large runs. The scraper starts without proxy for speed, and automatically switches to proxy if Cloudflare blocks requests." } } }, "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 } } } } } } } } } }