{ "openapi": "3.0.1", "info": { "title": "UK Planning Applications Feed - Council Planning Data, $4/1K", "description": "Search UK planning applications by council, postcode radius, keyword and date range: reference, address, description, status, dates, link and lat/lng. Data from UK PlanIt, no key.", "version": "0.1", "x-build-id": "jSClJdUZHI5VeIVol" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pennydata~uk-planning-applications-feed/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pennydata-uk-planning-applications-feed", "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/pennydata~uk-planning-applications-feed/runs": { "post": { "operationId": "runs-sync-pennydata-uk-planning-applications-feed", "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/pennydata~uk-planning-applications-feed/run-sync": { "post": { "operationId": "run-sync-pennydata-uk-planning-applications-feed", "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": { "authority": { "title": "Council / planning area", "type": "string", "description": "UK PlanIt area name, for example Doncaster, Camden or Leeds. Leave empty to search the whole UK (then use a postcode or keyword)." }, "search": { "title": "Keywords", "type": "string", "description": "Text searched in the application description. Quote phrases, use 'or' between alternatives and a leading dash to exclude, for example \"change of use\" or extension -conservatory." }, "postcode": { "title": "Postcode (radius search)", "type": "string", "description": "UK postcode used as the centre of a radius search, for example SW1A 2AA." }, "radiusKm": { "title": "Radius (km)", "minimum": 1, "maximum": 20, "type": "integer", "description": "Search radius around the postcode, in km (1-20).", "default": 2 }, "recentDays": { "title": "Received in the last N days", "minimum": 0, "maximum": 365, "type": "integer", "description": "Only applications that started within this many days. Ignored when Start date or End date is set.", "default": 14 }, "startDate": { "title": "Start date from", "type": "string", "description": "YYYY-MM-DD. Applications whose start date is on or after this day." }, "endDate": { "title": "Start date to", "type": "string", "description": "YYYY-MM-DD. Applications whose start date is on or before this day." }, "appState": { "title": "Decision status", "enum": [ "", "Undecided", "Permitted", "Conditions", "Rejected", "Withdrawn", "Unresolved" ], "type": "string", "description": "Filter by status.", "default": "" }, "appType": { "title": "Application type", "enum": [ "", "Full", "Outline", "Amendment", "Conditions", "Heritage", "Trees", "Advertising", "Telecoms", "Other" ], "type": "string", "description": "Filter by type.", "default": "" }, "maxResults": { "title": "Max applications", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum applications to return (1-5000). Each 300 results need one request to PlanIt, spaced 60 seconds apart as PlanIt asks.", "default": 100 } } }, "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 } } } } } } } } } }