{ "openapi": "3.0.1", "info": { "title": "Uk Planning Applications", "description": "Extract UK planning applications from 425+ councils across England, Scotland, and Wales. \n\nGet structured data on every permitted development, housing project, and commercial build with site addresses, decision dates, planning agent, contacts, dwelling counts, and direct links to council portals.", "version": "0.2", "x-build-id": "GAR2zA8Tife9Ej0V0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/devon_gtme~uk-planning-applications-planit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-devon_gtme-uk-planning-applications-planit", "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/devon_gtme~uk-planning-applications-planit/runs": { "post": { "operationId": "runs-sync-devon_gtme-uk-planning-applications-planit", "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/devon_gtme~uk-planning-applications-planit/run-sync": { "post": { "operationId": "run-sync-devon_gtme-uk-planning-applications-planit", "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": { "councils": { "title": "Councils", "type": "array", "description": "Council names to search. Leave empty for nationwide search. Type any UK council name — suggestions show the most popular.", "items": { "type": "string" } }, "appSize": { "title": "Application Size", "type": "array", "description": "Filter by development size. Large = major developments (10+ dwellings or 1000+ sqm). Medium = minor. Small = householder.", "items": { "type": "string", "enum": [ "Large", "Medium", "Small" ] }, "default": [ "Large", "Medium" ] }, "appState": { "title": "Application Status", "type": "array", "description": "Filter by decision status.", "items": { "type": "string", "enum": [ "Permitted", "Undecided", "Conditions", "Rejected", "Withdrawn", "Referred", "Appeal" ] }, "default": [ "Permitted" ] }, "daysBack": { "title": "Days Back", "minimum": 1, "maximum": 365, "type": "integer", "description": "How many days back to search from today (based on decision date). For 'Undecided' apps, this filters by submission date.", "default": 90 }, "searchText": { "title": "Search Text", "type": "string", "description": "Free text search — matches against description, address, and reference number." }, "postcode": { "title": "Postcode (centre point)", "type": "string", "description": "UK postcode for radius search. Requires Radius to be set. Example: SW1A 1AA" }, "radiusKm": { "title": "Radius (km)", "minimum": 1, "maximum": 100, "type": "number", "description": "Search radius in kilometres from the postcode centre point.", "default": 10 }, "appTypes": { "title": "Application Types", "type": "array", "description": "Filter by application type substring. Leave empty for all types. Common values: Full, Outline, Reserved, Hybrid, Demolition.", "items": { "type": "string" } }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum total results to return. The actor stops fetching once this cap is reached.", "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 } } }, "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 } } } } } } } } } }