{ "openapi": "3.0.1", "info": { "title": "Uk Electricity Elexon Scraper", "description": "Export UK electricity generation, demand, and system prices effortlessly. Schedule runs on Apify and download clean datasets as JSON, CSV, or Excel for your spreadsheets and offline analysis.", "version": "0.0", "x-build-id": "8mI1zTbbPMHA9xo0L" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/b2b_lead_generation~uk-electricity-elexon-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-b2b_lead_generation-uk-electricity-elexon-scraper", "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/b2b_lead_generation~uk-electricity-elexon-scraper/runs": { "post": { "operationId": "runs-sync-b2b_lead_generation-uk-electricity-elexon-scraper", "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/b2b_lead_generation~uk-electricity-elexon-scraper/run-sync": { "post": { "operationId": "run-sync-b2b_lead_generation-uk-electricity-elexon-scraper", "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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "generation_summary", "system_prices", "demand" ], "type": "string", "description": "Which public Elexon feed to collect. generation_summary is fuel outturn by settlement period, system_prices is imbalance prices for each settlement date, and demand is initial demand outturn.", "default": "generation_summary" }, "dataset": { "title": "Dataset alias", "type": "string", "description": "Optional alias for mode. Accepted values are generation_summary, system_prices, and demand. When mode is set, mode wins.", "default": "generation_summary" }, "dateFrom": { "title": "Date from", "type": "string", "description": "First settlement date, YYYY-MM-DD. System prices request one day at a time from this date. Demand sends it as settlementDateFrom. Generation summary keeps periods whose start time falls on or after this date. Leave blank to use yesterday in UTC for prices and demand, or the API's current window for generation." }, "dateTo": { "title": "Date to", "type": "string", "description": "Last settlement date, YYYY-MM-DD, inclusive. System prices walk each date through this day. Demand sends it as settlementDateTo. Generation summary drops periods that start after this date. Leave blank to match dateFrom, or yesterday in UTC when both dates are blank." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum dataset rows for this run, including error rows. Default 100. Values above 1000 are clamped to 1000.", "default": 100 }, "timeoutSecs": { "title": "Timeout seconds", "minimum": 1, "maximum": 3600, "type": "integer", "description": "Overall run limit in seconds. The actor stops starting new requests when this elapses. Default 300. Maximum 3600.", "default": 300 }, "requestTimeoutSecs": { "title": "Request timeout seconds", "minimum": 1, "maximum": 120, "type": "integer", "description": "How long to wait for a single Elexon response, in seconds. Default 30.", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy for requests. Leave this off. The public Elexon API is called directly and does not need a proxy. Turn one on only if your network cannot reach data.elexon.co.uk.", "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 } } } } } } } } } }