{ "openapi": "3.0.1", "info": { "title": "UK Planning Applications Scraper & Intelligence API", "description": "Track UK planning applications across 24 verified council portals. Filter by work type, date and decision status. Clean JSON with postcode, lead type and residential flags. Monitor mode returns only new applications — and charges only for those. For builders, developers and AI agents.", "version": "0.1", "x-build-id": "pLWJkk5uUjRXu8S7M" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/interactapps~uk-planning-applications-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-interactapps-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/interactapps~uk-planning-applications-scraper/runs": { "post": { "operationId": "runs-sync-interactapps-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/interactapps~uk-planning-applications-scraper/run-sync": { "post": { "operationId": "run-sync-interactapps-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": { "preset": { "title": "Preset", "enum": [ "none", "extensions_and_lofts", "new_builds_and_developments", "tree_works", "commercial_conversions", "renewables_and_retrofit", "approved_leads", "daily_monitor" ], "type": "string", "description": "One-click configurations. A preset fills sensible defaults; anything you set explicitly still wins.", "default": "none" }, "councils": { "title": "Councils", "type": "array", "description": "Council IDs to search, or leave empty for all covered councils. See the README for the verified coverage list.", "items": { "type": "string" } }, "keywords": { "title": "Description keywords", "type": "array", "description": "Search application descriptions for these terms, e.g. [\"solar\", \"heat pump\"]. Each term is a separate search. Leave empty to return everything in the date window.", "items": { "type": "string" } }, "daysBack": { "title": "Days back", "minimum": 1, "maximum": 3650, "type": "integer", "description": "How far back to search from today. Ignored if you set explicit dates.", "default": 30 }, "dateFrom": { "title": "From date", "type": "string", "description": "ISO date (YYYY-MM-DD). Overrides 'days back'." }, "dateTo": { "title": "To date", "type": "string", "description": "ISO date (YYYY-MM-DD). Defaults to today." }, "decidedOnly": { "title": "Search by decision date instead of validation date", "type": "boolean", "description": "Returns applications decided in the window rather than submitted in it. An approved application is a hotter lead than a new submission.", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Hard cap on charged results across all councils and keywords.", "default": 100 }, "onlyNew": { "title": "Monitor mode (only new or changed applications)", "type": "boolean", "description": "Compares against your previous runs and returns only new applications, or ones whose status or decision changed. You are charged only for those. Ideal for a daily schedule.", "default": false }, "enrich": { "title": "Enrichment", "type": "boolean", "description": "Adds derived fields: postcode, lead type, residential/commercial, decided flag. No extra charge.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }