This endpoint returns a series of data, matching the requested series and date range. You can visualise various Enact series on Enact's dashboard 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_series_data(
"OutturnFuel",
date(2023,6,21),
date(2023,6,23),
"Gb",
option_id=["Coal"],
time_zone_id="UTC",
parse_datetimes=True # optionally parse dates to datetimes and index by them (ascending)
)
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_series_data_async(
"OutturnFuel",
date(2023,6,21),
date(2023,6,23),
"Gb",
option_id=["Coal"],
time_zone_id="UTC",
parse_datetimes=True # optionally parse dates to datetimes and index by them (ascending)
)
print(response_dataframe)
asyncio.run(main())Using the API Directly
The response object is a dictionary of data keyed by column header with lists of data values. The first key-value pair will always be the datetime values for the requested date range.
To request data for a single day, set the from and to fields in the request body equal to each other.
The response object holds all data for the requested series. If the optionId field is unspecified then the header will be of the form 'CountryId&SeriesId', otherwise 'CountryId&SeriesId&OptionId'.
If the return data has additional data points, the header will be appended with '- additional', '- additional 2', etc. If the series is an EPEX OHLC chart, the header will be appended with '- Open', '- High', '- Low', '- Close'.