{ "openapi": "3.0.1", "info": { "title": "UK Planning Applications Scraper — All Councils", "description": "Scrape UK planning applications from every council in one run: site address with postcode and GPS, proposal text, application type, size, status, decision and dates, plus the agent firm behind the application. Filter by council, date range, keyword or postcode radius.", "version": "0.1", "x-build-id": "YuaTsbYErdi5SvRq2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapersdelight~uk-planning-applications-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapersdelight-uk-planning-applications-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/scrapersdelight~uk-planning-applications-scraper/runs": { "post": { "operationId": "runs-sync-scrapersdelight-uk-planning-applications-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/scrapersdelight~uk-planning-applications-scraper/run-sync": { "post": { "operationId": "run-sync-scrapersdelight-uk-planning-applications-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": { "authorities": { "title": "Councils", "type": "array", "description": "Planning authority names, e.g. Cornwall, Southwark, Leeds. Leave empty for every UK council at once.", "default": [], "items": { "type": "string" } }, "searchText": { "title": "Keyword", "type": "string", "description": "Match the proposal text, e.g. \"extension\", \"solar\", \"demolition\", \"change of use\".", "default": "" }, "recentDays": { "title": "Last N days", "minimum": 0, "maximum": 365, "type": "integer", "description": "Applications from the last N days. The simplest way to run this daily. 0 = use the date range instead.", "default": 0 }, "startDate": { "title": "From date", "type": "string", "description": "YYYY-MM-DD. Use with \"To date\" for a fixed window.", "default": "" }, "endDate": { "title": "To date", "type": "string", "description": "YYYY-MM-DD.", "default": "" }, "applicationType": { "title": "Application type", "type": "string", "description": "e.g. Full, Outline, Trees, Listed Building, Advertising, Conditions, Heritage.", "default": "" }, "applicationState": { "title": "Status", "type": "string", "description": "e.g. Undecided, Permitted, Rejected, Withdrawn. Undecided is the live pipeline; Permitted gives you approved schemes with a decision date.", "default": "" }, "applicationSize": { "title": "Size", "type": "string", "description": "Small, Medium or Large. Large filters to major schemes.", "default": "" }, "postcode": { "title": "Postcode", "type": "string", "description": "Centre of a radius search, e.g. BS1 1AA. Needs \"Radius km\" as well.", "default": "" }, "radiusKm": { "title": "Radius km", "minimum": 0, "maximum": 100, "type": "integer", "description": "Kilometres around the postcode. 0 = not a radius search.", "default": 0 }, "requireAgent": { "title": "Only applications with agent details", "type": "boolean", "description": "Keep only applications where the agent firm or its address is published — the rows that are actually leads. Dropped rows are not charged.", "default": false }, "maxItems": { "title": "Maximum applications", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Stop after this many. 0 = unlimited.", "default": 200 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. PlanIt is an open aggregator with no anti-bot, so a proxy is not needed." } } }, "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 } } } } } } } } } }