{ "openapi": "3.0.1", "info": { "title": "UK Energy Project Pipeline Monitor", "description": "Monitor UK renewable projects and twice-weekly grid connections using official REPD and NESO data. Get milestone changes, operator portfolios, planning lookups and commercial signals for sales, research and investment workflows.", "version": "1.1", "x-build-id": "7bNUCiGqgxQy25Qoy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dig_stays~uk-energy-project-pipeline-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dig_stays-uk-energy-project-pipeline-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/dig_stays~uk-energy-project-pipeline-monitor/runs": { "post": { "operationId": "runs-sync-dig_stays-uk-energy-project-pipeline-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/dig_stays~uk-energy-project-pipeline-monitor/run-sync": { "post": { "operationId": "run-sync-dig_stays-uk-energy-project-pipeline-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": { "technologyTypes": { "title": "Technologies", "uniqueItems": true, "type": "array", "description": "Select one or more REPD technologies. Leave empty for all technologies.", "items": { "type": "string", "enum": [ "Advanced Conversion Technologies", "Anaerobic Digestion", "Battery", "Biomass (co-firing)", "Biomass (dedicated)", "EfW Incineration", "Geothermal", "Hydrogen", "Landfill Gas", "Large Hydro", "Liquid Air Energy Storage", "Pumped Storage Hydroelectricity", "Sewage Sludge Digestion", "Shoreline Wave", "Small Hydro", "Solar Photovoltaics", "Tidal Stream", "Wind Offshore", "Wind Onshore" ] }, "default": [ "Battery" ] }, "developmentStatuses": { "title": "Development statuses", "uniqueItems": true, "type": "array", "description": "Select project stages to monitor. Leave empty for all statuses.", "items": { "type": "string", "enum": [ "Abandoned", "Appeal Lodged", "Appeal Refused", "Appeal Withdrawn", "Application Refused", "Application Submitted", "Application Withdrawn", "Awaiting Construction", "Decommissioned", "No Application Required", "Operational", "Planning Permission Expired", "Revised", "Under Construction" ] }, "default": [ "Under Construction" ] }, "regions": { "title": "Regions", "uniqueItems": true, "type": "array", "description": "Select one or more REPD regions. Leave empty for the whole UK.", "items": { "type": "string", "enum": [ "East Midlands", "Eastern", "London", "North East", "North West", "Northern Ireland", "Scotland", "South East", "South West", "Wales", "West Midlands", "Yorkshire and Humber" ] }, "default": [ "North West" ] }, "countries": { "title": "Countries", "uniqueItems": true, "type": "array", "description": "Optionally restrict results by UK nation.", "items": { "type": "string", "enum": [ "England", "Scotland", "Wales", "Northern Ireland" ] }, "default": [] }, "planningAuthorities": { "title": "Planning authorities", "type": "array", "description": "Optional case-insensitive fragments, such as Manchester or National Infrastructure. A project matches if its authority contains any supplied fragment.", "default": [], "items": { "type": "string" } }, "minCapacityMW": { "title": "Minimum installed capacity (MW)", "minimum": 0, "type": "number", "description": "Exclude projects below this capacity. Records whose capacity is not reported are excluded when this value is above zero.", "default": 0 }, "updatedSince": { "title": "Record updated since", "type": "string", "description": "Optional date. Filters the official Record Last Updated field. Leave blank to include all dates." }, "includeNesoConnections": { "title": "Add NESO grid-connection projects", "type": "boolean", "description": "Also monitor the official Transmission Entry Capacity register, updated twice weekly. This can add many baseline records; use the grid filters and maxRecords to control the first-run charge.", "default": false }, "gridPlantTypes": { "title": "NESO plant types", "type": "array", "description": "Optional case-insensitive fragments such as Battery, Solar or Wind. Applies only to NESO records; empty includes every plant type.", "default": [], "items": { "type": "string" } }, "gridStatuses": { "title": "NESO project statuses", "uniqueItems": true, "type": "array", "description": "Optional NESO connection-stage filter. Empty includes all statuses.", "items": { "type": "string", "enum": [ "Scoping", "Awaiting Consents", "Consents Approved", "Built & Connected" ] }, "default": [] }, "gridHostOperators": { "title": "NESO transmission owners", "uniqueItems": true, "type": "array", "description": "Optional host transmission-owner filter for NESO records.", "items": { "type": "string", "enum": [ "NGET", "SHET", "SPT", "OFTO" ] }, "default": [] }, "maxRecords": { "title": "Maximum matching projects", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Safety and cost limit after filtering. A new or reset baseline costs $0.002 per project, so 1,000 records cost about $2.00005 including the run start. The run fails instead of returning a partial snapshot.", "default": 1000 }, "resetBaseline": { "title": "Reset saved baseline", "type": "boolean", "description": "Return all matching projects and replace the saved comparison baseline. This charges $0.002 per returned project again; check maxRecords and your Apify maximum run cost first.", "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 } } } } } } } } } }