{ "openapi": "3.0.1", "info": { "title": "UK Planning Application Signal Monitor", "description": "Find public UK planning applications and score property/commercial change signals, freshness, regions, and deltas from planning.data.gov.uk.", "version": "0.1", "x-build-id": "MqS2lqztxc7QpwmHt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/signaltools~uk-planning-application-signal-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-signaltools-uk-planning-application-signal-monitor", "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/signaltools~uk-planning-application-signal-monitor/runs": { "post": { "operationId": "runs-sync-signaltools-uk-planning-application-signal-monitor", "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/signaltools~uk-planning-application-signal-monitor/run-sync": { "post": { "operationId": "run-sync-signaltools-uk-planning-application-signal-monitor", "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": { "regions": { "title": "Target regions / boroughs", "type": "array", "description": "Region, borough, council, or location terms that increase signal score when found in public planning application text.", "default": [ "London", "Westminster", "Camden", "Islington", "Southwark", "Hackney", "Lambeth" ], "items": { "type": "string" } }, "propertyKeywords": { "title": "Property signal keywords", "type": "array", "description": "Property/commercial terms used to score applications for operators, agents, contractors, and workplace teams.", "default": [ "office", "commercial", "change of use", "refurbishment", "extension", "mixed use", "retail", "restaurant", "plant", "air conditioning", "shopfront", "workspace", "demolition", "conversion", "public realm", "signage" ], "items": { "type": "string" } }, "daysBack": { "title": "Entered in last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Only emit applications whose public entry/start date is within this window when date fields are present.", "default": 730 }, "maxRecords": { "title": "Max public records to scan", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum planning.data.gov.uk records to inspect from the public planning-application dataset.", "default": 250 }, "minSignalScore": { "title": "Minimum signal score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only emit applications with this property-change signal score or above.", "default": 8 }, "enableDelta": { "title": "Detect new/changed/unchanged applications", "type": "boolean", "description": "Compare the current result set with the previous persisted snapshot and mark rows as new, changed, or unchanged.", "default": true }, "emitRemoved": { "title": "Emit removed applications", "type": "boolean", "description": "Emit rows for applications that appeared in the previous snapshot but no longer match the current scan.", "default": false }, "persistSnapshot": { "title": "Persist snapshot for future deltas", "type": "boolean", "description": "Store the current matching applications in a named key-value store so future runs can compute deltas.", "default": true } } }, "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 } } } } } } } } } }