API Reference

Index Revenue Timeseries

get
https://api.modoenergy.com/pub/v1/indices//revenue/timeseries/

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

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

Query Params
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.

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.

string
enum

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).

Allowed:
string
enum

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).

Allowed:
string
enum

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

Allowed:
string

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

string
enum

Level of aggregation for timeseries. If omitted, defaults to the index’s native resolution. If set, revenue is summed within the specified bucket (use 'base' to indicate the index’s native resolution). Grouping uses the index’s local date.

Allowed:
string

Base64-encoded cursor string for pagination.

integer
1 to 10000

Number of results to return per page.

Responses

Updated 5 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 days ago