Recipes
🔋
OBP BM analysis [Python package]
Open Recipe
📈
Balancing Reserve - BM analysis [Python package]
Open Recipe

This endpoint returns BM (Balancing Mechanism) data for a given date. It can return acceptances, table bids and table offers by period, or acceptances filtered by plant or fuel (see Enact's BOA dashboard and BOA comparer).


Using the LCPDelta Python Package

Synchronous

from lcp_delta import enact
from datetime import date

enact_api_helper = enact.APIHelper(username, public_api_key)

# bm acceptances, table bids and table offers for a given date and period
response_dictionary = enact_api_helper.get_bm_data_by_period(
	date(2023,6,22), # date to return data for
	1 # period to return data for
)

print(response_dictionary)

# bm acceptances for a given date filtered by either plant or fuel
response_dataframe = enact_api_helper.get_bm_data_by_search(
	date(2023,6,22), # date to return data for
	"plant", # search option ("plant", "fuel", or "all")
	"CARR" # additional filter (BMU ID or fuel type)
)

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)

    # bm acceptances, table bids and table offers for a given date and period
    response_dictionary = await enact_api_helper.get_bm_data_by_period_async(
        date(2023,6,22), # date to return data for
        1 # period to return data for
    )

    print(response_dictionary)

    # bm acceptances for a given date filtered by either plant or fuel
    response_dataframe = await enact_api_helper.get_bm_data_by_search_async(
        date(2023,6,22), # date to return data for
        "plant", # search option ("plant", "fuel", or "all")
        "CARR" # additional filter (BMU ID or fuel type)
    )

    print(response_dataframe)

asyncio.run(main())

Using the API Directly

The returned data will depend on how the request object is constructed.

If the date and period fields are provided in the request object, this endpoint will return all BM acceptances, table bids and table offers for the given date and period.

If the date, option and searchString fields are provided in the request object, this endpoint will return all BM acceptances for the given date filtered by either plant or fuel, depending on the option.

Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!