{ "openapi": "3.0.1", "info": { "title": "Energy Futures Market Data API: EEX Power, Gas and Carbon", "description": "EEX power, natural gas and carbon futures settlement prices, OHLC, open interest, trades and top of book, EEX gas spot, EU ETS auction results, EEX indices and Transparency Platform outages and generation via the EEX Group DataSource REST API. Bring your own key.", "version": "0.1", "x-build-id": "B0Q7y9CLem9S9rVsp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~energy-futures-market-data-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-energy-futures-market-data-api", "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/nabeelbaghoor~energy-futures-market-data-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-energy-futures-market-data-api", "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/nabeelbaghoor~energy-futures-market-data-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-energy-futures-market-data-api", "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": { "mode": { "title": "What to read", "enum": [ "derivativesSettlements", "derivativesStatistics", "derivativesTrades", "derivativesTopOfBook", "derivativesContracts", "spotSettlements", "spotStatistics", "spotTrades", "spotTopOfBook", "spotContracts", "indexValues", "auctionResults", "auctionRevenues", "auctionCalendar", "ummUnits", "ummOther", "transparencySeries", "eurowindSeries", "transparencyCompanies", "listValues" ], "type": "string", "description": "Settlement prices, OHLC statistics with open interest, trades, top of book and contract reference data for EEX derivatives (power, natural gas, emissions, freight, agriculturals) and for the EEX gas spot markets; EEX index values; EU ETS emission allowance auction results, revenues and calendar; and EEX Transparency Platform data: urgent market messages, generation, consumption and storage time series, EuroWind renewables and company reference data. Valid values lists the commodities, areas, dates, short codes, maturities and index codes you can use.", "default": "derivativesSettlements" }, "market": { "title": "Market (valid values mode)", "enum": [ "derivatives", "spot", "auctions", "index", "transparency" ], "type": "string", "description": "Valid values mode only. Which API to list values for. Fill in commodity, area, date and short code (or index code) one at a time to go one level deeper.", "default": "derivatives" }, "commodity": { "title": "Commodity", "type": "string", "description": "Commodity code in the API spelling (upper case), such as POWER, NATGAS, ENVIRONMENTALS or FREIGHT for derivatives, NATGAS for gas spot (filled in when empty), ENVIRONMENTALS for auctions (filled in when empty), or POWER, NATGAS or OTHER for transparency data.", "default": "POWER" }, "area": { "title": "Area", "type": "string", "description": "Market area code, such as DE, FR, IT, HU or JP for power, TTF, THE, NBP or CZVTP for gas, EU for emissions, or a country code (DE, FR, AT and more) for transparency data. The valid values mode lists the areas of each commodity.", "default": "DE" }, "tradeDate": { "title": "Trade date", "type": "string", "description": "A single trade date (also the auction date or the transparency validity date), such as 2026-10-27. Leave it and the date range empty to use the latest date the API lists. Weekend dates have no derivatives data." }, "dateFrom": { "title": "From date", "type": "string", "description": "Start of a date range. For settlement prices, statistics, trades, index values and auction results and revenues it reads the range route (a date such as 2026-10-01). For urgent market messages it is the start of the validity window, and for time series the interval start (a date or an ISO 8601 date-time in UTC)." }, "dateTo": { "title": "To date", "type": "string", "description": "End of the date range, such as 2026-10-27. Market data ranges need both dates; for messages and time series it is optional, up to one year after the from date." }, "shortCode": { "title": "Short code", "type": "string", "description": "Optional product short code, such as DEBM (German power base month future), F7BY, DEBQ, FEBM or TTFDA (TTF day-ahead gas spot). Narrows the answer to one product; the valid values mode lists them per trade date." }, "maturity": { "title": "Maturity", "type": "string", "description": "Derivatives only, with a short code. Expiration month as YYYYMM, such as 202612, to read one contract." }, "maturityOffset": { "title": "Maturity offset", "type": "string", "description": "Derivatives only, with a short code and maturity. A continuous symbol such as Y2 to read the maturity two years on." }, "rollingSymbol": { "title": "Rolling symbol", "type": "string", "description": "Derivatives top of book only. A rolling symbol instead of short code and maturity: DEBM+1 (next month), DEB+W1 (next week), DWB+WE1 (next weekend) or DB+D01 (next day)." }, "instrumentType": { "title": "Instrument type", "enum": [ "Simple Instrument", "Futures Spread", "Inter-Product Spread" ], "type": "string", "description": "Derivatives only. Leave empty for all instruments, or read only outright contracts or spreads." }, "tradeType": { "title": "Trade type", "enum": [ "Exchange", "Trade Registration" ], "type": "string", "description": "Derivatives trades only. Exchange trades (order book) or trade registrations (OTC trades registered for clearing). Leave empty for both." }, "timeFrom": { "title": "Time from", "type": "string", "description": "Trades and top of book on one trade date. Start time of day, such as 10:00:00 (times are as the API defines them for that market). For top of book it reads the quote history from this time." }, "timeTo": { "title": "Time to", "type": "string", "description": "Trades and top of book on one trade date. End time of day, such as 16:00:00. For top of book without time from, the latest quotes up to this time." }, "auctionId": { "title": "Auction ID", "type": "string", "description": "Auction modes only. A numeric auction ID such as 3455 to read one auction; the valid values mode lists the IDs of an auction date." }, "indexCode": { "title": "Index code", "type": "string", "description": "Index values mode. Index code such as EGSI_D (European Gas Spot Index, day); the valid values mode with market Indices lists the index codes of each commodity and area." }, "deliveryDay": { "title": "Delivery day", "type": "string", "description": "Index values only. Optional delivery day such as 2026-10-28." }, "facilityType": { "title": "Facility type", "enum": [ "Producer", "Consumer", "Storage", "Transmission" ], "type": "string", "description": "Unit unavailability messages. Which kind of facility the messages are about." }, "seriesSymbol": { "title": "Time series symbol", "enum": [ "ActualInstalledCapacitySource", "AvailableCapacity", "AvailableCapacityHourly", "NonUsableCapacity", "NonUsableCapacityHourly", "ForecastGenerationFuelTypeHourly", "ForecastGenerationFuelType15min", "ActualGenerationFuelTypeHourly", "ActualGenerationFuelType15min", "ActualGenerationUnitHourly", "ActualGenerationUnit15min", "ForecastRenewableGenerationTSO15min", "ActualRenewableGeneration15min", "ForecastRenewableGenerationEW15min", "ActualRenewableGenerationEW15min", "ActualPumpingCapacityCountry", "ActualWorkingCapacityCountry", "FillingLevel", "ActualPowerConsumptionCapacityCountry", "ForecastPowerConsumptionCountryHourly", "ActualPowerConsumptionCountryHourly", "ActualGasConsumptionCapacityCountry", "ForecastGasConsumptionCountry", "ActualGasConsumptionCountry" ], "type": "string", "description": "Time series modes. Which data set to read. The two EW symbols belong to the EuroWind mode, the others to the transparency time series mode." }, "modifiedFrom": { "title": "Changed since", "type": "string", "description": "Urgent market messages. Read the messages published or updated since this moment (a date or an ISO 8601 date-time in UTC) instead of those valid in the from and to window, which then filters by event start and stop." }, "modifiedTo": { "title": "Changed until", "type": "string", "description": "Urgent market messages, with changed since. End of the change window, up to one year after it." }, "eventStatus": { "title": "Event status", "enum": [ "Active", "Dismissed" ], "type": "string", "description": "Urgent market messages. Active or dismissed messages only; leave empty for both." }, "unavailabilityType": { "title": "Unavailability type", "enum": [ "Planned", "Unplanned" ], "type": "string", "description": "Unit unavailability messages. Planned or unplanned outages only." }, "unavailabilityReason": { "title": "Unavailability reason", "enum": [ "Outage", "Maintenance", "External factors", "Other" ], "type": "string", "description": "Unit unavailability messages. Filter by the cause of the unavailability." }, "adhocType": { "title": "Message type", "enum": [ "Simple", "MAR", "TSO", "Balancing", "TSM" ], "type": "string", "description": "Other market information messages. Simple, MAR (Market Abuse Regulation disclosures), TSO, Balancing or TSM." }, "fuelType": { "title": "Fuel type", "enum": [ "Biomass", "Fossil Brown coal/Lignite", "Fossil Coal-derived gas", "Fossil Gas", "Fossil Hard coal", "Fossil Oil", "Fossil Oil shale", "Fossil Peat", "Geothermal", "Hydro Pumped Storage", "Hydro Run-of-river and poundage", "Hydro Water Reservoir", "Marine", "Nuclear", "Other renewable", "Solar", "Waste", "Wind Offshore", "Wind Onshore", "Other" ], "type": "string", "description": "Unit unavailability messages and time series. Filter by the energy source of the unit." }, "controlArea": { "title": "Control area", "type": "string", "description": "Unit unavailability messages and time series (power). A control area such as Amprion, TransnetBW, 50Hertz or TenneT (DE)." }, "marketArea": { "title": "Market area", "type": "string", "description": "Unit unavailability messages and transparency time series (gas). A market area such as THE, TTF or CEGH." }, "companyId": { "title": "Company ID", "type": "string", "description": "Urgent market messages and transparency reference data. A reporting company ID such as BASF_AG; in reference data mode it reads that one company." }, "facilityId": { "title": "Facility ID", "type": "string", "description": "Unit unavailability messages. A facility ID such as E110194." }, "unitId": { "title": "Unit ID", "type": "string", "description": "Unit unavailability messages and transparency time series. A unit ID such as E110194-001." }, "messageId": { "title": "Message ID", "type": "string", "description": "Urgent market messages. One message ID to read all versions of that event." }, "minOutage": { "title": "Minimum outage (MW)", "minimum": 0, "type": "integer", "description": "Unit unavailability messages. Only messages with at least this much unavailable capacity." }, "onlyModified": { "title": "Only modified reference data", "type": "boolean", "description": "Transparency reference data mode. Return only the companies whose reference data changed on the validity date.", "default": false }, "fields": { "title": "Response fields", "type": "array", "description": "Optional. Request only these response fields, such as TrdDate, ShortCode, Maturity and Px, for a smaller answer. Leave empty for every field. Flat columns built from fields you leave out stay empty.", "items": { "type": "string" } }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 60000, "type": "integer", "description": "The most rows this run returns and charges for. The API returns up to 60,000 records per request; a full day of trades in a busy area can run to thousands.", "default": 100 }, "apiKey": { "title": "Access Token", "type": "string", "description": "Your EEX Group DataSource Access Token, created under Access Tokens on the DataSource Hub (eds.eex-group.com) after subscribing in the EEX Group Webshop. Stored as a secret, sent only in the Authorization header (Bearer) to api.eex-group.com and never logged. You can instead set the DATA_API_KEY environment secret." } } }, "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 } } } } } } } } } }