{ "openapi": "3.0.1", "info": { "title": "UK Planning Applications Scraper – 400+ Councils & Postcodes", "description": "Export UK planning applications from 400+ councils by keyword, council, or postcode radius: address, description, status, dates, coordinates and documents link. Powered by the PlanIt open API. Pay per result.", "version": "1.0", "x-build-id": "suezHWec38ZUHnwMu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/devteamdrew~uk-planning-applications/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-devteamdrew-uk-planning-applications", "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/devteamdrew~uk-planning-applications/runs": { "post": { "operationId": "runs-sync-devteamdrew-uk-planning-applications", "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/devteamdrew~uk-planning-applications/run-sync": { "post": { "operationId": "run-sync-devteamdrew-uk-planning-applications", "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": { "search": { "title": "Keyword", "type": "string", "description": "Words to match in the application description, e.g. `solar`, `loft conversion`, `HMO`." }, "authorities": { "title": "Councils", "type": "array", "description": "Planning authority names as used by PlanIt, e.g. `Camden`, `Cornwall`, `Leeds`.", "items": { "type": "string" } }, "postcode": { "title": "Postcode", "type": "string", "description": "Centre of a radius search, e.g. `SW1A 1AA`." }, "radiusKm": { "title": "Radius (km)", "minimum": 1, "maximum": 50, "type": "integer", "description": "Radius around the postcode.", "default": 2 }, "recentDays": { "title": "Last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Only applications from the last N days (ignored when dates are set).", "default": 14 }, "startDate": { "title": "Start date", "type": "string", "description": "YYYY-MM-DD" }, "endDate": { "title": "End date", "type": "string", "description": "YYYY-MM-DD" }, "appSize": { "title": "Size", "enum": [ "", "Small", "Medium", "Large" ], "type": "string", "description": "Application size.", "default": "" }, "appState": { "title": "Status", "enum": [ "", "Undecided", "Permitted", "Conditions", "Rejected", "Withdrawn", "Referred", "Other" ], "type": "string", "description": "Decision status.", "default": "" }, "includeDetails": { "title": "Include agent & applicant details (enriched)", "type": "boolean", "description": "Add agent company, case officer, parish, document and comment counts. Billed as an enriched result.", "default": false }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of results to return (and pay for) per run.", "default": 100 }, "incremental": { "title": "Incremental mode (only new items)", "type": "boolean", "description": "Remember items delivered in previous runs with the same input and skip them. Great for scheduled monitoring runs: you only pay for new results.", "default": false }, "outputFormat": { "title": "Output format", "enum": [ "json", "llm", "both" ], "type": "string", "description": "`json` = structured fields; `llm` = id, url and a compact Markdown block ready for LLMs/RAG; `both` = structured fields plus Markdown.", "default": "json" }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Polite rate limit between API requests. Retries with backoff on 429/5xx are automatic.", "default": 500 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }