{ "openapi": "3.0.1", "info": { "title": "uk-planning-applications", "description": "Search & monitor planning applications from 400+ UK councils. Trade-lead tagging for builders, roofers, scaffolders, solar installers & landscapers, with 0–100 lead scoring, monitor mode with dedupe, and clean JSON for workflows and AI agents. No proxies, no logins.", "version": "0.0", "x-build-id": "skpWfOabIh2hXsffR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/frequent_jumbo~my-actor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-frequent_jumbo-my-actor", "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/frequent_jumbo~my-actor/runs": { "post": { "operationId": "runs-sync-frequent_jumbo-my-actor", "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/frequent_jumbo~my-actor/run-sync": { "post": { "operationId": "run-sync-frequent_jumbo-my-actor", "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": { "areas": { "title": "Councils / areas", "type": "array", "description": "One or more UK planning authority names, e.g. \"Manchester\", \"Hackney\", \"Leeds\", or a region like \"London\". Covers 400+ councils across England, Scotland, Wales and NI.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "search", "monitor" ], "type": "string", "description": "search = one-off query. monitor = remembers what it has seen and returns only NEW/changed applications on each run — ideal for scheduled runs feeding alerts.", "default": "search" }, "searchText": { "title": "Keyword search", "type": "string", "description": "Search in application descriptions. Supports phrases in quotes, 'or', and '-' to exclude. E.g.: \"loft conversion\" or extension" }, "recentDays": { "title": "Applications from the last N days", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Only applications submitted within this many days (0 = today). Leave empty to use explicit dates below." }, "startDate": { "title": "Start date (YYYY-MM-DD)", "type": "string", "description": "Only applications submitted on/after this date. Ignored if 'last N days' is set." }, "endDate": { "title": "End date (YYYY-MM-DD)", "type": "string", "description": "Only applications submitted on/before this date." }, "postcode": { "title": "Postcode (radius search)", "type": "string", "description": "UK postcode for a circular search instead of / as well as council areas." }, "radiusKm": { "title": "Radius (km)", "minimum": 1, "maximum": 50, "type": "integer", "description": "Radius for postcode search. Default 5.", "default": 5 }, "appState": { "title": "Decision status", "type": "array", "description": "Filter by status. 'Undecided' = live applications (early signal); 'Permitted'/'Conditions' = approved (work about to start).", "items": { "type": "string", "enum": [ "Undecided", "Permitted", "Conditions", "Rejected", "Withdrawn", "Referred", "Unresolved", "Other" ] } }, "appSize": { "title": "Development size", "type": "array", "description": "Filter by development size. Large = major developments; Medium = multiple dwellings; Small = everything else (householder work).", "items": { "type": "string", "enum": [ "Small", "Medium", "Large" ] } }, "appType": { "title": "Application type", "type": "array", "description": "Filter by application type, e.g. Full (incl. householder), Trees, Advertising, Telecoms. Leave empty for all types.", "items": { "type": "string", "enum": [ "Full", "Outline", "Amendment", "Conditions", "Heritage", "Trees", "Advertising", "Telecoms", "Other" ] } }, "tradeTagging": { "title": "Trade-lead classification", "type": "boolean", "description": "Tag each application with relevant trades (roofing, extension, solar, landscaping, scaffolding…), a project category, value band, and a 0-100 lead score with rationale.", "default": true }, "minLeadScore": { "title": "Minimum lead score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only output applications scoring at least this (0-100). Requires trade-lead classification. Try 60+ for hot leads.", "default": 0 }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of applications to return across all areas (hard cap 5000 per source limits).", "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 } } } } } } } } } }