{ "openapi": "3.0.1", "info": { "title": "UK Planning Applications Scraper: London & Idox Councils", "description": "UK planning applications scraper: new applications from all 35 London planning authorities via the Planning London Datahub and Idox Public Access council portals, with keyword filters and new application alerts. By RawTrader | UK Industry & Bills", "version": "0.1", "x-build-id": "fQsWyEW9NBUZu4aCW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/seaf999ield~uk-planning-applications/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-seaf999ield-uk-planning-applications", "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/seaf999ield~uk-planning-applications/runs": { "post": { "operationId": "runs-sync-seaf999ield-uk-planning-applications", "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/seaf999ield~uk-planning-applications/run-sync": { "post": { "operationId": "run-sync-seaf999ield-uk-planning-applications", "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": { "mode": { "title": "Mode", "enum": [ "search", "new_applications", "check_councils" ], "type": "string", "description": "new_applications keeps a snapshot in a named key-value store per monitor; the first run saves a baseline and outputs all current rows.", "default": "search" }, "councils": { "title": "Councils", "type": "array", "description": "Council names or keys: any London borough (e.g. 'Hackney', 'Kensington & Chelsea', 'City of London', 'OPDC'), 'london' for all 35 London planning authorities, 'rutland', or 'all' for every supported council. Other Idox Public Access councils can be named (e.g. 'doncaster') but are only searched if their robots.txt allows it and no bot challenge is shown.", "items": { "type": "string" } }, "dateType": { "title": "Date field", "enum": [ "validated", "received", "decision" ], "type": "string", "description": "Which date the date range applies to. London Datahub has no 'received' date, so 'received' falls back to the validated date there.", "default": "validated" }, "daysBack": { "title": "Days back", "minimum": 1, "maximum": 365, "type": "integer", "description": "Used when no start date is given.", "default": 14 }, "startDate": { "title": "Start date", "type": "string", "description": "YYYY-MM-DD (optional)." }, "endDate": { "title": "End date", "type": "string", "description": "YYYY-MM-DD (optional, default today)." }, "keywords": { "title": "Proposal keywords", "type": "array", "description": "Searched in the proposal description, one search per keyword, e.g. 'extension', 'change of use', 'HMO', 'solar', 'loft'. Empty = all applications.", "items": { "type": "string" } }, "maxPerCouncil": { "title": "Max applications per council", "minimum": 1, "type": "integer", "description": "Newest first.", "default": 50 }, "maxItems": { "title": "Max applications in total", "minimum": 0, "type": "integer", "description": "0 = no limit.", "default": 0 }, "includeDetails": { "title": "Include applicant, agent and decision", "type": "boolean", "description": "Opens each application's 'Further information' tab (one extra request per application).", "default": true }, "monitorName": { "title": "Monitor name", "type": "string", "description": "new_applications: separate saved state per name (store planning-).", "default": "default" }, "maxConcurrentCouncils": { "title": "Councils in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "Each council portal is still queried one request at a time.", "default": 4 }, "delaySeconds": { "title": "Delay per request (s)", "minimum": 0.5, "type": "number", "description": "Minimum gap between requests to one portal; a robots.txt Crawl-delay is honoured if higher.", "default": 1 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed for most portals. Some councils only answer UK IP addresses; a UK proxy can help there.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }