This endpoint returns the information related to an index on Enact's GB index page, for example the selected fuels, zones, owners.

To access an index's information, you'll need its corresponding GUID which can be found by clicking the ID icon next to an index on the GB index page.

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_gb_index_information(
    index_id = "fa8e0adc-399a-40e5-adaf-27f973f98985",
)

print(response_dataframe)

Asynchronous

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 = enact_api_helper.get_gb_index_information_async(
    index_id = "fa8e0adc-399a-40e5-adaf-27f973f98985",
)

    print(response_dataframe)

asyncio.run(main())