API Reference
Start typing to search…

Index Data

post
https://enact-functionapp-siteapi.azurewebsites.net/api/GbIndexData
Body Params
date-time
required

The start of the date range to request for.

date-time
required

The end of the date range to request for.

string
required

The index ID denoting which index to get data for. Index IDs can be found on the GB Index page on Enact, by clicking the ID icon next to an index.

string
Defaults to "PoundPerKwPerYear"

The normalisation to apply. "Pound", "PoundPerMw", "PoundPerMwh", "PoundPerThroughput", "PoundPerMwPerYear" or "PoundPerKwPerYear".

string
Defaults to "Week"

The granularity of the data. "Day", "Week", "Month" or "Year".

string
Defaults to "false"

Set to "true" to show profit or "false" to show revenue.

string
Defaults to "DayAheadForward"

The price the gas costs are calculated against. "DayAheadForward", "DayAheadSpot", "WithinDaySpot", "CheapestPrice" or None.

string
Defaults to "WeightedAverageDayAheadPrice"

The price the wholesale revenues are calculated against. "EpexDayAheadPrice", "WeightedAverageDayAheadPrice", "NordpoolDayAheadPrice", "IntradayPrice" or "BestPrice".

string
Defaults to "false"

Set to "true" to account for availability in normalisation or "false".

string
Defaults to "false"

Set to "true" to show wholesale import and export profit split or "false".

string
Defaults to None

"BidOfferSplit" or "SystemEnergySplit" or None.

string
Defaults to "ByProduct"

"FrequencyAndReserve", "ByProduct" or "ByDirection".

string
Defaults to "false"

Set to "true" to group all Dx services of the same direction together or "false".

string
Defaults to "true"

Set to "true" to include capacity market profits or "false".

string
Defaults to "true"

Set to "true" to include non-delivery charges or "false".

string
Defaults to false

Set to "false" (default) to exclude imbalance payments for non-BM and secondary BMUs

string
Defaults to false

Set to "false" (default) to exclude estimated charging/discharging costs for non-BM and secondary BMUs

string
Defaults to false

Set to "false" (default) to exclude estimated wholesale revenue for BM (No FPN) assets

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'

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'

string
Defaults to Show

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

Responses

Updated 5 months ago

Language
Credentials
OAuth2
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago