Aggregate Actuals Prices

This endpoint transforms prices to desired form for a desired electrical entity node in a specified ISO.

Key Parameters: - startdate/enddate: Date filters for the calculation period - curves: Determines what prices to consider (e.g., dam, rtm) - agg: Aggregation operation to apply (e.g., min, max, mean, std, sum) - groupby: Groups the time series by frequency before applying aggregation (e.g., yearly, monthly, daily, hourly) - start_hour/end_hour: Filter by hour range (1-24) - dow: Filter by day of week (mon, tue, wed, thu, fri, sat, sun) - include_nerc_holidays: Include or exclude NERC holidays from the calculation - unit: Desired unit for the results. Note: When unit is specified, agg is forced to 'sum' and groupby is ignored (data is grouped by day). - step: Whether to return step data (default: false)

Calculate Actuals Basis

This endpoint calculates price difference between specified super and sub electrical entities. The super is considered as the hub, and the sub is considered as the node.

Entity Types: - hub: Can be an electrical Hub, Load Zone or Node (super entity) - node: Can be an electrical Load Zone, Node or Bus (sub entity)

Key Parameters: - startdate/enddate: Date filters for the calculation period - curve: Determines what prices to consider (e.g., dam, rtm) - agg: Post calculation operation that returns a single value for the specified date range (e.g., min, max, mean, std) - block_level: Get data in a block level form. Examples of blocks - 7x24 (ATC), 2x16 (Weekend peak hours), 7x8 (Nights), etc.

Calculate Actuals EOn

This endpoint calculates an SOC feasible Top Bottom Spread for a desired electrical entity node in a specified ISO. SOC feasibility implies charging (bottom) must occur before discharging (top). The results are calculated using an LP (Linear Programming). It is important to note that the TB operation is performed on daily data to give a single value per day, that can be resampled as desired.

Key Parameters: - startdate/enddate: Date filters for the calculation period - curve: Determines what prices to consider (e.g., dam, rtm, dart) - duration: Duration of the hypothetical BESS (Battery Energy Storage System) - cycles: Number of cycles of the hypothetical BESS - chgeff: Charging efficiency of the BESS - dischgeff: Discharging efficiency of the BESS - runfrequency: Optimization window (e.g., daily, monthly) - details: Enable detailed hourly dispatch results - unit: Desired unit for the results - dataformat: Format of the response (json or zip) - step: Whether to return step data (default: false)

Calculate Actuals RPO

This endpoint calculates the Revenue Put Option based on the provided parameters for a desired electrical entity node in a specified ISO. The RPO calculation combines Ancillary Services and TB revenue components.

RPO Calculation Formula: - RPO = tbcomponent + ascomponent - ascomponent= agg(curves included) + offset - tbcomponent = Max(TBi, as_component at the TBi hours) - TBi = TB calculation at the ith level (e.g., TB2nd = TB2 - TB1)

Key Parameters: - startdate/enddate: Date filters for the calculation period - agg: Aggregation method to be used in the RPO calculation - duration: Duration of the hypothetical BESS (Battery Energy Storage System) - unit: Desired unit for the results - data_format: Format of the response - regup/regdown/spin/nonspin/ecrs/reg: Include relevant curves in the calculation - offset: Additional curve to be used in the RPO calculation (e.g., regup, regdown, etc - all AS) - step: Whether to return step data (default: false)

Calculate Actuals TBn

This endpoint calculates the top bottom spread, representing revenue potential for a desired electrical entity node in a specified ISO. It is important to note that the TB operation is performed on daily data to give a single value per day, that can be resampled as desired.

Key Parameters: - startdate/enddate: Date filters for the calculation period - curve: Determines what prices to consider (e.g., dam, rtm, dart) - duration: Duration of the hypothetical BESS (Battery Energy Storage System) - unit: Desired unit for the results ($/kw-dy, $/kw-mo, $/kw-mo-yr, $/kw-yr-yr, $/mwh-dy, $/mwh-mo, $/mwh-yr) - step: Whether to return step data (default: false)

Multi-node Aggregate Insights

Compute cross-node insights over a window of historical actuals for a group of nodes in one ISO. Companion to the single-node Aggregate Actuals Prices endpoint: this collapses many nodes into comparison analytics rather than returning raw rows. Actuals only, JSON only, whole window aggregated in one response (no pagination).

Insight blocks: - pernodestats: per node x curve -> mean/median/min/max/std/p25/p75/count (all requested curves) - ranking: nodes ranked by mean of focuscurve, with best/worst and spread (max mean - min mean) - correlation: pairwise Pearson matrix on focuscurve, aligned on (date, repeatedhourflag); omittednodes lists nodes lacking focuscurve - volatility: per node x curve std and cv (std/mean; null when mean ~ 0), plus meandailyspread on focus_curve

Partial results: unknown/empty nodes are skipped and reported in nodes.errors; they never fail the request. 404 only when no node produced data; 400 on validation errors (missing/empty nodes, node cap, bad freq, enddate < startdate, focus_curve not in curves).

Aggregate Forward Prices

This endpoint transforms prices to desired form for a desired electrical entity node in a specified ISO.

Key Parameters: - refdate: Reference date for generation of futures (query parameter) - exchange: Exchange of the futures - startdate/enddate: Date filters for the calculation period - curves: Determines what prices to consider (e.g., dam, rtm) - agg: Aggregation operation to apply (e.g., min, max, mean, std, sum) - groupby: Groups the time series by frequency before applying aggregation (e.g., yearly, monthly, daily, hourly) - start_hour/end_hour: Filter by hour range (1-24) - dow: Filter by day of week (mon, tue, wed, thu, fri, sat, sun) - include_nerc_holidays: Include or exclude NERC holidays from the calculation - unit: Desired unit for the results. Note: When unit is specified, agg is forced to 'sum' and groupby is ignored (data is grouped by day). - step: Whether to return step data (default: false)

Calculate Forward EOn

This endpoint calculates an SOC feasible Top Bottom Spread for a desired electrical entity node in a specified ISO. SOC feasibility implies charging (bottom) must occur before discharging (top). The results are calculated using an LP (Linear Programming). It is important to note that the TB operation is performed on daily data to give a single value per day, that can be resampled as desired.

Key Parameters: - refdate: Reference date for generation of futures (query parameter) - exchange: Exchange of the futures - startdate/enddate: Date filters for the calculation period - curve: Determines what prices to consider (e.g., dam, rtm, dart) - duration: Duration of the hypothetical BESS (Battery Energy Storage System) - cycles: Number of cycles of the hypothetical BESS - chgeff: Charging efficiency of the BESS - dischgeff: Discharging efficiency of the BESS - degradation: Annual duration degradation rate applied to the battery - runfrequency: Optimization window (e.g., daily, monthly) - details: Enable detailed hourly dispatch results - unit: Desired unit for the results - dataformat: Format of the response - step: Whether to return step data (default: false)

Calculate Forward RPO

This endpoint calculates the Revenue Put Option based on the provided parameters for a desired electrical entity node in a specified ISO. The RPO calculation combines Ancillary Services and TB revenue components.

RPO Calculation Formula: - RPO = tbcomponent + ascomponent - ascomponent= agg(curves included) + offset - tbcomponent = Max(TBi, as_component at the TBi hours) - TBi = TB calculation at the ith level (e.g., TB2nd = TB2 - TB1)

Key Parameters: - refdate: Reference date for generation of futures (query parameter) - exchange: Exchange of the futures - startdate/enddate: Date filters for the calculation period - agg: Aggregation method to be used in the RPO calculation - duration: Duration of the hypothetical BESS (Battery Energy Storage System) - unit: Desired unit for the results - data_format: Format of the response - regup/regdown/spin/nonspin/ecrs/reg: Include relevant curves in the calculation - offset: Additional curve to be used in the RPO calculation (e.g., regup, regdown, etc - all AS) - step: Whether to return step data (default: false)

Calculate Forward TBn

This endpoint calculates the top bottom spread, representing revenue potential for a desired electrical entity node in a specified ISO. It is important to note that the TB operation is performed on daily data to give a single value per day, that can be resampled as desired.

Key Parameters: - refdate: Reference date for generation of futures (query parameter) - exchange: Exchange of the futures (default: IFED) - startdate/enddate: Date filters for the calculation period - curve: Determines what prices to consider (e.g., dam, rtm, dart) - duration: Duration of the hypothetical BESS (Battery Energy Storage System) - unit: Desired unit for the results ($/kw-dy, $/kw-mo, $/kw-mo-yr, $/kw-yr-yr, $/mwh-dy, $/mwh-mo, $/mwh-yr) - step: Whether to return step data (default: false)

Calculate CYCn (Annual Cycle Revenue Optimizer)

This endpoint calculates revenue through optimizing battery operations across annual cycles to maximize revenue.

Requirements: - You will have to provide daily revenue numbers along with cycle counts for all possible cycle scenarios (1 through max_cycles) in a CSV file - Max Cycles = CEIL(24 / 2 / duration) - The API returns optimized revenue and cycle counts within the annual cycle limit

Key Parameters: - annualcycles: Upper bound on maximum number of cycles per year - dataformat: Format of the response (json or csv)

Compare Contract Prices

This endpoint compares contract prices from one exchange with forward prices from another exchange for the same delivery period. The comparison includes the price difference in both absolute and percentage terms. This is useful for analyzing price disparities between different sources.

Get Contract Data

This endpoint retrieves contract price data for a specific contract. If date parameters are provided, it returns the contract prices for those dates. Otherwise, it returns the available dates for the contract. The endpoint supports strip pattern processing for contract data and can return results in either JSON or CSV format.

When using strip parameter, if startref and endref are not provided, the API will return results for the entire available reference date range.

List Contracts by Exchange

This endpoint retrieves a list of all available contracts for a specific exchange. Contracts can be filtered by various attributes using optional query parameters.

Filter Parameters: - iso: Filter by ISO code (case-insensitive) - node: Filter by node name (case-insensitive) - dart_mode: Filter by day-ahead/real-time mode (case-insensitive) - settlement: Filter by settlement type (case-insensitive)

List Exchanges

This endpoint retrieves a list of all available exchanges.

Get Historical Price Data

This endpoint retrieves historical price data based on the provided parameters. The response can be either a JSON object or a ZIP file containing the data in CSV format.

If merge=true and multiple curves are requested, all curves will be merged into a single dataframe with the format ISO_NODE.csv.

Get Multi-node Historical Prices

Retrieve historical actuals for a group of nodes in one call (single ISO, single curve), nested per node. Built for comparison and as a base for higher-level operations. The single-node historical endpoint is unchanged.

Time window: provide either years (contiguous) or a start/end date range; start/end wins when both are present. Pagination (JSON): results are calendar chunks. Omit cursor for page 1, then repeat with cursor = meta.next_cursor until meta.has_more is false. format=zip returns the full window (one CSV per node) and ignores paging. Bad nodes: unknown/empty nodes are skipped and listed in meta.errors — they never fail the request. Only a malformed request or exceeding the node cap (MAXCOMPARENODES, default 50) returns 400.

Get Forwards Data

This endpoint retrieves forward curve data. If the requested data is already available, it returns a ZIP file containing the data. If the data is not yet calculated, it enqueues the request and returns a JSON response with a slug to track the status.

Note: If a refdate is provided in the params array for a specific curve, it will override the refdate provided in the URL parameters for that curve.

Get Scenario Status

Returns the current status of a scenario calculation request. Poll this endpoint after receiving a slug from EO500 or CO500 to determine when results are ready.

Run COnCYC500 Scenario (Co-optimized, 500 cycles/yr)

Runs a co-optimized battery dispatch (energy + ancillary services jointly) capped at 500 annual cycles. Returns results immediately when already computed; otherwise enqueues and returns a slug to poll.

Modes (provide one combination): - Futures: exchange + refdate — forward price period - Historical: start_date + end_date — actuals-only period - Combo: all four — actuals up to refdate stitched to forward prices

Key Parameters: - duration: Battery duration in hours (default: 4 h) - chgeff / dischgeff: Charging and discharging efficiency (default: 0.94) - data_format: json (default) or zip

Run EOnCYC500 Scenario (Energy Only, 500 cycles/yr)

Runs an energy-only battery dispatch optimisation capped at 500 annual cycles. Returns results immediately when already computed; otherwise enqueues and returns a slug to poll.

Modes (provide one combination): - Futures: exchange + refdate — forward price period - Historical: start_date + end_date — actuals-only period - Combo: all four — actuals up to refdate stitched to forward prices

Key Parameters: - curve: Price curve to optimise against (dam, rtm, dart, or comma-separated). dart uses both DAM and RTM. - duration: Battery duration in hours (default: 4 h) - chgeff / dischgeff: Charging and discharging efficiency (default: 0.94) - data_format: json (default) or zip - details: When true, response includes hourly and daily dispatch breakdown (JSON only)