{ "openapi": "3.0.1", "info": { "title": "EIA Energy Data Scraper - US Energy Prices & Stats", "description": "Extract energy data from the US EIA API. Access petroleum prices, natural gas, coal, electricity, nuclear outages, and state energy data. 14 data categories with pagination, facet filtering, and date range support.", "version": "0.1", "x-build-id": "JGce454CQRvg2d3wq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/compute-edge~eia-energy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-compute-edge-eia-energy-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/compute-edge~eia-energy-scraper/runs": { "post": { "operationId": "runs-sync-compute-edge-eia-energy-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/compute-edge~eia-energy-scraper/run-sync": { "post": { "operationId": "run-sync-compute-edge-eia-energy-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": [ "route" ], "properties": { "apiKey": { "title": "EIA API Key", "type": "string", "description": "Your EIA API key. Register free at https://www.eia.gov/opendata/register.php. Falls back to DEMO_KEY if not provided (rate-limited)." }, "route": { "title": "Energy Data Category", "enum": [ "petroleum", "natural-gas", "coal", "electricity", "nuclear-outages", "seds", "steo", "international", "crude-oil-imports", "total-energy", "co2-emissions" ], "type": "string", "description": "Top-level energy data category to query.", "default": "petroleum" }, "subRoute": { "title": "Sub-Route Path", "type": "string", "description": "Sub-route path for the data category (e.g., 'pri/gnd' for petroleum gasoline prices, 'sum/snd' for supply/disposition). Leave empty to browse available sub-routes for the selected category.", "default": "" }, "frequency": { "title": "Data Frequency", "enum": [ "weekly", "monthly", "quarterly", "annual" ], "type": "string", "description": "Time frequency of the data series.", "default": "monthly" }, "dataColumns": { "title": "Data Columns", "type": "array", "description": "Which data columns to fetch from the API (e.g., 'value', 'price', 'quantity'). Most endpoints use 'value'.", "default": [ "value" ], "items": { "type": "string" } }, "facets": { "title": "Filter Facets", "type": "object", "description": "Filter facets as key-value pairs. Keys are facet IDs (e.g., 'stateid', 'product', 'duoarea'), values are arrays of allowed values. Example: {\"product\": [\"EPM0\"], \"duoarea\": [\"NUS\"]}", "default": {} }, "startDate": { "title": "Start Date", "type": "string", "description": "Start date for the data range. Format depends on frequency: 'YYYY' for annual, 'YYYY-MM' for monthly, 'YYYY-MM-DD' for weekly.", "default": "" }, "endDate": { "title": "End Date", "type": "string", "description": "End date for the data range. Same format as start date. Leave empty for latest available data.", "default": "" }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of data records to return.", "default": 1000 } } }, "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 } } } } } } } } } }