Leaderboard v2

post

https://enactapifd.lcp.uk.com/enactApi/Leaderboard/v2/data

Body Params

from

date-time

required

Defaults to 2023-06-21T00:00:00Z

The start of the date range to request for.

date-time

required

Defaults to 2023-06-23T00:00:00Z

The end of the date range to request for.

type

string

Defaults to Plant

The type of leaderboard to be requested; 'Plant' (default), 'Owner' or 'Optimiser'.

revenueMetric

string

Defaults to Pound

The unit which revenues will be measured in for the leaderboard; 'PoundPerMwPerH' (default) or 'Pound'. The values 'PoundPerKwPerYear', 'PoundPerMw', 'PoundPerMwh', 'PoundPerMwhPerH', 'PoundPerCycle' or 'PoundPerThroughput' can also be used depending on the leaderboard type.

marketPriceAssumption

string

Defaults to WeightedAverageDayAheadPrice

The price assumption for wholesale revenues on the leaderboard; 'WeightedAverageDayAheadPrice' (default), 'EpexDayAheadPrice', 'NordpoolDayAheadPrice', 'IntradayPrice' or 'BestPrice'.

gasPriceAssumption

string

Defaults to DayAheadForward

The gas price assumption used to calculate running costs for unit profit on the leaderboard; 'DayAheadForward' (default), 'DayAheadSpot', 'WithinDaySpot' or 'CheapestPrice'.

includeCmRevenues

boolean

Defaults to false

Changes whether or not the capacity market revenue column is shown. If set to false, the capacity market revenues will not be included in the net revenues.

ancillaryProfitAggregation

string

Defaults to ByProduct

The aggregation option for ancillary profits. Options are: "FrequencyAndReserve", "ByProduct", and "ByDirection"."

groupDx

boolean

Defaults to false

When set to true, DC, DR, and DL profits will be grouped into 'Dx'.

aggregate

string

Defaults to None

Aggregation level ("Day", "Week", "Month"). For the given date range, data is aggregated by the specified period (e.g., "Month" splits the original date range into months creating rows in the dataframe for each month). An aggregate column indicates the start date of each aggregation.

showCoLocatedFuels

boolean

Defaults to false

When set to true, a column will show the fuel types of co-located plants

AccountForAvailabilityInNormalisation

boolean

Defaults to false

When set to true, the availability of the plant is taken into account when normalising the revenues

fuels

array of strings

This must be removed (to get all fuels), or in the format ["Battery", "CCGT", "Hydro"]

fuels

includeImbalance

boolean

Defaults to false

Include or exclude imbalance payments for non-BM and secondary BMUs

includeEstimatedChargingCost

boolean

Defaults to false

Include or exclude estimated charging/discharging costs for non-BM and secondary BMUs

includeFpnFlagOffWholesale

boolean

Defaults to false

Include or exclude estimated wholesale revenue for BM (No FPN) assets

chargingCostPrice

string

Defaults to IntradayPrice

The price assumption using for the estimated charging/discharging costs of non-BM and secondary BMUs. Options are: 'WeightedAverageDayAheadPrice', 'EpexDayAheadPrice', 'NordpoolDayAheadPrice', 'IntradayPrice' (default) or 'SystemPrice'

chargingCostAssumption

string

Defaults to PreviousEFABlock

The charging cost assumption used for the estimated charging/discharging costs for non-BM and secondary BMUs. Options are: 'PreviousEFABlock' (default), 'OptimalPricePrev12Hours' and 'CurrentSp'

nonDeliverySplitOut

string

Defaults to Show

The option for showing BM Non-Delivery charges. Options are: "Show" (default), "Ignore", and "Absorb".

reservePenaltySplitOut

string

Defaults to Show

The option for showing Reserve penalties. Options are: "Show" (default), "Ignore", and "Absorb".

includeColocation

boolean

Defaults to true

Include or exclude co-located assets

Responses

200200

400400