v1

latestOpenAPI 3.0.0BSD License2026-07-24228233924.5 KB

Indices

Index Revenue

Retrieves total index revenue for a specific index over a defined date range.

get/indices/{id}/revenue/

Path parameters

idinteger required

The id of the requested index. List of available ids is returned by /pub/v1/indices/.

Query parameters

interval_startstring date-time required

Follows ISO-8601 standards. Date-time: if it includes an offset or Z, that exact instant is used. If no timezone is present, UTC is assumed. Inclusive.

interval_endstring date-time required

Follows ISO-8601 standards. Date-time: if it includes an offset or Z, that exact instant is used. If no timezone is present, UTC is assumed. Inclusive.

capacity_normalisation'mw' | 'mwh'

Normalisation of the revenue. If omitted, returns revenue in GBP/AUD/USD. If set to MW or MWh, returns revenue normalised to asset capacity (e.g., GBP/MW).

time_basis'hour' | 'year'

Scales revenue over a period. If omitted, returns revenue in GBP/AUD/USD. If set to hour or year, returns revenue scaled across that period (e.g., GBP/hour).

breakdown'market'

Breaks down the revenue by the specified dimension. If omitted, returns the total revenue.

marketsstring

Filters results by market. If omitted, returns revenue across all markets. Multiple values can be separated by a comma.

Response

Success

unitsstring required

Indicates the units in which revenue values are reported.