{ "openapi": "3.0.1", "info": { "title": "Electricity Rates & Grid Mix by State — EIA Site Economics", "description": "Electricity cost screening by state from the EIA v2 API: industrial, commercial and residential retail rates with YoY change and a live US benchmark, plus operating capacity by fuel, balancing authority, storage split and planned retirements. For data-center and industrial siting.", "version": "1.2", "x-build-id": "chZtafZqtUZ3VHLhD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/malonestar~eia-v2-site-energy-economics/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-malonestar-eia-v2-site-energy-economics", "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/malonestar~eia-v2-site-energy-economics/runs": { "post": { "operationId": "runs-sync-malonestar-eia-v2-site-energy-economics", "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/malonestar~eia-v2-site-energy-economics/run-sync": { "post": { "operationId": "run-sync-malonestar-eia-v2-site-energy-economics", "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": [ "states" ], "properties": { "apiKey": { "title": "EIA API key (bring your own, free)", "type": "string", "description": "Free EIA v2 API key. Register in about a minute at https://www.eia.gov/opendata/register.php (no cost, no card). Supplying your own key gives you your own rate limit; leave it blank to use the Actor default key, which is shared across all users. If no key is available at all the run FAILS loudly with the registration URL and bills nothing - it does not return a green empty dataset. You may also set an EIA_API_KEY environment variable on the Actor." }, "states": { "title": "States to profile", "type": "array", "description": "Two-letter US state ids to build an electricity-economics profile for (e.g. \"CO\", \"TX\"). One billable state_profile row per state. \"US\" is also accepted for the national aggregate. An id EIA does not publish is flagged state_id_recognized=false rather than returned as a state with zero capacity.", "items": { "type": "string" } }, "months": { "title": "History window (months)", "minimum": 13, "maximum": 240, "type": "integer", "description": "How many months of retail-rate history to fetch per state. Used to find the latest month and compute the same-month year-over-year price change, so 13 is the minimum for one full YoY comparison. Does not affect the capacity rollup, which always uses the newest published month.", "default": 24 }, "includePlantDetail": { "title": "Include per-generator capacity rows", "type": "boolean", "description": "When true, also emit one billable row per GENERATOR (row_type \"plant\") with plant name and id, operator, balancing authority, fuel, technology, prime mover, nameplate and net summer/winter capacity, in-service date, planned retirement date, county and lat/lon - capped by \"Max plant rows\". When false (default) only the one state_profile summary row per state is returned.", "default": false }, "maxPlantRows": { "title": "Max generator rows per state", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Safety cap on the number of per-generator rows emitted per state when \"Include per-plant capacity rows\" is true. Each row is billable. Ignored when that option is false.", "default": 200 } } }, "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 } } } } } } } } } }