{ "openapi": "3.0.1", "info": { "title": "UK Planning Applications Lead Finder", "description": "Find recent UK planning applications that look useful for trades, kitchens, extensions and renovation lead generation. Returns scored lead records with reasons from verified council portals.", "version": "0.2", "x-build-id": "hTLJlfO01rxaTca4o" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dazrave~uk-planning-leads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dazrave-uk-planning-leads", "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/dazrave~uk-planning-leads/runs": { "post": { "operationId": "runs-sync-dazrave-uk-planning-leads", "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/dazrave~uk-planning-leads/run-sync": { "post": { "operationId": "run-sync-dazrave-uk-planning-leads", "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": { "councilSelection": { "title": "Councils to run", "type": "array", "description": "Use north-west-pack for Daz's current focus area, midlands-pack for the earlier Midlands set, or choose individual council IDs. Active North West IDs currently include bury, trafford, stockport, wigan, knowsley, st-helens, cheshire-west, lancaster, blackpool.", "items": { "type": "string" } }, "customCouncils": { "title": "Custom councils", "type": "array", "description": "Optional custom council objects: { id, name, portalType: 'idox' | 'searchresults-aspx', baseUrl }. Use for testing extra portals before adding them to the registry." }, "keywords": { "title": "Lead keywords", "type": "array", "description": "Keywords used for local relevance scoring. By default the actor searches by date range then scores locally, which catches more applications than exact-phrase portal search.", "items": { "type": "string" } }, "dateFrom": { "title": "Applications validated from (YYYY-MM-DD)", "type": "string", "description": "Start of the validated/received date range. Defaults to 14 days ago." }, "dateTo": { "title": "Applications validated to (YYYY-MM-DD)", "type": "string", "description": "End of the validated/received date range. Defaults to today." }, "minRelevanceScore": { "title": "Minimum relevance score", "minimum": 0, "type": "integer", "description": "Leads scoring below this are dropped. 0 keeps everything.", "default": 1 }, "maxPagesPerCouncil": { "title": "Max result pages per council", "minimum": 1, "maximum": 20, "type": "integer", "description": "Politeness cap on paginated search results per council.", "default": 3 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 3, "type": "integer", "description": "Keep low to be polite to council servers.", "default": 1 }, "requestDelaySecs": { "title": "Delay between requests to the same council (seconds)", "minimum": 1, "maximum": 60, "type": "integer", "description": "Polite delay between requests sent to the same council portal.", "default": 5 }, "sendKeywordToPortal": { "title": "Send first keyword to portal search", "type": "boolean", "description": "When false, searches by date range then scores/filter locally. This avoids exact-phrase portal searches missing relevant applications.", "default": false } } }, "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 } } } } } } } } } }