Leaderboard

This endpoint returns the Leaderboard for the specified date range (see Enact's leaderboard page).

To request data for a single day, set the from and to fields of the request body equal to each other.

Using the LCPDelta Python Package

Synchronous

from lcp_delta import enact
from datetime import date

enact_api_helper = enact.APIHelper(username, public_api_key)

# see 'BODY PARAMS' section below for details on corresponding parameter values
response_dataframe = enact_api_helper.get_leaderboard_data(
	date(2023,6,21),
	date(2023,6,23),
	"Plant", # leaderboard type ("Plant", "Owner" or "Battery")
	"Pound", # revenue metric
	"WeightedAverageDayAheadPrice", # market price assumption
	"DayAheadForward", # gas price assumption
  	False # whether to include capacity market revenues
)

print(response_dataframe)

Asynchronous (package version 1.3.0 and later)

from lcp_delta import enact
from datetime import date
import asyncio

async def main():
    enact_api_helper = enact.APIHelper(username, public_api_key)

    # see 'BODY PARAMS' section below for details on corresponding parameter values
    response_dataframe = await enact_api_helper.get_leaderboard_data_async(
        date(2023,6,21),
        date(2023,6,23),
        "Plant", # leaderboard type ("Plant", "Owner" or "Battery")
        "Pound", # revenue metric
        "WeightedAverageDayAheadPrice", # market price assumption
        "DayAheadForward", # gas price assumption
        False # whether to include capacity market revenues
    )

    print(response_dataframe)

asyncio.run(main())

Using the LCPDelta Python Package

Using the API Directly