{ "openapi": "3.0.1", "info": { "title": "UK Solar & Heat Pump Planning Lead Monitor", "description": "Find UK planning-application leads for solar, heat pump, roofing, retrofit and home-improvement installers.", "version": "0.1", "x-build-id": "2pGrbe87O4IGyXbPD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/barking_wisdom~uk-solar-heat-pump-planning-lead-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-barking_wisdom-uk-solar-heat-pump-planning-lead-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/barking_wisdom~uk-solar-heat-pump-planning-lead-monitor/runs": { "post": { "operationId": "runs-sync-barking_wisdom-uk-solar-heat-pump-planning-lead-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/barking_wisdom~uk-solar-heat-pump-planning-lead-monitor/run-sync": { "post": { "operationId": "run-sync-barking_wisdom-uk-solar-heat-pump-planning-lead-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", "required": [ "sourcePreset" ], "properties": { "sourcePreset": { "title": "Source preset", "enum": [ "planning-data-api", "custom" ], "type": "string", "description": "Built-in public source group to crawl or fetch.", "default": "planning-data-api" }, "startUrls": { "title": "Custom public planning URLs", "type": "array", "description": "Public council planning list pages to crawl when using the custom preset. API users may include optional sourceName, councilName, region, and adapter fields.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "keywords": { "title": "Keywords", "type": "array", "description": "Solar, heat pump, roofing, retrofit and home-improvement terms used for matching.", "default": [ "solar panels", "solar pv", "photovoltaic", "pv", "pv array", "air source heat pump", "ground source heat pump", "heat pump", "roof works", "roof alteration", "retrofit", "energy efficiency" ], "items": { "type": "string" } }, "leadTypes": { "title": "Lead types", "type": "array", "description": "Optional lead type filters. Empty means all lead types.", "default": [ "solar_pv", "heat_pump", "roofing", "retrofit" ], "items": { "type": "string" } }, "lookbackDays": { "title": "Lookback days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Only emit applications updated or decided within this many days when dates are available.", "default": 365 }, "maxRecords": { "title": "Max official API records", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap for official Planning Data API records fetched in one run.", "default": 200 }, "maxPagesPerSource": { "title": "Max pages per source", "minimum": 1, "maximum": 50, "type": "integer", "description": "Hard cap to control cost and source impact for custom council pages.", "default": 5 }, "minScore": { "title": "Minimum relevance score", "minimum": 1, "maximum": 30, "type": "integer", "description": "Minimum score required before a planning application is emitted.", "default": 5 }, "emitOnlyNew": { "title": "Emit only new leads", "type": "boolean", "description": "Enable for scheduled monitoring to avoid re-emitting leads already seen in previous runs. Leave disabled for sample/default Store runs so the dataset is not empty.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Public MVP defaults to no Apify proxy.", "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 } } }, "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 } } } } } } } } } }