{
"openapi": "3.0.1",
"info": {
"title": "SiteVerdict — UK Grid Carbon Intensity & Best Times",
"description": "48-hour carbon intensity forecasts for any GB postcode or region (NESO Carbon Intensity API), the cleanest windows to run EV charging, batch or ML jobs with CO2 saved, live generation mix and wholesale price indicators from Elexon BMRS, alerts and CSV. Free open data, no key.",
"version": "1.1",
"x-build-id": "hT2HitkbQrfsQ84gy"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/siteverdict~siteverdict-uk-energy-carbon/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-siteverdict-siteverdict-uk-energy-carbon",
"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/siteverdict~siteverdict-uk-energy-carbon/runs": {
"post": {
"operationId": "runs-sync-siteverdict-siteverdict-uk-energy-carbon",
"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/siteverdict~siteverdict-uk-energy-carbon/run-sync": {
"post": {
"operationId": "run-sync-siteverdict-siteverdict-uk-energy-carbon",
"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": {
"locations": {
"title": "Locations",
"type": "array",
"description": "One per line: national, a GB postcode or outcode (PL4 7LG, SW1A), region:13 or a region name (London, South West England, North Scotland...). Max 50.",
"items": {
"type": "string"
}
},
"jobs": {
"title": "Jobs to schedule",
"type": "array",
"description": "Energy-heavy tasks to place in the cleanest window: [{\"name\":\"EV charge\",\"durationHours\":4,\"deadlineHours\":14,\"energyKwh\":28}]. deadlineHours = must finish within N hours; energyKwh adds kg CO2 saved."
},
"windowsPerJob": {
"title": "Windows per job",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "Best non-overlapping windows returned per job.",
"default": 3
},
"includeSlots": {
"title": "Include the half-hourly forecast",
"type": "boolean",
"description": "Adds all ~96 half-hour slots (with regional generation mix) to each location row.",
"default": true
},
"includeGridSnapshot": {
"title": "Grid snapshot (mix + wholesale indicators)",
"type": "boolean",
"description": "One extra row: national intensity and mix, latest Elexon generation by fuel (MW, low-carbon %), last-24 h market index price and yesterday's system prices.",
"default": true
},
"alertMaxIntensity": {
"title": "Alert when a window is at or below (gCO2/kWh)",
"minimum": 1,
"maximum": 1000,
"type": "integer",
"description": "Optional. Alerts when a job's best window averages at or below this and starts within the time below. Schedule the Actor hourly for timely alerts."
},
"alertWithinHours": {
"title": "...and starts within (hours)",
"minimum": 0,
"maximum": 48,
"type": "integer",
"description": "Only alert when the clean window starts within this many hours.",
"default": 6
},
"webhookUrl": {
"title": "Webhook URL (https)",
"type": "string",
"description": "JSON digest of alerts. Stored encrypted, never logged."
},
"slackWebhookUrl": {
"title": "Slack incoming webhook URL",
"type": "string",
"description": "https://hooks.slack.com/services/... Stored encrypted, never logged."
},
"exportCsv": {
"title": "Save forecast-slots.csv",
"type": "boolean",
"description": "Save a CSV export to the run key-value store.",
"default": true
},
"aiProvider": {
"title": "AI brief (optional, your own key)",
"enum": [
"none",
"anthropic",
"openai"
],
"type": "string",
"description": "A short plain-English scheduling brief written by your own Anthropic or OpenAI account. Off by default.",
"default": "none"
},
"aiApiKey": {
"title": "AI API key",
"type": "string",
"description": "Your own key. Stored encrypted, never logged or output."
},
"aiModel": {
"title": "AI model (optional)",
"type": "string",
"description": "Default: claude-sonnet-5-5 (Anthropic) or gpt-4.1-mini (OpenAI)."
},
"sampleMode": {
"title": "Sample mode (no network, free)",
"type": "boolean",
"description": "Replays real API responses recorded on 11 Oct 2026. Nothing is charged.",
"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
},
"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
}
}
}
}
}
}
}
}
}
}