swagger_client.DatasetsApi

July 10, 2024 · View on GitHub

All URIs are relative to https://data.elexon.co.uk/bmrs/api/v1

Method	HTTP request	Description
datasets_abuc_get	GET /datasets/ABUC	Amount Of Balancing Reserves Under Contract (ABUC / B1720)
datasets_abuc_stream_get	GET /datasets/ABUC/stream	Amount Of Balancing Reserves Under Contract (ABUC / B1720) stream
datasets_agpt_get	GET /datasets/AGPT	Actual Aggregated Generation Per Type (AGPT / B1620)
datasets_agpt_stream_get	GET /datasets/AGPT/stream	Actual Aggregated Generation Per Type (AGPT / B1620) stream
datasets_agws_get	GET /datasets/AGWS	Actual Or Estimated Wind And Solar Power Generation (AGWS / B1630)
datasets_agws_stream_get	GET /datasets/AGWS/stream	Actual Or Estimated Wind And Solar Power Generation (AGWS / B1630) stream
datasets_aobe_get	GET /datasets/AOBE	Accepted Offered Balancing Energy (AOBE)
datasets_aobe_stream_get	GET /datasets/AOBE/stream	Accepted Offered Balancing Energy (AOBE) stream
datasets_atl_get	GET /datasets/ATL	Actual Total Load Per Bidding Zone (ATL / B0610)
datasets_atl_stream_get	GET /datasets/ATL/stream	Actual Total Load Per Bidding Zone (ATL / B0610) stream
datasets_b1610_get	GET /datasets/B1610	Actual Generation Output Per Generation Unit (B1610)
datasets_b1610_stream_get	GET /datasets/B1610/stream	Actual Generation Output Per Generation Unit (B1610) stream
datasets_beb_get	GET /datasets/BEB	Balancing Energy Bids (BEB)
datasets_beb_stream_get	GET /datasets/BEB/stream	Balancing Energy Bids (BEB) stream
datasets_boalf_get	GET /datasets/BOALF	Bid Offer Acceptance Level Flagged (BOALF)
datasets_boalf_stream_get	GET /datasets/BOALF/stream	Bid Offer Acceptance Level Flagged (BOALF) stream
datasets_bod_get	GET /datasets/BOD	Bid Offer Data (BOD)
datasets_bod_stream_get	GET /datasets/BOD/stream	Bid-Offer Data (BOD) stream
datasets_cbs_get	GET /datasets/CBS	Current Balancing State (CBS)
datasets_cbs_stream_get	GET /datasets/CBS/stream	Current Balancing State (CBS) stream
datasets_ccm_get	GET /datasets/CCM	Cost of Congestion Management (CCM / B1330)
datasets_ccm_stream_get	GET /datasets/CCM/stream	Cost of Congestion Management (CCM / B1330) stream
datasets_cdn_get	GET /datasets/CDN	Credit default notices (CDN)
datasets_cdn_stream_get	GET /datasets/CDN/stream	Credit default notices (CDN)
datasets_dag_get	GET /datasets/DAG	Day-Ahead Aggregated Generation (DAG / B1430)
datasets_dag_stream_get	GET /datasets/DAG/stream	Day-Ahead Aggregated Generation (DAG / B1430) stream
datasets_datl_get	GET /datasets/DATL	Day-Ahead Total Load Forecast Per Bidding Zone (DATL / B0620)
datasets_datl_stream_get	GET /datasets/DATL/stream	Day-Ahead Total Load Forecast Per Bidding Zone (DATL / B0620) stream
datasets_dci_get	GET /datasets/DCI	Demand control instructions (DCI)
datasets_dci_stream_get	GET /datasets/DCI/stream	Demand control instructions (DCI) stream
datasets_dgws_get	GET /datasets/DGWS	Day-Ahead Generation For Wind And Solar (DGWS / B1440)
datasets_dgws_stream_get	GET /datasets/DGWS/stream	Day-Ahead Generation For Wind And Solar (DGWS / B1440) stream
datasets_disbsad_get	GET /datasets/DISBSAD	Disaggregated Balancing Services Adjustment Data (DISBSAD)
datasets_disbsad_stream_get	GET /datasets/DISBSAD/stream	Disaggregated Balancing Services Adjustment Data (DISBSAD) stream
datasets_feib_get	GET /datasets/FEIB	Financial Expenses and Income for Balancing (FEIB / B1790)
datasets_feib_stream_get	GET /datasets/FEIB/stream	Financial Expenses and Income for Balancing (FEIB / B1790) stream
datasets_fou2_t14_d_get	GET /datasets/FOU2T14D	2 to 14 days ahead generation availability aggregated by fuel type (FOU2T14D)
datasets_fou2_t3_yw_get	GET /datasets/FOU2T3YW	2 to 156 weeks ahead generation availability aggregated by fuel type (FOU2T3YW)
datasets_freq_get	GET /datasets/FREQ	System frequency (FREQ)
datasets_freq_stream_get	GET /datasets/FREQ/stream	System frequency (FREQ) stream
datasets_fuelhh_get	GET /datasets/FUELHH	Half-hourly generation outturn by fuel type (FUELHH)
datasets_fuelhh_stream_get	GET /datasets/FUELHH/stream	Half-hourly generation outturn by fuel type (FUELHH) stream
datasets_fuelinst_get	GET /datasets/FUELINST	Instantaneous generation outturn by fuel type (FUELINST)
datasets_fuelinst_stream_get	GET /datasets/FUELINST/stream	Instantaneous generation outturn by fuel type (FUELINST) stream
datasets_igca_get	GET /datasets/IGCA	Installed Generation Capacity Aggregated (IGCA / B1410)
datasets_igca_stream_get	GET /datasets/IGCA/stream	Installed Generation Capacity Aggregated (IGCA / B1410) stream
datasets_igcpu_get	GET /datasets/IGCPU	Installed Generation Capacity per Unit (IGCPU / B1420)
datasets_igcpu_stream_get	GET /datasets/IGCPU/stream	Installed Generation Capacity per Unit (IGCPU / B1420) stream
datasets_imbalngc_get	GET /datasets/IMBALNGC	Day and day-ahead indicated imbalance (IMBALNGC)
datasets_imbalngc_stream_get	GET /datasets/IMBALNGC/stream	Day and day-ahead indicated imbalance (IMBALNGC) stream
datasets_inddem_get	GET /datasets/INDDEM	Day and day-ahead indicated demand (INDDEM)
datasets_inddem_stream_get	GET /datasets/INDDEM/stream	Day and day-ahead indicated demand (INDDEM) stream
datasets_indgen_get	GET /datasets/INDGEN	Day and day-ahead indicated generation (INDGEN)
datasets_indgen_stream_get	GET /datasets/INDGEN/stream	Day and day-ahead indicated generation (INDGEN) stream
datasets_indo_get	GET /datasets/INDO	Initial National Demand outturn (INDO)
datasets_indod_get	GET /datasets/INDOD	Initial National Demand outturn daily (INDOD)
datasets_indod_stream_get	GET /datasets/INDOD/stream	Initial National Demand outturn daily (INDOD) stream
datasets_itsdo_get	GET /datasets/ITSDO	Initial Transmission System Demand outturn (ITSDO)
datasets_lolpdrm_get	GET /datasets/LOLPDRM	Loss of load probability and de-rated margin (LOLPDRM)
datasets_lolpdrm_stream_get	GET /datasets/LOLPDRM/stream	Loss of load probability and de-rated margin (LOLPDRM)
datasets_matl_get	GET /datasets/MATL	Month-Ahead Total Load Forecast Per Bidding Zone (MATL / B0640)
datasets_matl_stream_get	GET /datasets/MATL/stream	Month-Ahead Total Load Forecast Per Bidding Zone (MATL / B0640) stream
datasets_mdp_get	GET /datasets/MDP	Maximum Delivery Period (MDP)
datasets_mdp_stream_get	GET /datasets/MDP/stream	Maximum Delivery Period (MDP) stream
datasets_mdv_get	GET /datasets/MDV	Maximum Delivery Volume (MDV)
datasets_mdv_stream_get	GET /datasets/MDV/stream	Maximum Delivery Volume (MDV) stream
datasets_melngc_get	GET /datasets/MELNGC	Day and day-ahead indicated margin (MELNGC)
datasets_melngc_stream_get	GET /datasets/MELNGC/stream	Day and day-ahead indicated margin (MELNGC) stream
datasets_mels_get	GET /datasets/MELS	Maximum Export Limit (MELS)
datasets_mels_stream_get	GET /datasets/MELS/stream	Maximum Export Limit (MELS) stream
datasets_metadata_latest_get	GET /datasets/metadata/latest	Returns the time when each dataset was last updated
datasets_mid_get	GET /datasets/MID	Market Index Data (MID)
datasets_mid_stream_get	GET /datasets/MID/stream	Market Index Data (MID) stream
datasets_mils_get	GET /datasets/MILS	Maximum Import Limit (MILS)
datasets_mils_stream_get	GET /datasets/MILS/stream	Maximum Import Limit (MILS) stream
datasets_mnzt_get	GET /datasets/MNZT	Minimum Non-Zero Time (MNZT)
datasets_mnzt_stream_get	GET /datasets/MNZT/stream	Minimum Non-Zero Time (MNZT) stream
datasets_mzt_get	GET /datasets/MZT	Minimum Zero Time (MZT)
datasets_mzt_stream_get	GET /datasets/MZT/stream	Minimum Zero Time (MZT) stream
datasets_ndf_get	GET /datasets/NDF	Day and day-ahead National Demand forecast (NDF)
datasets_ndf_stream_get	GET /datasets/NDF/stream	Day and day-ahead National Demand forecast (NDF) stream
datasets_ndfd_get	GET /datasets/NDFD	2-14 days ahead National Demand and surplus forecast (NDFD)
datasets_ndfd_stream_get	GET /datasets/NDFD/stream	2-14 days ahead National Demand and surplus forecast (NDFD) stream
datasets_ndfw_get	GET /datasets/NDFW	2-52 weeks ahead National Demand and surplus forecast (NDFW)
datasets_ndfw_stream_get	GET /datasets/NDFW/stream	2-52 weeks ahead National Demand and surplus forecast (NDFW) stream
datasets_ndz_get	GET /datasets/NDZ	Notice to Deviate from Zero (NDZ)
datasets_ndz_stream_get	GET /datasets/NDZ/stream	Notice to Deviate from Zero (NDZ) stream
datasets_netbsad_get	GET /datasets/NETBSAD	Net Balancing Services Adjustment Data (NETBSAD)
datasets_netbsad_stream_get	GET /datasets/NETBSAD/stream	Net Balancing Services Adjustment Data (NETBSAD)
datasets_nonbm_get	GET /datasets/NONBM	Non-BM STOR (NONBM)
datasets_nonbm_stream_get	GET /datasets/NONBM/stream	Non-BM STOR (NONBM) stream
datasets_nou2_t14_d_get	GET /datasets/NOU2T14D	2 to 14 days ahead generation availability aggregated data (NOU2T14D)
datasets_nou2_t3_yw_get	GET /datasets/NOU2T3YW	2 to 156 weeks ahead generation availability aggregated data (NOU2T3YW)
datasets_ntb_get	GET /datasets/NTB	Notice to Deliver Bids (NTB)
datasets_ntb_stream_get	GET /datasets/NTB/stream	Notice to Deliver Bids (NTB) stream
datasets_nto_get	GET /datasets/NTO	Notice to Deliver Offers (NTO)
datasets_nto_stream_get	GET /datasets/NTO/stream	Notice to Deliver Offers (NTO) stream
datasets_ocnmf3_y2_get	GET /datasets/OCNMF3Y2	2-156 weeks ahead demand margin forecast (OCNMF3Y2)
datasets_ocnmf3_y2_stream_get	GET /datasets/OCNMF3Y2/stream	2-156 weeks ahead demand margin forecast (OCNMF3Y2) stream
datasets_ocnmf3_y_get	GET /datasets/OCNMF3Y	2-156 weeks ahead demand surplus forecast (OCNMF3Y)
datasets_ocnmf3_y_stream_get	GET /datasets/OCNMF3Y/stream	2-156 weeks ahead demand surplus forecast (OCNMF3Y) stream
datasets_ocnmfd2_get	GET /datasets/OCNMFD2	2-14 days ahead demand margin forecast (OCNMFD2)
datasets_ocnmfd2_stream_get	GET /datasets/OCNMFD2/stream	2-14 days ahead demand margin forecast (OCNMFD2) stream
datasets_ocnmfd_get	GET /datasets/OCNMFD	2-14 days ahead demand surplus forecast (OCNMFD)
datasets_ocnmfd_stream_get	GET /datasets/OCNMFD/stream	2-14 days ahead demand surplus forecast (OCNMFD) stream
datasets_pbc_get	GET /datasets/PBC	Procured Balancing Capacity (PBC)
datasets_pbc_stream_get	GET /datasets/PBC/stream	Procured Balancing Capacity (PBC) stream
datasets_pn_get	GET /datasets/PN	Physical Notifications (PN)
datasets_pn_stream_get	GET /datasets/PN/stream	Physical Notifications (PN) stream
datasets_ppbr_get	GET /datasets/PPBR	Prices Of Procured Balancing Reserves (PPBR / B1730)
datasets_ppbr_stream_get	GET /datasets/PPBR/stream	Prices Of Procured Balancing Reserves (PPBR / B1730) stream
datasets_qas_get	GET /datasets/QAS	Balancing Services Volume (QAS)
datasets_qas_stream_get	GET /datasets/QAS/stream	Balancing Services Volume (QAS) stream
datasets_qpn_get	GET /datasets/QPN	Quiescent Physical Notifications (QPN)
datasets_qpn_stream_get	GET /datasets/QPN/stream	Quiescent Physical Notifications (QPN) stream
datasets_rdre_get	GET /datasets/RDRE	Run Down Rate Export (RDRE)
datasets_rdre_stream_get	GET /datasets/RDRE/stream	Run Down Rate Export (RDRE) stream
datasets_rdri_get	GET /datasets/RDRI	Run Down Rate Import (RDRI)
datasets_rdri_stream_get	GET /datasets/RDRI/stream	Run Down Rate Import (RDRI) stream
datasets_remit_get	GET /datasets/REMIT	The Regulation on Wholesale Energy Markets Integrity and Transparency (REMIT)
datasets_remit_stream_get	GET /datasets/REMIT/stream	The Regulation on Wholesale Energy Markets Integrity and Transparency (REMIT) stream
datasets_rure_get	GET /datasets/RURE	Run Up Rate Export (RURE)
datasets_rure_stream_get	GET /datasets/RURE/stream	Run Up Rate Export (RURE) stream
datasets_ruri_get	GET /datasets/RURI	Run Up Rate Import (RURI)
datasets_ruri_stream_get	GET /datasets/RURI/stream	Run Up Rate Import (RURI) stream
datasets_sel_get	GET /datasets/SEL	Stable Export Limit (SEL)
datasets_sel_stream_get	GET /datasets/SEL/stream	Stable Export Limit (SEL) stream
datasets_sil_get	GET /datasets/SIL	Stable Import Limit (SIL)
datasets_sil_stream_get	GET /datasets/SIL/stream	Stable Import Limit (SIL) stream
datasets_soso_get	GET /datasets/SOSO	SO-SO prices (SOSO)
datasets_soso_stream_get	GET /datasets/SOSO/stream	SO-SO prices (SOSO) stream
datasets_syswarn_get	GET /datasets/SYSWARN	System warnings (SYSWARN)
datasets_syswarn_stream_get	GET /datasets/SYSWARN/stream	System warnings (SYSWARN) stream
datasets_temp_get	GET /datasets/TEMP	Temperature data (TEMP)
datasets_tsdf_get	GET /datasets/TSDF	Day and day-ahead Transmission System Demand forecast (TSDF)
datasets_tsdf_stream_get	GET /datasets/TSDF/stream	Day and day-ahead Transmission System Demand forecast (TSDF) stream
datasets_tsdfd_get	GET /datasets/TSDFD	2-14 days ahead Transmission System Demand and surplus forecast (TSDFD)
datasets_tsdfd_stream_get	GET /datasets/TSDFD/stream	2-14 days ahead Transmission System Demand and surplus forecast (TSDFD) stream
datasets_tsdfw_get	GET /datasets/TSDFW	2-52 weeks ahead Transmission System Demand and surplus forecast (TSDFW)
datasets_tsdfw_stream_get	GET /datasets/TSDFW/stream	2-52 weeks ahead Transmission System Demand and surplus forecast (TSDFW) stream
datasets_tudm_get	GET /datasets/TUDM	Trading unit data (S0491_TUDM)
datasets_tudm_stream_get	GET /datasets/TUDM/stream	Trading unit data (S0491_TUDM) stream
datasets_uou2_t14_d_get	GET /datasets/UOU2T14D	2 to 14 days ahead generation availability aggregated by Balancing Mechanism Units (UOU2T14D)
datasets_uou2_t14_d_stream_get	GET /datasets/UOU2T14D/stream	2 to 14 days ahead generation availability aggregated by Balancing Mechanism Units (UOU2T14D) stream
datasets_uou2_t3_yw_get	GET /datasets/UOU2T3YW	2 to 156 weeks ahead generation availability aggregated by Balancing Mechanism Units (UOU2T3YW)
datasets_uou2_t3_yw_stream_get	GET /datasets/UOU2T3YW/stream	2 to 156 weeks ahead generation availability aggregated by Balancing Mechanism Units (UOU2T3YW) stream
datasets_watl_get	GET /datasets/WATL	Week-Ahead Total Load Forecast Per Bidding Zone (WATL / B0630)
datasets_watl_stream_get	GET /datasets/WATL/stream	Week-Ahead Total Load Forecast Per Bidding Zone (WATL / B0630) stream
datasets_windfor_get	GET /datasets/WINDFOR	Wind generation forecast (WINDFOR)
datasets_windfor_stream_get	GET /datasets/WINDFOR/stream	Wind generation forecast (WINDFOR) stream
datasets_yafm_get	GET /datasets/YAFM	Year Ahead Forecast Margin (YAFM / B0810)
datasets_yafm_stream_get	GET /datasets/YAFM/stream	Year Ahead Forecast Margin (YAFM / B0810) stream
datasets_yatl_get	GET /datasets/YATL	Year-Ahead Total Load Forecast Per Bidding Zone (YATL / B0650)
datasets_yatl_stream_get	GET /datasets/YATL/stream	Year-Ahead Total Load Forecast Per Bidding Zone (YATL / B0650) stream

datasets_abuc_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsAbucDatasetRow datasets_abuc_get(publish_date_time_from, publish_date_time_to, format=format)

Amount Of Balancing Reserves Under Contract (ABUC / B1720)

This endpoint provides amount of balancing reserves under contract data. This API endpoint has a maximum range of 2 years (731 days).

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Amount Of Balancing Reserves Under Contract (ABUC / B1720)
    api_response = api_instance.datasets_abuc_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_abuc_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsAbucDatasetRow

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_abuc_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsAbucDatasetRow] datasets_abuc_stream_get(publish_date_time_from, publish_date_time_to)

Amount Of Balancing Reserves Under Contract (ABUC / B1720) stream

This endpoint provides amount of balancing reserves under contract data. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Amount Of Balancing Reserves Under Contract (ABUC / B1720) stream
    api_response = api_instance.datasets_abuc_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_abuc_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsAbucDatasetRow]

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_agpt_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsActualAggregatedGenerationPerTypeDatasetRow datasets_agpt_get(publish_date_time_from, publish_date_time_to, format=format)

Actual Aggregated Generation Per Type (AGPT / B1620)

This endpoint provides actual generation data per settlement period aggregated by Power System Resource type (Fuel Type categories as defined by Commission Regulation (EU) No 543/2013). This endpoint filters by publishTime and provides a maximum data output range of 4 days.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Actual Aggregated Generation Per Type (AGPT / B1620)
    api_response = api_instance.datasets_agpt_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_agpt_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsActualAggregatedGenerationPerTypeDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_agpt_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsActualAggregatedGenerationPerTypeDatasetRow] datasets_agpt_stream_get(publish_date_time_from, publish_date_time_to)

Actual Aggregated Generation Per Type (AGPT / B1620) stream

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Actual Aggregated Generation Per Type (AGPT / B1620) stream
    api_response = api_instance.datasets_agpt_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_agpt_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsActualAggregatedGenerationPerTypeDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_agws_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsActualGenerationWindSolarDatasetRow datasets_agws_get(publish_date_time_from, publish_date_time_to, format=format)

Actual Or Estimated Wind And Solar Power Generation (AGWS / B1630)

This endpoint provides actual or estimated wind and solar power generation per settlement period. It returns generation with Power System Resource type Solar, Wind Onshore or Wind Offshore (Fuel Type categories as defined by Commission Regulation (EU) No 543/2013). This API endpoint provides a maximum data output range of 7 days.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Actual Or Estimated Wind And Solar Power Generation (AGWS / B1630)
    api_response = api_instance.datasets_agws_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_agws_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsActualGenerationWindSolarDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_agws_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsActualGenerationWindSolarDatasetRow] datasets_agws_stream_get(publish_date_time_from, publish_date_time_to)

Actual Or Estimated Wind And Solar Power Generation (AGWS / B1630) stream

This endpoint provides actual or estimated wind and solar power generation per settlement period. It returns generation with Power System Resource type Solar, Wind Onshore or Wind Offshore (Fuel Type categories as defined by Commission Regulation (EU) No 543/2013). This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Actual Or Estimated Wind And Solar Power Generation (AGWS / B1630) stream
    api_response = api_instance.datasets_agws_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_agws_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsActualGenerationWindSolarDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_aobe_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsAobeDatasetRow datasets_aobe_get(publish_date_time_from, publish_date_time_to, format=format)

Accepted Offered Balancing Energy (AOBE)

This endpoint provides accepted offered balancing energy data. This API endpoint has a maximum range of 7 days.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Accepted Offered Balancing Energy (AOBE)
    api_response = api_instance.datasets_aobe_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_aobe_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsAobeDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_aobe_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsAobeDatasetRow] datasets_aobe_stream_get(publish_date_time_from, publish_date_time_to)

Accepted Offered Balancing Energy (AOBE) stream

This endpoint provides accepted offered balancing energy data. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Accepted Offered Balancing Energy (AOBE) stream
    api_response = api_instance.datasets_aobe_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_aobe_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsAobeDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_atl_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsActualTotalLoadPerBiddingZoneDatasetRow datasets_atl_get(publish_date_time_from, publish_date_time_to, format=format)

Actual Total Load Per Bidding Zone (ATL / B0610)

This endpoint provides actual total load per bidding zone data. This API endpoint provides a maximum data output range of 7 days.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Actual Total Load Per Bidding Zone (ATL / B0610)
    api_response = api_instance.datasets_atl_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_atl_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsActualTotalLoadPerBiddingZoneDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_atl_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsActualTotalLoadPerBiddingZoneDatasetRow] datasets_atl_stream_get(publish_date_time_from, publish_date_time_to)

Actual Total Load Per Bidding Zone (ATL / B0610) stream

This endpoint provides actual total load per bidding zone data. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Actual Total Load Per Bidding Zone (ATL / B0610) stream
    api_response = api_instance.datasets_atl_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_atl_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsActualTotalLoadPerBiddingZoneDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_b1610_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsActualGenerationOutputPerGenerationUnitDatasetResponse datasets_b1610_get(settlement_date, settlement_period, bm_unit=bm_unit, format=format)

Actual Generation Output Per Generation Unit (B1610)

This endpoint provides the actual metered volume output (MWh) per Settlement Period for all BM units (Positive, Negative or zero MWh values). The settlement period to query must be specified as a date and settlement period. The date must be given in the format yyyy-MM-dd. The information is published five days after the end of the operational period based on the Interim Information (II) Settlement Run and the data is refreshed by subsequent Settlement Runs. The generation output returned by this endpoint is the metered volume and not the instantaneous power output as often appears in other specifications.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
settlement_date = '2013-10-20'  # date | 
settlement_period = 56  # int | 
bm_unit = ['bm_unit_example']  # list[str] |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Actual Generation Output Per Generation Unit (B1610)
    api_response = api_instance.datasets_b1610_get(settlement_date, settlement_period, bm_unit=bm_unit, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_b1610_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
settlement_date	date
settlement_period	int
bm_unit	list[str]		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsActualGenerationOutputPerGenerationUnitDatasetResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_b1610_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsActualGenerationOutputPerGenerationUnitDatasetResponse] datasets_b1610_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Actual Generation Output Per Generation Unit (B1610) stream

This endpoint provides the actual metered volume output (MWh) per Settlement Period for all BM units (Positive, Negative or zero MWh values). The information is published five days after the end of the operational period based on the Interim Information (II) Settlement Run and the data is refreshed by subsequent Settlement Runs. The generation output returned by this endpoint is the metered volume and not the instantaneous power output as often appears in other specifications. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = ['bm_unit_example']  # list[str] |  (optional)

try:
    # Actual Generation Output Per Generation Unit (B1610) stream
    api_response = api_instance.datasets_b1610_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                          settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_b1610_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]		[optional]

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsActualGenerationOutputPerGenerationUnitDatasetResponse]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_beb_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsBebDatasetRow datasets_beb_get(publish_date_time_from, publish_date_time_to, format=format)

Balancing Energy Bids (BEB)

This endpoint provides information on all balancing energy bids, in accordance with the Electricity Balancing Guidelines (EBGL) article 12.3.b. This API endpoint has a maximum range of 7 days.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Balancing Energy Bids (BEB)
    api_response = api_instance.datasets_beb_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_beb_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsBebDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_beb_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsBebDatasetRow] datasets_beb_stream_get(publish_date_time_from, publish_date_time_to)

Balancing Energy Bids (BEB) stream

This endpoint provides information on all balancing energy bids, in accordance with the Electricity Balancing Guidelines (EBGL) article 12.3.b. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Balancing Energy Bids (BEB) stream
    api_response = api_instance.datasets_beb_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_beb_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsBebDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_boalf_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDatasetRowsBidOfferAcceptanceLevelDatasetResponse datasets_boalf_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit, format=format)

Bid Offer Acceptance Level Flagged (BOALF)

This endpoint provides bid offer acceptance data. By default, the from and to parameters filter the data inclusively and this endpoint will return any data where TimeFrom is within the requested time range. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, it will instead filter to return any data where TimeFrom is within the specified range of settlement periods. It is possible to search using a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from datetime to datetime /datasets/boalf?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from datetime to settlement date and period: /datasets/boalf?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to datetime: /datasets/boalf?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/boalf?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Bid Offer Acceptance Level Flagged (BOALF)
    api_response = api_instance.datasets_boalf_get(_from, to, settlement_period_from=settlement_period_from,
                                                   settlement_period_to=settlement_period_to, bm_unit=bm_unit,
                                                   format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_boalf_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDatasetRowsBidOfferAcceptanceLevelDatasetResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_boalf_stream_get

list[InsightsApiModelsResponsesBalancingDatasetRowsBidOfferAcceptanceLevelDatasetResponse] datasets_boalf_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Bid Offer Acceptance Level Flagged (BOALF) stream

This endpoint provides bid offer acceptance data. By default, the from and to parameters filter the data inclusively and this endpoint will return any data where TimeFrom is within the requested time range. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, it will instead filter to return any data where TimeFrom is within the specified range of settlement periods. It is possible to search using a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from datetime to datetime /datasets/boalf/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from datetime to settlement date and period: /datasets/boalf/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to datetime: /datasets/boalf/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/boalf/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Bid Offer Acceptance Level Flagged (BOALF) stream
    api_response = api_instance.datasets_boalf_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                          settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_boalf_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDatasetRowsBidOfferAcceptanceLevelDatasetResponse]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_bod_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDatasetRowsBidOfferDatasetResponse datasets_bod_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit, format=format)

Bid Offer Data (BOD)

This endpoint provides bid-offer data. By default, the from and to parameters filter the data inclusively and this endpoint will return any data where TimeFrom is within the requested time range. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, it will instead filter to return any data where TimeFrom is within the specified range of settlement periods. It is possible to search using a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from a datetime to a datetime /datasets/bod?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from a datetime to a settlement date and period: /datasets/bod?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from a settlement date and period to a datetime: /datasets/bod?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from a settlement date and period to a settlement date and period: /datasets/bod?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Bid Offer Data (BOD)
    api_response = api_instance.datasets_bod_get(_from, to, settlement_period_from=settlement_period_from,
                                                 settlement_period_to=settlement_period_to, bm_unit=bm_unit,
                                                 format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_bod_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDatasetRowsBidOfferDatasetResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_bod_stream_get

list[InsightsApiModelsResponsesBalancingDatasetRowsBidOfferDatasetResponse] datasets_bod_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Bid-Offer Data (BOD) stream

This endpoint provides bid-offer data. By default, the from and to parameters filter the data inclusively and this endpoint will return any data where TimeFrom is within the requested time range. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, it will instead filter to return any data where TimeFrom is within the specified range of settlement periods. It is possible to search using a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from datetime to datetime /datasets/bod/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from datetime to settlement date and period: /datasets/bod/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to datetime: /datasets/bod/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/bod/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Bid-Offer Data (BOD) stream
    api_response = api_instance.datasets_bod_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                        settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_bod_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDatasetRowsBidOfferDatasetResponse]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_cbs_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsCbsDatasetRow datasets_cbs_get(publish_date_time_from, publish_date_time_to, format=format)

Current Balancing State (CBS)

This endpoint provides information on the current system balance, in accordance with the Electricity Balancing Guidelines (EBGL) article 12.3.a. This API endpoint has a maximum range of 1 day.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Current Balancing State (CBS)
    api_response = api_instance.datasets_cbs_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_cbs_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsCbsDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_cbs_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsCbsDatasetRow] datasets_cbs_stream_get(publish_date_time_from, publish_date_time_to)

Current Balancing State (CBS) stream

This endpoint provides information on the current system balance, in accordance with the Electricity Balancing Guidelines (EBGL) article 12.3.a. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Current Balancing State (CBS) stream
    api_response = api_instance.datasets_cbs_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_cbs_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsCbsDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ccm_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsCostsOfCongestionManagementDatasetRow datasets_ccm_get(publish_date_time_from, publish_date_time_to, format=format)

Cost of Congestion Management (CCM / B1330)

This endpoint provides cost of congestion management data. This API endpoint has a maximum range of 2 years (731 days).

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Cost of Congestion Management (CCM / B1330)
    api_response = api_instance.datasets_ccm_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ccm_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsCostsOfCongestionManagementDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ccm_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsCostsOfCongestionManagementDatasetRow] datasets_ccm_stream_get(publish_date_time_from, publish_date_time_to)

Cost of Congestion Management (CCM / B1330) stream

This endpoint provides cost of congestion management data. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Cost of Congestion Management (CCM / B1330) stream
    api_response = api_instance.datasets_ccm_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ccm_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsCostsOfCongestionManagementDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_cdn_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDatasetRowsCreditDefaultNoticeDatasetResponse datasets_cdn_get(publish_date_time_from, publish_date_time_to, bsc_party_id=bsc_party_id, format=format)

Credit default notices (CDN)

This endpoint provides CDN data received from EC.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
bsc_party_id = 'bsc_party_id_example'  # str |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Credit default notices (CDN)
    api_response = api_instance.datasets_cdn_get(publish_date_time_from, publish_date_time_to,
                                                 bsc_party_id=bsc_party_id, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_cdn_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
bsc_party_id	str		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDatasetRowsCreditDefaultNoticeDatasetResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_cdn_stream_get

list[InsightsApiModelsResponsesBalancingDatasetRowsCreditDefaultNoticeDatasetResponse] datasets_cdn_stream_get(publish_date_time_from, publish_date_time_to, bsc_party_id=bsc_party_id)

Credit default notices (CDN)

This endpoint provides CDN data received from EC. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
bsc_party_id = 'bsc_party_id_example'  # str |  (optional)

try:
    # Credit default notices (CDN)
    api_response = api_instance.datasets_cdn_stream_get(publish_date_time_from, publish_date_time_to,
                                                        bsc_party_id=bsc_party_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_cdn_stream_get: %s\n" % e)

Parameters

Name	Type	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
bsc_party_id	str	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDatasetRowsCreditDefaultNoticeDatasetResponse]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_dag_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsDayAheadAggregatedGenerationDatasetRow datasets_dag_get(publish_date_time_from, publish_date_time_to, format=format)

Day-Ahead Aggregated Generation (DAG / B1430)

This endpoint provides day-ahead aggregated generation data. It has a maximum date range of 7 days.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Day-Ahead Aggregated Generation (DAG / B1430)
    api_response = api_instance.datasets_dag_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_dag_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsDayAheadAggregatedGenerationDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_dag_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsDayAheadAggregatedGenerationDatasetRow] datasets_dag_stream_get(publish_date_time_from, publish_date_time_to)

Day-Ahead Aggregated Generation (DAG / B1430) stream

This endpoint provides day-ahead aggregated generation data. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Day-Ahead Aggregated Generation (DAG / B1430) stream
    api_response = api_instance.datasets_dag_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_dag_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsDayAheadAggregatedGenerationDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_datl_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsDayAheadTotalLoadPerBiddingZoneDatasetRow datasets_datl_get(publish_date_time_from, publish_date_time_to, format=format)

Day-Ahead Total Load Forecast Per Bidding Zone (DATL / B0620)

This endpoint provides day-ahead total load forecast per bidding zone data. This API endpoint provides a maximum data output range of 7 days.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Day-Ahead Total Load Forecast Per Bidding Zone (DATL / B0620)
    api_response = api_instance.datasets_datl_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_datl_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsDayAheadTotalLoadPerBiddingZoneDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_datl_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsDayAheadTotalLoadPerBiddingZoneDatasetRow] datasets_datl_stream_get(publish_date_time_from, publish_date_time_to)

Day-Ahead Total Load Forecast Per Bidding Zone (DATL / B0620) stream

This endpoint provides day-ahead total load forecast per bidding zone data. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Day-Ahead Total Load Forecast Per Bidding Zone (DATL / B0620) stream
    api_response = api_instance.datasets_datl_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_datl_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsDayAheadTotalLoadPerBiddingZoneDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_dci_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesMiscDatasetRowsDemandControlInstructionDatasetRow datasets_dci_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

Demand control instructions (DCI)

This endpoint provides demand control instruction data, filtered by publish time.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Demand control instructions (DCI)
    api_response = api_instance.datasets_dci_get(publish_date_time_from=publish_date_time_from,
                                                 publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_dci_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesMiscDatasetRowsDemandControlInstructionDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_dci_stream_get

list[InsightsApiModelsResponsesMiscDatasetRowsDemandControlInstructionDatasetRow] datasets_dci_stream_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to)

Demand control instructions (DCI) stream

This endpoint provides demand control instruction data, filtered by publish time. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # Demand control instructions (DCI) stream
    api_response = api_instance.datasets_dci_stream_get(publish_date_time_from=publish_date_time_from,
                                                        publish_date_time_to=publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_dci_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]

Return type

list[InsightsApiModelsResponsesMiscDatasetRowsDemandControlInstructionDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_dgws_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsDayAheadGenerationForWindAndSolarDatasetRow datasets_dgws_get(publish_date_time_from, publish_date_time_to, format=format)

Day-Ahead Generation For Wind And Solar (DGWS / B1440)

This endpoint provides day-ahead generation data for wind and solar. This API endpoint provides a maximum data output range of 7 days.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Day-Ahead Generation For Wind And Solar (DGWS / B1440)
    api_response = api_instance.datasets_dgws_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_dgws_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsDayAheadGenerationForWindAndSolarDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_dgws_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsDayAheadGenerationForWindAndSolarDatasetRow] datasets_dgws_stream_get(publish_date_time_from, publish_date_time_to)

Day-Ahead Generation For Wind And Solar (DGWS / B1440) stream

This endpoint provides day-ahead generation data for wind and solar. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Day-Ahead Generation For Wind And Solar (DGWS / B1440) stream
    api_response = api_instance.datasets_dgws_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_dgws_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsDayAheadGenerationForWindAndSolarDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_disbsad_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDatasetRowsDisaggregatedBalancingServicesAdjustmentData datasets_disbsad_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, format=format)

Disaggregated Balancing Services Adjustment Data (DISBSAD)

This endpoint provides Disaggregated Balancing Services Adjustment data received from NGESO. Disaggregated Balancing Services Adjustment data covers a set of adjustment actions, cost and volume values for each Settlement Period. Adjustment costs are shown in £. Adjustment volumes are shown in MWh. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/disbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/disbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/disbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/disbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Disaggregated Balancing Services Adjustment Data (DISBSAD)
    api_response = api_instance.datasets_disbsad_get(_from, to, settlement_period_from=settlement_period_from,
                                                     settlement_period_to=settlement_period_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_disbsad_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDatasetRowsDisaggregatedBalancingServicesAdjustmentData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_disbsad_stream_get

list[InsightsApiModelsResponsesBalancingDatasetRowsDisaggregatedBalancingServicesAdjustmentData] datasets_disbsad_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to)

Disaggregated Balancing Services Adjustment Data (DISBSAD) stream

This endpoint provides Disaggregated Balancing Services Adjustment data received from NGESO. Disaggregated Balancing Services Adjustment data covers a set of adjustment actions, cost and volume values for each Settlement Period. Adjustment costs are shown in £. Adjustment volumes are shown in MWh. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/disbsad/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/disbsad/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/disbsad/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/disbsad/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1 This endpoint has an optimised JSON payload and is aimed at frequent requests for DISBSAD data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)

try:
    # Disaggregated Balancing Services Adjustment Data (DISBSAD) stream
    api_response = api_instance.datasets_disbsad_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                            settlement_period_to=settlement_period_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_disbsad_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDatasetRowsDisaggregatedBalancingServicesAdjustmentData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_feib_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsFeibDatasetRow datasets_feib_get(publish_date_time_from, publish_date_time_to, format=format)

Financial Expenses and Income for Balancing (FEIB / B1790)

This endpoint provides financial expenses and income for balancing data. This API endpoint has a maximum range of 1 year (367 days).

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Financial Expenses and Income for Balancing (FEIB / B1790)
    api_response = api_instance.datasets_feib_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_feib_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsFeibDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_feib_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsFeibDatasetRow] datasets_feib_stream_get(publish_date_time_from, publish_date_time_to)

Financial Expenses and Income for Balancing (FEIB / B1790) stream

This endpoint provides financial expenses and income for balancing data. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Financial Expenses and Income for Balancing (FEIB / B1790) stream
    api_response = api_instance.datasets_feib_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_feib_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsFeibDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_fou2_t14_d_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsAvailabilityByFuelTypeDaily datasets_fou2_t14_d_get(fuel_type=fuel_type, publish_date=publish_date, publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, bidding_zone=bidding_zone, interconnector=interconnector, format=format)

2 to 14 days ahead generation availability aggregated by fuel type (FOU2T14D)

This endpoint provides a forward view of availability (also referred to as Output Usable data under the Grid Code) for generation and interconnector capacity, accounting for planned outages covering 2 days ahead to 14 days ahead; it is aggregated by Fuel Types categories. Date parameter must be provided in the exact format yyyy-MM-dd.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
fuel_type = ['fuel_type_example']  # list[str] |  (optional)
publish_date = '2013-10-20'  # date | The publish date for filtering. This must be in the format yyyy-MM-dd. (optional)
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
bidding_zone = ['bidding_zone_example']  # list[str] |  (optional)
interconnector = true  # bool |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # 2 to 14 days ahead generation availability aggregated by fuel type (FOU2T14D)
    api_response = api_instance.datasets_fou2_t14_d_get(fuel_type=fuel_type, publish_date=publish_date,
                                                        publish_date_time_from=publish_date_time_from,
                                                        publish_date_time_to=publish_date_time_to,
                                                        bidding_zone=bidding_zone, interconnector=interconnector,
                                                        format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_fou2_t14_d_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
fuel_type	list[str]		[optional]
publish_date	date	The publish date for filtering. This must be in the format yyyy-MM-dd.	[optional]
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
bidding_zone	list[str]		[optional]
interconnector	bool		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsAvailabilityByFuelTypeDaily

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_fou2_t3_yw_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsAvailabilityByFuelTypeWeekly datasets_fou2_t3_yw_get(fuel_type=fuel_type, publish_date=publish_date, publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, week=week, year=year, bidding_zone=bidding_zone, interconnector=interconnector, format=format)

2 to 156 weeks ahead generation availability aggregated by fuel type (FOU2T3YW)

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
fuel_type = ['fuel_type_example']  # list[str] |  (optional)
publish_date = '2013-10-20'  # date | The publish date for filtering. This must be in the format yyyy-MM-dd. (optional)
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
week = [56]  # list[int] |  (optional)
year = [56]  # list[int] |  (optional)
bidding_zone = ['bidding_zone_example']  # list[str] |  (optional)
interconnector = true  # bool |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # 2 to 156 weeks ahead generation availability aggregated by fuel type (FOU2T3YW)
    api_response = api_instance.datasets_fou2_t3_yw_get(fuel_type=fuel_type, publish_date=publish_date,
                                                        publish_date_time_from=publish_date_time_from,
                                                        publish_date_time_to=publish_date_time_to, week=week, year=year,
                                                        bidding_zone=bidding_zone, interconnector=interconnector,
                                                        format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_fou2_t3_yw_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
fuel_type	list[str]		[optional]
publish_date	date	The publish date for filtering. This must be in the format yyyy-MM-dd.	[optional]
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
week	list[int]		[optional]
year	list[int]		[optional]
bidding_zone	list[str]		[optional]
interconnector	bool		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsAvailabilityByFuelTypeWeekly

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_freq_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesMiscDatasetRowsSystemFrequency datasets_freq_get(measurement_date_time_from=measurement_date_time_from, measurement_date_time_to=measurement_date_time_to, format=format)

System frequency (FREQ)

The endpoint provides data that has been received every 2 minutes the transmission system frequency, expressed as a hertz value for one or more spot times within that 2 minute period. The default output will be the latest published data. A maximum limit of 24 hours is applied to this endpoint to limit response size. Use the streaming version for larger response sizes.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
measurement_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
measurement_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # System frequency (FREQ)
    api_response = api_instance.datasets_freq_get(measurement_date_time_from=measurement_date_time_from,
                                                  measurement_date_time_to=measurement_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_freq_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
measurement_date_time_from	datetime		[optional]
measurement_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesMiscDatasetRowsSystemFrequency

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_freq_stream_get

list[InsightsApiModelsResponsesMiscDatasetRowsSystemFrequency] datasets_freq_stream_get(measurement_date_time_from=measurement_date_time_from, measurement_date_time_to=measurement_date_time_to)

System frequency (FREQ) stream

The endpoint provides data that has been received every 2 minutes the transmission system frequency, expressed as a hertz value for one or more spot times within that 2 minute period. The default output will be the latest published data. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
measurement_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
measurement_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # System frequency (FREQ) stream
    api_response = api_instance.datasets_freq_stream_get(measurement_date_time_from=measurement_date_time_from,
                                                         measurement_date_time_to=measurement_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_freq_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
measurement_date_time_from	datetime		[optional]
measurement_date_time_to	datetime		[optional]

Return type

list[InsightsApiModelsResponsesMiscDatasetRowsSystemFrequency]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_fuelhh_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsAugmentedOutturnData datasets_fuelhh_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, settlement_date_from=settlement_date_from, settlement_date_to=settlement_date_to, settlement_period=settlement_period, fuel_type=fuel_type, format=format)

Half-hourly generation outturn by fuel type (FUELHH)

This endpoint provides the half-hourly generation outturn (Generation By Fuel type) to give our users an indication of the generation outturn for Great Britain. The data is aggregated by Fuel Type category and updated at 30-minute intervals with average MW values over 30 minutes for each category. This endpoint includes additional settlement parameters such as Settlement Date and Settlement Period. The Settlement Date fields cannot be set when a Publish Date field is set. Settlement date parameters must be provided in the exact format yyyy-MM-dd.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
settlement_date_from = '2013-10-20'  # date |  (optional)
settlement_date_to = '2013-10-20'  # date |  (optional)
settlement_period = [56]  # list[int] | List of Settlement Periods (optional)
fuel_type = ['fuel_type_example']  # list[str] | Fuel Type e.g. NUCLEAR (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Half-hourly generation outturn by fuel type (FUELHH)
    api_response = api_instance.datasets_fuelhh_get(publish_date_time_from=publish_date_time_from,
                                                    publish_date_time_to=publish_date_time_to,
                                                    settlement_date_from=settlement_date_from,
                                                    settlement_date_to=settlement_date_to,
                                                    settlement_period=settlement_period, fuel_type=fuel_type,
                                                    format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_fuelhh_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
settlement_date_from	date		[optional]
settlement_date_to	date		[optional]
settlement_period	list[int]	List of Settlement Periods	[optional]
fuel_type	list[str]	Fuel Type e.g. NUCLEAR	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsAugmentedOutturnData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_fuelhh_stream_get

list[InsightsApiModelsResponsesGenerationDatasetRowsAugmentedOutturnData] datasets_fuelhh_stream_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, settlement_date_from=settlement_date_from, settlement_date_to=settlement_date_to, settlement_period=settlement_period, fuel_type=fuel_type)

Half-hourly generation outturn by fuel type (FUELHH) stream

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
settlement_date_from = '2013-10-20'  # date |  (optional)
settlement_date_to = '2013-10-20'  # date |  (optional)
settlement_period = [56]  # list[int] | List of Settlement Periods (optional)
fuel_type = ['fuel_type_example']  # list[str] | Fuel Type e.g. NUCLEAR (optional)

try:
    # Half-hourly generation outturn by fuel type (FUELHH) stream
    api_response = api_instance.datasets_fuelhh_stream_get(publish_date_time_from=publish_date_time_from,
                                                           publish_date_time_to=publish_date_time_to,
                                                           settlement_date_from=settlement_date_from,
                                                           settlement_date_to=settlement_date_to,
                                                           settlement_period=settlement_period, fuel_type=fuel_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_fuelhh_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
settlement_date_from	date		[optional]
settlement_date_to	date		[optional]
settlement_period	list[int]	List of Settlement Periods	[optional]
fuel_type	list[str]	Fuel Type e.g. NUCLEAR	[optional]

Return type

list[InsightsApiModelsResponsesGenerationDatasetRowsAugmentedOutturnData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_fuelinst_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsAugmentedOutturnData datasets_fuelinst_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, settlement_date_from=settlement_date_from, settlement_date_to=settlement_date_to, settlement_period=settlement_period, fuel_type=fuel_type, format=format)

Instantaneous generation outturn by fuel type (FUELINST)

This endpoint provides the instantaneous generation outturn (Generation By Fuel type) to give our users an indication of the generation outturn for Great Britain. The data is aggregated by Fuel Type category and updated at five-minute intervals with average MW values over 5 minutes for each category. This endpoint includes additional settlement parameters such as Settlement Date and Settlement Period. The Settlement Date fields cannot be set when a Publish Date field is set. Settlement date parameters must be provided in the exact format yyyy-MM-dd.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
settlement_date_from = '2013-10-20'  # date |  (optional)
settlement_date_to = '2013-10-20'  # date |  (optional)
settlement_period = [56]  # list[int] | List of Settlement Periods (optional)
fuel_type = ['fuel_type_example']  # list[str] | Fuel Type e.g. NUCLEAR (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Instantaneous generation outturn by fuel type (FUELINST)
    api_response = api_instance.datasets_fuelinst_get(publish_date_time_from=publish_date_time_from,
                                                      publish_date_time_to=publish_date_time_to,
                                                      settlement_date_from=settlement_date_from,
                                                      settlement_date_to=settlement_date_to,
                                                      settlement_period=settlement_period, fuel_type=fuel_type,
                                                      format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_fuelinst_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
settlement_date_from	date		[optional]
settlement_date_to	date		[optional]
settlement_period	list[int]	List of Settlement Periods	[optional]
fuel_type	list[str]	Fuel Type e.g. NUCLEAR	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsAugmentedOutturnData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_fuelinst_stream_get

list[InsightsApiModelsResponsesGenerationDatasetRowsAugmentedOutturnData] datasets_fuelinst_stream_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, settlement_date_from=settlement_date_from, settlement_date_to=settlement_date_to, settlement_period=settlement_period, fuel_type=fuel_type)

Instantaneous generation outturn by fuel type (FUELINST) stream

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
settlement_date_from = '2013-10-20'  # date |  (optional)
settlement_date_to = '2013-10-20'  # date |  (optional)
settlement_period = [56]  # list[int] | List of Settlement Periods (optional)
fuel_type = ['fuel_type_example']  # list[str] | Fuel Type e.g. NUCLEAR (optional)

try:
    # Instantaneous generation outturn by fuel type (FUELINST) stream
    api_response = api_instance.datasets_fuelinst_stream_get(publish_date_time_from=publish_date_time_from,
                                                             publish_date_time_to=publish_date_time_to,
                                                             settlement_date_from=settlement_date_from,
                                                             settlement_date_to=settlement_date_to,
                                                             settlement_period=settlement_period, fuel_type=fuel_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_fuelinst_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
settlement_date_from	date		[optional]
settlement_date_to	date		[optional]
settlement_period	list[int]	List of Settlement Periods	[optional]
fuel_type	list[str]	Fuel Type e.g. NUCLEAR	[optional]

Return type

list[InsightsApiModelsResponsesGenerationDatasetRowsAugmentedOutturnData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_igca_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsIgcaDatasetRow datasets_igca_get(publish_date_time_from, publish_date_time_to, format=format)

Installed Generation Capacity Aggregated (IGCA / B1410)

This endpoint provides installed generation capacity aggregated data. This API endpoint provides a maximum data output range of 2 years (731 days).

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Installed Generation Capacity Aggregated (IGCA / B1410)
    api_response = api_instance.datasets_igca_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_igca_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsIgcaDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_igca_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsIgcaDatasetRow] datasets_igca_stream_get(publish_date_time_from, publish_date_time_to)

Installed Generation Capacity Aggregated (IGCA / B1410) stream

This endpoint provides installed generation capacity aggregated data. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Installed Generation Capacity Aggregated (IGCA / B1410) stream
    api_response = api_instance.datasets_igca_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_igca_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsIgcaDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_igcpu_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsIgcpuDatasetRow datasets_igcpu_get(publish_date_time_from, publish_date_time_to, format=format)

Installed Generation Capacity per Unit (IGCPU / B1420)

This endpoint provides information about production units (existing and planned) with an installed generation capacity equaling to or exceeding 100 MW. The database was populated from a data dump lacking publishTime values, all entries were assigned a default publishTime of 2023-01-01 00:00 during the migration. This API endpoint provides a maximum data output range of 2 years (731 days).

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Installed Generation Capacity per Unit (IGCPU / B1420)
    api_response = api_instance.datasets_igcpu_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_igcpu_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsIgcpuDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_igcpu_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsIgcpuDatasetRow] datasets_igcpu_stream_get(publish_date_time_from, publish_date_time_to)

Installed Generation Capacity per Unit (IGCPU / B1420) stream

This endpoint provides information about production units (existing and planned) with an installed generation capacity equaling to or exceeding 100 MW. The database was populated from a data dump lacking publishTime values, all entries were assigned a default publishTime of 2023-01-01 00:00 during the migration. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Installed Generation Capacity per Unit (IGCPU / B1420) stream
    api_response = api_instance.datasets_igcpu_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_igcpu_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsIgcpuDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_imbalngc_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesIndicatedForecastDatasetRowsIndicatedImbalance datasets_imbalngc_get(boundary=boundary, publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

Day and day-ahead indicated imbalance (IMBALNGC)

This endpoint provides the indicated imbalance. Data is received by daily by midday from NGESO. Expressed as an average MW value for each settlement period. The indicated imbalance forecast for each period is the difference between the sum of the PNs submitted for generation BM Units (i.e. the indicated generation), and the Transmission System Demand forecast made by the System Operator. This API endpoint provides a maximum data output range of 1 day.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
boundary = 'boundary_example'  # str |  (optional)
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Day and day-ahead indicated imbalance (IMBALNGC)
    api_response = api_instance.datasets_imbalngc_get(boundary=boundary, publish_date_time_from=publish_date_time_from,
                                                      publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_imbalngc_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
boundary	str		[optional]
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesIndicatedForecastDatasetRowsIndicatedImbalance

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_imbalngc_stream_get

list[InsightsApiModelsResponsesIndicatedForecastDatasetRowsIndicatedImbalance] datasets_imbalngc_stream_get(boundary=boundary, publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to)

Day and day-ahead indicated imbalance (IMBALNGC) stream

This endpoint provides the indicated imbalance. Data is received by daily by midday from NGESO. Expressed as an average MW value for each settlement period. The indicated imbalance forecast for each period is the difference between the sum of the PNs submitted for generation BM Units (i.e. the indicated generation), and the National Demand forecast made by the System Operator. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
boundary = 'boundary_example'  # str |  (optional)
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # Day and day-ahead indicated imbalance (IMBALNGC) stream
    api_response = api_instance.datasets_imbalngc_stream_get(boundary=boundary,
                                                             publish_date_time_from=publish_date_time_from,
                                                             publish_date_time_to=publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_imbalngc_stream_get: %s\n" % e)

Parameters

Name	Type	Notes
boundary	str	[optional]
publish_date_time_from	datetime	[optional]
publish_date_time_to	datetime	[optional]

Return type

list[InsightsApiModelsResponsesIndicatedForecastDatasetRowsIndicatedImbalance]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_inddem_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesIndicatedForecastDatasetRowsIndicatedDemand datasets_inddem_get(boundary=boundary, publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

Day and day-ahead indicated demand (INDDEM)

This endpoint provides the indicated demand forecast for the current day and day-ahead received from NGESO. The forecast is updated every half hour. The forecast for each period is the sum of all the PNs submitted for BM Units which are forecast to be importing energy. Data is presented an average MW for the settlement period. This API endpoint provides a maximum data output range of 1 day.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
boundary = 'boundary_example'  # str |  (optional)
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Day and day-ahead indicated demand (INDDEM)
    api_response = api_instance.datasets_inddem_get(boundary=boundary, publish_date_time_from=publish_date_time_from,
                                                    publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_inddem_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
boundary	str		[optional]
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesIndicatedForecastDatasetRowsIndicatedDemand

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_inddem_stream_get

list[InsightsApiModelsResponsesIndicatedForecastDatasetRowsIndicatedDemand] datasets_inddem_stream_get(boundary=boundary, publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to)

Day and day-ahead indicated demand (INDDEM) stream

This endpoint provides the indicated demand forecast for the current day and day-ahead received from NGESO. The forecast is updated every half hour. The forecast for each period is the sum of all the PNs submitted for BM Units which are forecast to be importing energy. Data is presented an average MW for the settlement period. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
boundary = 'boundary_example'  # str |  (optional)
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # Day and day-ahead indicated demand (INDDEM) stream
    api_response = api_instance.datasets_inddem_stream_get(boundary=boundary,
                                                           publish_date_time_from=publish_date_time_from,
                                                           publish_date_time_to=publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_inddem_stream_get: %s\n" % e)

Parameters

Name	Type	Notes
boundary	str	[optional]
publish_date_time_from	datetime	[optional]
publish_date_time_to	datetime	[optional]

Return type

list[InsightsApiModelsResponsesIndicatedForecastDatasetRowsIndicatedDemand]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_indgen_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesIndicatedForecastDatasetRowsIndicatedGeneration datasets_indgen_get(boundary=boundary, publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

Day and day-ahead indicated generation (INDGEN)

This endpoint provides the indicated generation received from NGESO. Data is received daily, by midday. Expressed as an average MW value for each Settlement period. The indicated generation forecast for each period is the sum of all the PNs submitted for BM Units which are forecast to be exporting energy, presented as a single average MW value for the settlement period. This API endpoint provides a maximum data output range of 1 day.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
boundary = 'boundary_example'  # str |  (optional)
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Day and day-ahead indicated generation (INDGEN)
    api_response = api_instance.datasets_indgen_get(boundary=boundary, publish_date_time_from=publish_date_time_from,
                                                    publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_indgen_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
boundary	str		[optional]
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesIndicatedForecastDatasetRowsIndicatedGeneration

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_indgen_stream_get

list[InsightsApiModelsResponsesIndicatedForecastDatasetRowsIndicatedGeneration] datasets_indgen_stream_get(boundary=boundary, publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to)

Day and day-ahead indicated generation (INDGEN) stream

This endpoint provides the indicated generation received from NGESO. Data is received daily, by midday. Expressed as an average MW value for each settlement period. The indicated generation forecast for each period is the sum of all the PNs submitted for BM Units which are forecast to be exporting energy, presented as a single average MW value for the settlement period. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
boundary = 'boundary_example'  # str |  (optional)
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # Day and day-ahead indicated generation (INDGEN) stream
    api_response = api_instance.datasets_indgen_stream_get(boundary=boundary,
                                                           publish_date_time_from=publish_date_time_from,
                                                           publish_date_time_to=publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_indgen_stream_get: %s\n" % e)

Parameters

Name	Type	Notes
boundary	str	[optional]
publish_date_time_from	datetime	[optional]
publish_date_time_to	datetime	[optional]

Return type

list[InsightsApiModelsResponsesIndicatedForecastDatasetRowsIndicatedGeneration]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_indo_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesDemandOutturnDatasetRowsDemandOutturnNational datasets_indo_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

Initial National Demand outturn (INDO)

The endpoint provides data showing the initial National Demand outturn. Data is updated at 15 min intervals containing the initial demand expressed in MW. Specific publish time filters may be supplied, otherwise this will retrieve the latest published data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Initial National Demand outturn (INDO)
    api_response = api_instance.datasets_indo_get(publish_date_time_from=publish_date_time_from,
                                                  publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_indo_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesDemandOutturnDatasetRowsDemandOutturnNational

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_indod_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesDemandOutturnDatasetRowsIndodDatasetRow datasets_indod_get(publish_date_time_from, publish_date_time_to, format=format)

Initial National Demand outturn daily (INDOD)

This endpoint provides initial National Demand outturn daily data. The total daily energy volume is the total demand volume for the previous day expressed on an initial National Demand outturn (INDO) basis, i.e. excluding station transformer, pumping and interconnector export demand. It is calculated from summing the half hourly INDO demands (divided by two to convert to MWh). This API endpoint has a maximum range of 2 years (731 days).

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Initial National Demand outturn daily (INDOD)
    api_response = api_instance.datasets_indod_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_indod_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesDemandOutturnDatasetRowsIndodDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_indod_stream_get

list[InsightsApiModelsResponsesDemandOutturnDatasetRowsIndodDatasetRow] datasets_indod_stream_get(publish_date_time_from, publish_date_time_to)

Initial National Demand outturn daily (INDOD) stream

This endpoint provides initial National Demand outturn daily data. The total daily energy volume is the total demand volume for the previous day expressed on an initial National Demand outturn (INDO) basis, i.e. excluding station transformer, pumping and interconnector export demand. It is calculated from summing the half hourly INDO demands (divided by two to convert to MWh). This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Initial National Demand outturn daily (INDOD) stream
    api_response = api_instance.datasets_indod_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_indod_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesDemandOutturnDatasetRowsIndodDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_itsdo_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesDemandOutturnDatasetRowsDemandOutturnTransmission datasets_itsdo_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

Initial Transmission System Demand outturn (ITSDO)

The endpoint provides data showing the initial Transmission System Demand outturn. Data is updated at 15 min intervals containing the initial demand expressed in MW. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Initial Transmission System Demand outturn (ITSDO)
    api_response = api_instance.datasets_itsdo_get(publish_date_time_from=publish_date_time_from,
                                                   publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_itsdo_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesDemandOutturnDatasetRowsDemandOutturnTransmission

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_lolpdrm_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesMiscDatasetRowsLossOfLoadProbabilityDeratedMarginData datasets_lolpdrm_get(publish_date_time_from, publish_date_time_to, format=format)

Loss of load probability and de-rated margin (LOLPDRM)

The loss of load probability and de-rated margin data is received half-hourly from NGESO. Loss of load probability (LoLP) is a measure of system reliability, calculated by NGESO for each settlement period, using the methodology set out in the Loss of Load Probability Calculation Statement. De-rated margin is a forecast of the excess supply on the system, which has been adjusted to take account of the likely availability of electricity generators.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Loss of load probability and de-rated margin (LOLPDRM)
    api_response = api_instance.datasets_lolpdrm_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_lolpdrm_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesMiscDatasetRowsLossOfLoadProbabilityDeratedMarginData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_lolpdrm_stream_get

list[InsightsApiModelsResponsesMiscDatasetRowsLossOfLoadProbabilityDeratedMarginData] datasets_lolpdrm_stream_get(publish_date_time_from, publish_date_time_to)

Loss of load probability and de-rated margin (LOLPDRM)

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Loss of load probability and de-rated margin (LOLPDRM)
    api_response = api_instance.datasets_lolpdrm_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_lolpdrm_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesMiscDatasetRowsLossOfLoadProbabilityDeratedMarginData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_matl_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsMonthAheadTotalLoadPerBiddingZoneDatasetRow datasets_matl_get(publish_date_time_from, publish_date_time_to, format=format)

Month-Ahead Total Load Forecast Per Bidding Zone (MATL / B0640)

This endpoint provides month-ahead total load per bidding zone forecast data with minimum possible and maximum available loads provided in MW values. This API endpoint has a maximum range of 367 days.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Month-Ahead Total Load Forecast Per Bidding Zone (MATL / B0640)
    api_response = api_instance.datasets_matl_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_matl_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsMonthAheadTotalLoadPerBiddingZoneDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_matl_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsMonthAheadTotalLoadPerBiddingZoneDatasetRow] datasets_matl_stream_get(publish_date_time_from, publish_date_time_to)

Month-Ahead Total Load Forecast Per Bidding Zone (MATL / B0640) stream

This endpoint provides month-ahead total load per bidding zone forecast data with minimum possible and maximum available loads provided in MW values. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Month-Ahead Total Load Forecast Per Bidding Zone (MATL / B0640) stream
    api_response = api_instance.datasets_matl_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_matl_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsMonthAheadTotalLoadPerBiddingZoneDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_mdp_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicDatasetRowsDeliveryPeriodMaxData datasets_mdp_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit, format=format)

Maximum Delivery Period (MDP)

Maximum Delivery Period (MDP) is the maximum period, expressed in minutes, over which the Maximum Delivery Volume (MDV) applies. Maximum Delivery Volume is the maximum number of MWh of Offer (or Bid) that a particular BM Unit may deliver within the associated Maximum Delivery Period. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/MDP?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/MDP?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/MDP?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/MDP?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Maximum Delivery Period (MDP)
    api_response = api_instance.datasets_mdp_get(_from, to, settlement_period_from=settlement_period_from,
                                                 settlement_period_to=settlement_period_to, bm_unit=bm_unit,
                                                 format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_mdp_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicDatasetRowsDeliveryPeriodMaxData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_mdp_stream_get

list[InsightsApiModelsResponsesBalancingDynamicDatasetRowsDeliveryPeriodMaxData] datasets_mdp_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Maximum Delivery Period (MDP) stream

This endpoint provides Maximum Delivery Period data received from NGESO. Maximum Delivery Period (MDP) is the maximum period over which the Maximum Delivery Volume (MDV) applies. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/MDP/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/MDP/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/MDP/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/MDP/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1 This endpoint has an optimised JSON payload and is aimed at frequent requests for MDP data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Maximum Delivery Period (MDP) stream
    api_response = api_instance.datasets_mdp_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                        settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_mdp_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDynamicDatasetRowsDeliveryPeriodMaxData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_mdv_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicDatasetRowsDeliveryVolumeMaxData datasets_mdv_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit, format=format)

Maximum Delivery Volume (MDV)

This endpoint provides Maximum Delivery Volume data received from NGESO. Maximum Delivery Volume is the maximum number of MWh of Offer (or Bid), that a particular BM Unit may deliver within the associated Maximum Delivery Period. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/MDV?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/MDV?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/MDV?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/MDV?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Maximum Delivery Volume (MDV)
    api_response = api_instance.datasets_mdv_get(_from, to, settlement_period_from=settlement_period_from,
                                                 settlement_period_to=settlement_period_to, bm_unit=bm_unit,
                                                 format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_mdv_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicDatasetRowsDeliveryVolumeMaxData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_mdv_stream_get

list[InsightsApiModelsResponsesBalancingDynamicDatasetRowsDeliveryVolumeMaxData] datasets_mdv_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Maximum Delivery Volume (MDV) stream

This endpoint provides Maximum Delivery Volume data received from NGESO. Maximum Delivery Volume is the maximum number of MWh of Offer (or Bid), that a particular BM Unit may deliver within the associated Maximum Delivery Period. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/MDV/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/MDV/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/MDV/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/MDV/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1 This endpoint has an optimised JSON payload and is aimed at frequent requests for MDV data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Maximum Delivery Volume (MDV) stream
    api_response = api_instance.datasets_mdv_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                        settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_mdv_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDynamicDatasetRowsDeliveryVolumeMaxData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_melngc_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesIndicatedForecastDatasetRowsIndicatedMargin datasets_melngc_get(boundary=boundary, publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

Day and day-ahead indicated margin (MELNGC)

This endpoint provides the indicated margin. Data is received every half an hour from NGESO. Expressed as an average MW value for each settlement period. The indicated margin forecast for each settlement period is the difference between the sum of the MELs submitted for that period, and the National Demand forecast made by the System Operator. The greater the value, the higher the margin between available generation capacity and forecast demand - that is to say, the more spare capacity there is forecast to be in the system. This API endpoint provides a maximum data output range of 1 day.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
boundary = 'boundary_example'  # str |  (optional)
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Day and day-ahead indicated margin (MELNGC)
    api_response = api_instance.datasets_melngc_get(boundary=boundary, publish_date_time_from=publish_date_time_from,
                                                    publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_melngc_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
boundary	str		[optional]
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesIndicatedForecastDatasetRowsIndicatedMargin

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_melngc_stream_get

list[InsightsApiModelsResponsesIndicatedForecastDatasetRowsIndicatedMargin] datasets_melngc_stream_get(boundary=boundary, publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to)

Day and day-ahead indicated margin (MELNGC) stream

This endpoint provides the indicated margin. Data is received every half an hour from NGESO. Expressed as an average MW value for each settlement period. The indicated margin forecast for each settlement period is the difference between the sum of the MELs submitted for that period, and the National Demand forecast made by the System Operator. The greater the value, the higher the margin between available generation capacity and forecast demand - that is to say, the more spare capacity there is forecast to be in the system. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
boundary = 'boundary_example'  # str |  (optional)
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # Day and day-ahead indicated margin (MELNGC) stream
    api_response = api_instance.datasets_melngc_stream_get(boundary=boundary,
                                                           publish_date_time_from=publish_date_time_from,
                                                           publish_date_time_to=publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_melngc_stream_get: %s\n" % e)

Parameters

Name	Type	Notes
boundary	str	[optional]
publish_date_time_from	datetime	[optional]
publish_date_time_to	datetime	[optional]

Return type

list[InsightsApiModelsResponsesIndicatedForecastDatasetRowsIndicatedMargin]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_mels_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingPhysicalDatasetRowsDeliveryLimitMaxData datasets_mels_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit, format=format)

Maximum Export Limit (MELS)

This endpoint provides Maximum Export Limit data received from NGESO. The Maximum Export Limit is the maximum power export level of a particular BM Unit at a particular time. The data is updated every 30 minutes and within 15 minutes of the end of the effective Settlement Period. MELs are submitted as a series of MW values and associated times in UTC. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/mels?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/mels?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/mels?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/mels?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Maximum Export Limit (MELS)
    api_response = api_instance.datasets_mels_get(_from, to, settlement_period_from=settlement_period_from,
                                                  settlement_period_to=settlement_period_to, bm_unit=bm_unit,
                                                  format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_mels_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingPhysicalDatasetRowsDeliveryLimitMaxData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_mels_stream_get

list[InsightsApiModelsResponsesBalancingPhysicalDatasetRowsDeliveryLimitMaxData] datasets_mels_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Maximum Export Limit (MELS) stream

This endpoint provides Maximum Export Limit data received from NGESO. The Maximum Export Limit is the maximum power export level of a particular BM Unit at a particular time. The data is updated every 30 minutes and within 15 minutes of the end of the effective Settlement Period. MELs are submitted as a series of MW values and associated times in UTC. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/mels/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/mels/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/mels/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/mels/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1 This endpoint has an optimised JSON payload and is aimed at frequent requests for MELS data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Maximum Export Limit (MELS) stream
    api_response = api_instance.datasets_mels_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                         settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_mels_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingPhysicalDatasetRowsDeliveryLimitMaxData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_metadata_latest_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesReferenceDatasetMetadataLatestRow datasets_metadata_latest_get(format=format)

Returns the time when each dataset was last updated

Depending on the dataset, this value may be taken from the timestamp on the source datafile, the publishTime field on the dataset, or the latest available measurement time.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Returns the time when each dataset was last updated
    api_response = api_instance.datasets_metadata_latest_get(format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_metadata_latest_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesReferenceDatasetMetadataLatestRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_mid_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDatasetRowsMarketIndexDatasetResponse datasets_mid_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, data_providers=data_providers, format=format)

Market Index Data (MID)

This endpoint provides Market Index Data received from NGESO. Market Index Data is a key component in the calculation of System Buy Price and System Sell Price for each Settlement Period. This data is received from each of the appointed Market Index Data Providers (MIDPs) and reflects the price of wholesale electricity in Great Britain in the short term markets. The Market Index Data which is received from each MIDP for each Settlement Period consists of a Market Index Volume and Market Index Price, representing the volume and price of trading for the relevant period in the market operated by the MIDP. The Market Price (the volume weighed average Market Index Price) is used to derive the Reverse Price (SBP or SSP)." The two data providers available to query are N2EX ("N2EXMIDP") and APX ("APXMIDP"). By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/mid?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/mid?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/mid?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/mid?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
data_providers = [
    'data_providers_example']  # list[str] | The data providers to query. If no data provider is selected both will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Market Index Data (MID)
    api_response = api_instance.datasets_mid_get(_from, to, settlement_period_from=settlement_period_from,
                                                 settlement_period_to=settlement_period_to,
                                                 data_providers=data_providers, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_mid_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
data_providers	list[str]	The data providers to query. If no data provider is selected both will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDatasetRowsMarketIndexDatasetResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_mid_stream_get

list[InsightsApiModelsResponsesBalancingDatasetRowsMarketIndexDatasetResponse] datasets_mid_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, data_providers=data_providers)

Market Index Data (MID) stream

This endpoint provides Market Index Data received from NGESO. Market Index Data is a key component in the calculation of System Buy Price and System Sell Price for each Settlement Period. This data is received from each of the appointed Market Index Data Providers (MIDPs) and reflects the price of wholesale electricity in Great Britain in the short term markets. The Market Index Data which is received from each MIDP for each Settlement Period consists of a Market Index Volume and Market Index Price, representing the volume and price of trading for the relevant period in the market operated by the MIDP. The Market Price (the volume weighed average Market Index Price) is used to derive the Reverse Price (SBP or SSP)." The two data providers available to query are N2EX ("N2EXMIDP") and APX ("APXMIDP"). By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/mid/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/mid/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/mid/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/mid/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1 This endpoint has an optimised JSON payload and is aimed at frequent requests for MID data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
data_providers = [
    'data_providers_example']  # list[str] | The data providers to query. If no data provider is selected both will be displayed. (optional)

try:
    # Market Index Data (MID) stream
    api_response = api_instance.datasets_mid_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                        settlement_period_to=settlement_period_to,
                                                        data_providers=data_providers)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_mid_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
data_providers	list[str]	The data providers to query. If no data provider is selected both will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDatasetRowsMarketIndexDatasetResponse]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_mils_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingPhysicalDatasetRowsDeliveryLimitMaxData datasets_mils_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit, format=format)

Maximum Import Limit (MILS)

This endpoint provides Maximum Import Limit data received from NGESO. The maximum power import level of a particular BM Unit at a particular time. The data is updated every 30 minutes and within 15 minutes of the end of the effective Settlement Period. MILs are submitted as a series of MW values and associated times in UTC. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/mils?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/mils?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/mils?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/mils?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Maximum Import Limit (MILS)
    api_response = api_instance.datasets_mils_get(_from, to, settlement_period_from=settlement_period_from,
                                                  settlement_period_to=settlement_period_to, bm_unit=bm_unit,
                                                  format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_mils_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingPhysicalDatasetRowsDeliveryLimitMaxData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_mils_stream_get

list[InsightsApiModelsResponsesBalancingPhysicalDatasetRowsDeliveryLimitMaxData] datasets_mils_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Maximum Import Limit (MILS) stream

This endpoint provides Maximum Import Limit data received from NGESO. The maximum power import level of a particular BM Unit at a particular time. The data is updated every 30 minutes and within 15 minutes of the end of the effective Settlement Period. MILs are submitted as a series of MW values and associated times in UTC. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/mils/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/mils/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/mils/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/mils/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1 This endpoint has an optimised JSON payload and is aimed at frequent requests for MILS data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Maximum Import Limit (MILS) stream
    api_response = api_instance.datasets_mils_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                         settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_mils_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingPhysicalDatasetRowsDeliveryLimitMaxData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_mnzt_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicDatasetRowsDeliveryPeriodMinData datasets_mnzt_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit, format=format)

Minimum Non-Zero Time (MNZT)

This endpoint provides Minimum Non Zero Time data received from NGESO. The Minimum Non-Zero Time represents the minimum time that a BM Unit can operate at a non-zero level as a result of a Bid-Offer Acceptance. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/MNZT?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/MNZT?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/MNZT?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/MNZT?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Minimum Non-Zero Time (MNZT)
    api_response = api_instance.datasets_mnzt_get(_from, to, settlement_period_from=settlement_period_from,
                                                  settlement_period_to=settlement_period_to, bm_unit=bm_unit,
                                                  format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_mnzt_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicDatasetRowsDeliveryPeriodMinData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_mnzt_stream_get

list[InsightsApiModelsResponsesBalancingDynamicDatasetRowsDeliveryPeriodMinData] datasets_mnzt_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Minimum Non-Zero Time (MNZT) stream

This endpoint provides Minimum Non Zero Time data received from NGESO. The Minimum Non-Zero Time represents the minimum time that a BM Unit can operate at a non-zero level as a result of a Bid-Offer Acceptance. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/MNZT/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/MNZT/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/MNZT/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/MNZT/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1 This endpoint has an optimised JSON payload and is aimed at frequent requests for MNZT data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Minimum Non-Zero Time (MNZT) stream
    api_response = api_instance.datasets_mnzt_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                         settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_mnzt_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDynamicDatasetRowsDeliveryPeriodMinData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_mzt_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicDatasetRowsDeliveryPeriodMinData datasets_mzt_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit, format=format)

Minimum Zero Time (MZT)

This endpoint provides Minimum Zero Time data received from NGESO. The Minimum Zero Time is the minimum time that a BM Unit which has been exporting must operate at zero or import, before returning to export; whereas if the BM Unit has been importing, the MZT indicates the minimum time that it must operate at zero or export before returning to import, if action by the System Operator (i.e. a Bid-Offer Acceptance) places it at such a level. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/MZT?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/MZT?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/MZT?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/MZT?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Minimum Zero Time (MZT)
    api_response = api_instance.datasets_mzt_get(_from, to, settlement_period_from=settlement_period_from,
                                                 settlement_period_to=settlement_period_to, bm_unit=bm_unit,
                                                 format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_mzt_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicDatasetRowsDeliveryPeriodMinData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_mzt_stream_get

list[InsightsApiModelsResponsesBalancingDynamicDatasetRowsDeliveryPeriodMinData] datasets_mzt_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Minimum Zero Time (MZT) stream

This endpoint provides Minimum Zero Time data received from NGESO. The Minimum Zero Time is the minimum time that a BM Unit which has been exporting must operate at zero or import, before returning to export; whereas if the BM Unit has been importing, the MZT indicates the minimum time that it must operate at zero or export before returning to import, if action by the System Operator (i.e. a Bid-Offer Acceptance) places it at such a level. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. /// All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/MZT/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/MZT/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/MZT/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/MZT/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1 This endpoint has an optimised JSON payload and is aimed at frequent requests for MZT data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Minimum Zero Time (MZT) stream
    api_response = api_instance.datasets_mzt_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                        settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_mzt_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDynamicDatasetRowsDeliveryPeriodMinData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ndf_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastNationalDayAhead datasets_ndf_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

Day and day-ahead National Demand forecast (NDF)

This endpoint provides the National Demand forecast received from NGESO. Data is available daily and will show values for the day ahead. Expressed as an average MW value for each settlement period. The forecast is based on historically metered generation output for Great Britain. This value INCLUDES transmission losses, but EXCLUDES interconnector flows and demand from station transformers and pumped storage units. This API endpoint provides a maximum data output range of 1 day. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Day and day-ahead National Demand forecast (NDF)
    api_response = api_instance.datasets_ndf_get(publish_date_time_from=publish_date_time_from,
                                                 publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ndf_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastNationalDayAhead

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ndf_stream_get

list[InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastNationalDayAhead] datasets_ndf_stream_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to)

Day and day-ahead National Demand forecast (NDF) stream

This endpoint provides the National Demand forecast received from NGESO. Data is available daily and will show values for the day ahead. Expressed as an average MW value for each settlement period. The forecast is based on historically metered generation output for Great Britain. This value INCLUDES transmission losses, but EXCLUDES interconnector flows and demand from station transformers and pumped storage units. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # Day and day-ahead National Demand forecast (NDF) stream
    api_response = api_instance.datasets_ndf_stream_get(publish_date_time_from=publish_date_time_from,
                                                        publish_date_time_to=publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ndf_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]

Return type

list[InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastNationalDayAhead]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ndfd_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastNationalDaily datasets_ndfd_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

2-14 days ahead National Demand and surplus forecast (NDFD)

This endpoint provides the National Demand forecast received from NGESO. Data is available daily and will show values for the 2 to 14 days ahead. Expressed as an average MW value for each Settlement period. The forecast is based on historically metered generation output for Great Britain. This value INCLUDES transmission losses, but EXCLUDES interconnector flows and demand from station. This API endpoint provides a maximum data output range of 92 days. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # 2-14 days ahead National Demand and surplus forecast (NDFD)
    api_response = api_instance.datasets_ndfd_get(publish_date_time_from=publish_date_time_from,
                                                  publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ndfd_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastNationalDaily

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ndfd_stream_get

list[InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastNationalDaily] datasets_ndfd_stream_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to)

2-14 days ahead National Demand and surplus forecast (NDFD) stream

This endpoint provides the National Demand forecast received from NGESO. Data is available daily and will show values for the 2 to 14 days ahead. Expressed as an average MW value for each Settlement period. The forecast is based on historically metered generation output for Great Britain. This value INCLUDES transmission losses, but EXCLUDES Interconnector flows and demand from station Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # 2-14 days ahead National Demand and surplus forecast (NDFD) stream
    api_response = api_instance.datasets_ndfd_stream_get(publish_date_time_from=publish_date_time_from,
                                                         publish_date_time_to=publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ndfd_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]

Return type

list[InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastNationalDaily]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ndfw_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastNationalWeekly datasets_ndfw_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

2-52 weeks ahead National Demand and surplus forecast (NDFW)

This endpoint provides the National Demand forecast received from NGESO. Data is available from 4pm each Thursday and will show values for the 2 to 52 weeks ahead. Expressed as an average MW value for each week. The forecast is based on historically metered generation output for Great Britain. This value INCLUDES transmission losses, but EXCLUDES interconnector flows and demand from station. This API endpoint provides a maximum data output range of 366 days. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # 2-52 weeks ahead National Demand and surplus forecast (NDFW)
    api_response = api_instance.datasets_ndfw_get(publish_date_time_from=publish_date_time_from,
                                                  publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ndfw_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastNationalWeekly

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ndfw_stream_get

list[InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastNationalWeekly] datasets_ndfw_stream_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to)

2-52 weeks ahead National Demand and surplus forecast (NDFW) stream

This endpoint provides the National Demand forecast received from NGESO. Data is available from 4pm each Thursday and will show values for the 2 to 52 weeks ahead. Expressed as an average MW value for each week. The forecast is based on historically metered generation output for Great Britain. This value INCLUDES transmission losses, but EXCLUDES interconnector flows and demand from station. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # 2-52 weeks ahead National Demand and surplus forecast (NDFW) stream
    api_response = api_instance.datasets_ndfw_stream_get(publish_date_time_from=publish_date_time_from,
                                                         publish_date_time_to=publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ndfw_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]

Return type

list[InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastNationalWeekly]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ndz_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicDatasetRowsNoticeData datasets_ndz_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit, format=format)

Notice to Deviate from Zero (NDZ)

This endpoint provides Notice to Deviate from Zero data received from NGESO. Notice to Deviate from Zero (NDZ) indicates the length of time required for a BM Unit to start importing or exporting energy, from a zero Physical Notification level as a result of a Bid-Offer Acceptance, expressed in minutes. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/NDZ?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z Filtering from start time to settlement date and period: /datasets/NDZ?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/NDZ?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/NDZ?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Notice to Deviate from Zero (NDZ)
    api_response = api_instance.datasets_ndz_get(_from, to, settlement_period_from=settlement_period_from,
                                                 settlement_period_to=settlement_period_to, bm_unit=bm_unit,
                                                 format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ndz_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicDatasetRowsNoticeData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ndz_stream_get

list[InsightsApiModelsResponsesBalancingDynamicDatasetRowsNoticeData] datasets_ndz_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Notice to Deviate from Zero (NDZ) stream

This endpoint provides Notice to Deviate from Zero data received from NGESO. Notice to Deviate from Zero (NDZ) indicates the length of time required for a BM Unit to start importing or exporting energy, from a zero Physical Notification level as a result of a Bid-Offer Acceptance, expressed in minutes. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/NDZ/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/NDZ/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/NDZ/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/NDZ/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1 This endpoint has an optimised JSON payload and is aimed at frequent requests for NDZ data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Notice to Deviate from Zero (NDZ) stream
    api_response = api_instance.datasets_ndz_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                        settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ndz_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDynamicDatasetRowsNoticeData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_netbsad_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDatasetRowsNetBalancingServicesAdjustmentData datasets_netbsad_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, format=format)

Net Balancing Services Adjustment Data (NETBSAD)

This endpoint provides Net Balancing Services Adjustment data received from NGESO. Net Balancing Services Adjustment data covers the buy/sell price, cost and volume adjustments for each settlement period. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/netbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/netbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/netbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/netbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Net Balancing Services Adjustment Data (NETBSAD)
    api_response = api_instance.datasets_netbsad_get(_from, to, settlement_period_from=settlement_period_from,
                                                     settlement_period_to=settlement_period_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_netbsad_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDatasetRowsNetBalancingServicesAdjustmentData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_netbsad_stream_get

list[InsightsApiModelsResponsesBalancingDatasetRowsNetBalancingServicesAdjustmentData] datasets_netbsad_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to)

Net Balancing Services Adjustment Data (NETBSAD)

This endpoint provides Net Balancing Services Adjustment data received from NGESO. Net Balancing Services Adjustment data covers the buy/sell price, cost and volume adjustments for each settlement period. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/netbsad/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/netbsad/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/netbsad/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/netbsad/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1 This endpoint has an optimised JSON payload and is aimed at frequent requests for NETBSAD data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)

try:
    # Net Balancing Services Adjustment Data (NETBSAD)
    api_response = api_instance.datasets_netbsad_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                            settlement_period_to=settlement_period_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_netbsad_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDatasetRowsNetBalancingServicesAdjustmentData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_nonbm_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsNonBmStorData datasets_nonbm_get(_from=_from, to=to, format=format)

Non-BM STOR (NONBM)

This endpoint provides data about the Short Term Operating Reserves (STOR) that have been made use of by NGESO. This is activity that is outside of the Balancing Mechanism and takes place to meet the need to increase generation or decrease demand. To retrieve data from a particular time window, use the optional start and end time parameters. These times should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. If no time window is chosen, the default output will be the latest published data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The start of the data publish time window. (optional)
to = '2013-10-20T19:20:30+01:00'  # datetime | The end of the data publish time window. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Non-BM STOR (NONBM)
    api_response = api_instance.datasets_nonbm_get(_from=_from, to=to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_nonbm_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The start of the data publish time window.	[optional]
to	datetime	The end of the data publish time window.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsNonBmStorData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_nonbm_stream_get

list[InsightsApiModelsResponsesGenerationDatasetRowsNonBmStorData] datasets_nonbm_stream_get(_from=_from, to=to)

Non-BM STOR (NONBM) stream

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The start of the data publish time window. (optional)
to = '2013-10-20T19:20:30+01:00'  # datetime | The end of the data publish time window. (optional)

try:
    # Non-BM STOR (NONBM) stream
    api_response = api_instance.datasets_nonbm_stream_get(_from=_from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_nonbm_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The start of the data publish time window.	[optional]
to	datetime	The end of the data publish time window.	[optional]

Return type

list[InsightsApiModelsResponsesGenerationDatasetRowsNonBmStorData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_nou2_t14_d_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsAvailabilityDaily datasets_nou2_t14_d_get(publish_date=publish_date, publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

2 to 14 days ahead generation availability aggregated data (NOU2T14D)

This endpoint provides a forward view of availability (also referred to as Output Usable data under the Grid Code) for generation and interconnector capacity, accounting for planned outages covering 2 days ahead to 14 days ahead. The data is aggregated at national level. Date parameter must be provided in the exact format yyyy-MM-dd.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date = '2013-10-20'  # date | The publish date for filtering. This must be in the format yyyy-MM-dd. (optional)
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # 2 to 14 days ahead generation availability aggregated data (NOU2T14D)
    api_response = api_instance.datasets_nou2_t14_d_get(publish_date=publish_date,
                                                        publish_date_time_from=publish_date_time_from,
                                                        publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_nou2_t14_d_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date	date	The publish date for filtering. This must be in the format yyyy-MM-dd.	[optional]
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsAvailabilityDaily

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_nou2_t3_yw_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsAvailabilityWeekly datasets_nou2_t3_yw_get(publish_date=publish_date, publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, week=week, year=year, format=format)

2 to 156 weeks ahead generation availability aggregated data (NOU2T3YW)

This endpoint provides a forward view of availability (also referred to as Output Usable data under the Grid Code) for generation and interconnector capacity, accounting for planned outages covering availability data from 2 weeks ahead to 156 weeks ahead. The data is an aggregation of all Fuel Type categories at national level. Date parameter must be provided in the exact format yyyy-MM-dd.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date = '2013-10-20'  # date | The publish date for filtering. This must be in the format yyyy-MM-dd. (optional)
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
week = [56]  # list[int] |  (optional)
year = [56]  # list[int] |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # 2 to 156 weeks ahead generation availability aggregated data (NOU2T3YW)
    api_response = api_instance.datasets_nou2_t3_yw_get(publish_date=publish_date,
                                                        publish_date_time_from=publish_date_time_from,
                                                        publish_date_time_to=publish_date_time_to, week=week, year=year,
                                                        format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_nou2_t3_yw_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date	date	The publish date for filtering. This must be in the format yyyy-MM-dd.	[optional]
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
week	list[int]		[optional]
year	list[int]		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsAvailabilityWeekly

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ntb_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicDatasetRowsNoticeData datasets_ntb_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit, format=format)

Notice to Deliver Bids (NTB)

This endpoint provides Notice to Deliver Bids data received from NGESO. Notice to Deliver Bids (NTB) indicates the length of time between the issuing of a Bid-Offer Acceptance and the time when a BM Unit begins to deliver Bid volumes, expressed in minutes. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/NTB?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z Filtering from start time to settlement date and period: /datasets/NTB?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/NTB?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/NTB?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Notice to Deliver Bids (NTB)
    api_response = api_instance.datasets_ntb_get(_from, to, settlement_period_from=settlement_period_from,
                                                 settlement_period_to=settlement_period_to, bm_unit=bm_unit,
                                                 format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ntb_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicDatasetRowsNoticeData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ntb_stream_get

list[InsightsApiModelsResponsesBalancingDynamicDatasetRowsNoticeData] datasets_ntb_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Notice to Deliver Bids (NTB) stream

This endpoint provides Notice to Deliver Bids data received from NGESO. Notice to Deliver Bids (NTB) indicates the length of time between the issuing of a Bid-Offer Acceptance and the time when a BM Unit begins to deliver Bid volumes, expressed in minutes. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/NTB/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/NTB/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/NTB/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/NTB/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1 This endpoint has an optimised JSON payload and is aimed at frequent requests for NTB data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Notice to Deliver Bids (NTB) stream
    api_response = api_instance.datasets_ntb_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                        settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ntb_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDynamicDatasetRowsNoticeData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_nto_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicDatasetRowsNoticeData datasets_nto_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit, format=format)

Notice to Deliver Offers (NTO)

This endpoint provides Notice to Deliver Offers data received from NGESO. Notice to Deliver Offers (NTO) indicates the length of time required for a BM Unit to start delivering Offers from the time that the Bid-Offer Acceptance is issued, expressed in minutes. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/NTO?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z Filtering from start time to settlement date and period: /datasets/NTO?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/NTO?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/NTO?from=2022-06-01T00:00Z&to=2022-06-08T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Notice to Deliver Offers (NTO)
    api_response = api_instance.datasets_nto_get(_from, to, settlement_period_from=settlement_period_from,
                                                 settlement_period_to=settlement_period_to, bm_unit=bm_unit,
                                                 format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_nto_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicDatasetRowsNoticeData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_nto_stream_get

list[InsightsApiModelsResponsesBalancingDynamicDatasetRowsNoticeData] datasets_nto_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Notice to Deliver Offers (NTO) stream

This endpoint provides Notice to Deliver Offers data received from NGESO. Notice to Deliver Offers (NTO) indicates the length of time required for a BM Unit to start delivering Offers from the time that the Bid-Offer Acceptance is issued, expressed in minutes. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/NTO/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/NTO/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/NTO/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/NTO/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1 This endpoint has an optimised JSON payload and is aimed at frequent requests for NTO data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Notice to Deliver Offers (NTO) stream
    api_response = api_instance.datasets_nto_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                        settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_nto_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDynamicDatasetRowsNoticeData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ocnmf3_y2_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesForecastMarginDatasetRowsForecastMarginWeekly datasets_ocnmf3_y2_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

2-156 weeks ahead demand margin forecast (OCNMF3Y2)

The demand margin forecast is received hourly from NGESO. It shows the weekly peak half hour MW value of generating plant demand margin for each day for the 2 to 156 weeks ahead. This API endpoint has a maximum data output range of 7 days. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # 2-156 weeks ahead demand margin forecast (OCNMF3Y2)
    api_response = api_instance.datasets_ocnmf3_y2_get(publish_date_time_from=publish_date_time_from,
                                                       publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ocnmf3_y2_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesForecastMarginDatasetRowsForecastMarginWeekly

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ocnmf3_y2_stream_get

list[InsightsApiModelsResponsesForecastMarginDatasetRowsForecastMarginWeekly] datasets_ocnmf3_y2_stream_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to)

2-156 weeks ahead demand margin forecast (OCNMF3Y2) stream

The demand margin forecast is received hourly from NGESO. It shows the weekly peak half hour MW value of generating plant demand margin for each day for the 2 to 156 weeks ahead. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # 2-156 weeks ahead demand margin forecast (OCNMF3Y2) stream
    api_response = api_instance.datasets_ocnmf3_y2_stream_get(publish_date_time_from=publish_date_time_from,
                                                              publish_date_time_to=publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ocnmf3_y2_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]

Return type

list[InsightsApiModelsResponsesForecastMarginDatasetRowsForecastMarginWeekly]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ocnmf3_y_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesForecastSurplusDatasetRowsForecastSurplusWeekly datasets_ocnmf3_y_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

2-156 weeks ahead demand surplus forecast (OCNMF3Y)

The demand surplus forecast data is received hourly from NGESO. It shows the weekly peak half hour MW value of generating plant demand surplus for each day for the 2-156 weeks ahead. This API endpoint provides a maximum data output range of 7 days. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # 2-156 weeks ahead demand surplus forecast (OCNMF3Y)
    api_response = api_instance.datasets_ocnmf3_y_get(publish_date_time_from=publish_date_time_from,
                                                      publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ocnmf3_y_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesForecastSurplusDatasetRowsForecastSurplusWeekly

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ocnmf3_y_stream_get

list[InsightsApiModelsResponsesForecastSurplusDatasetRowsForecastSurplusWeekly] datasets_ocnmf3_y_stream_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to)

2-156 weeks ahead demand surplus forecast (OCNMF3Y) stream

The demand surplus forecast data is received hourly from NGESO. It shows the weekly peak half hour MW value of generating plant demand surplus for each day for the 2-156 weeks ahead. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # 2-156 weeks ahead demand surplus forecast (OCNMF3Y) stream
    api_response = api_instance.datasets_ocnmf3_y_stream_get(publish_date_time_from=publish_date_time_from,
                                                             publish_date_time_to=publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ocnmf3_y_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]

Return type

list[InsightsApiModelsResponsesForecastSurplusDatasetRowsForecastSurplusWeekly]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ocnmfd2_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesForecastMarginDatasetRowsForecastMarginDaily datasets_ocnmfd2_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

2-14 days ahead demand margin forecast (OCNMFD2)

The demand margin forecast is received hourly from NGESO. It shows the daily peak half hour MW value of generating plant demand margin for each day for the 2 to 14 days ahead. This API endpoint provides a maximum data output range of 7 days. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # 2-14 days ahead demand margin forecast (OCNMFD2)
    api_response = api_instance.datasets_ocnmfd2_get(publish_date_time_from=publish_date_time_from,
                                                     publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ocnmfd2_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesForecastMarginDatasetRowsForecastMarginDaily

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ocnmfd2_stream_get

list[InsightsApiModelsResponsesForecastMarginDatasetRowsForecastMarginDaily] datasets_ocnmfd2_stream_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to)

2-14 days ahead demand margin forecast (OCNMFD2) stream

The demand margin forecast is received hourly from NGESO. It shows the daily peak half hour MW value of generating plant demand margin for each day for the 2 to 14 days ahead. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # 2-14 days ahead demand margin forecast (OCNMFD2) stream
    api_response = api_instance.datasets_ocnmfd2_stream_get(publish_date_time_from=publish_date_time_from,
                                                            publish_date_time_to=publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ocnmfd2_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]

Return type

list[InsightsApiModelsResponsesForecastMarginDatasetRowsForecastMarginDaily]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ocnmfd_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesForecastSurplusDatasetRowsForecastSurplusDaily datasets_ocnmfd_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

2-14 days ahead demand surplus forecast (OCNMFD)

The demand surplus forecast data is received hourly from NGESO. It shows the daily peak half hour MW value of generating plant demand surplus for each day for the 2 to 14 days ahead. This API endpoint provides a maximum data output range of 7 days. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # 2-14 days ahead demand surplus forecast (OCNMFD)
    api_response = api_instance.datasets_ocnmfd_get(publish_date_time_from=publish_date_time_from,
                                                    publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ocnmfd_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesForecastSurplusDatasetRowsForecastSurplusDaily

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ocnmfd_stream_get

list[InsightsApiModelsResponsesForecastSurplusDatasetRowsForecastSurplusDaily] datasets_ocnmfd_stream_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to)

2-14 days ahead demand surplus forecast (OCNMFD) stream

The demand surplus forecast data is received hourly from NGESO. It shows the daily peak half hour MW value of generating plant demand surplus for each day for the 2 to 14 days ahead. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # 2-14 days ahead demand surplus forecast (OCNMFD) stream
    api_response = api_instance.datasets_ocnmfd_stream_get(publish_date_time_from=publish_date_time_from,
                                                           publish_date_time_to=publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ocnmfd_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]

Return type

list[InsightsApiModelsResponsesForecastSurplusDatasetRowsForecastSurplusDaily]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_pbc_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsPbcDatasetRow datasets_pbc_get(publish_date_time_from, publish_date_time_to, format=format)

Procured Balancing Capacity (PBC)

This endpoint provides information on the procured balancing capacity, in accordance with the Electricity Balancing Guidelines (EBGL) article 12.3.f. This API endpoint has a maximum range of 1 day.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Procured Balancing Capacity (PBC)
    api_response = api_instance.datasets_pbc_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_pbc_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsPbcDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_pbc_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsPbcDatasetRow] datasets_pbc_stream_get(publish_date_time_from, publish_date_time_to)

Procured Balancing Capacity (PBC) stream

This endpoint provides information on the procured balancing capacity, in accordance with the Electricity Balancing Guidelines (EBGL) article 12.3.f. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Procured Balancing Capacity (PBC) stream
    api_response = api_instance.datasets_pbc_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_pbc_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsPbcDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_pn_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingPhysicalDatasetRowsPhysicalNotificationData datasets_pn_get(settlement_date, settlement_period, bm_unit=bm_unit, format=format)

Physical Notifications (PN)

This endpoint provides Physical Notification data received from NGESO. It returns the data valid for a single settlement period. A Physical Notification is the best estimate of the level of generation or demand that a participant in the BM expects a BM Unit to export or import, respectively, in a Settlement Period. Physical Notifications are submitted as a series of point MW values. The settlement period to query must be specified as a date and settlement period. The date should be provided in the format yyyy-MM-dd.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
settlement_date = '2013-10-20'  # date | The settlement date to query. This must be in the format yyyy-MM-dd.
settlement_period = 56  # int | The settlement period to query. This should be an integer from 1-50 inclusive.
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Physical Notifications (PN)
    api_response = api_instance.datasets_pn_get(settlement_date, settlement_period, bm_unit=bm_unit, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_pn_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
settlement_date	date	The settlement date to query. This must be in the format yyyy-MM-dd.
settlement_period	int	The settlement period to query. This should be an integer from 1-50 inclusive.
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingPhysicalDatasetRowsPhysicalNotificationData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_pn_stream_get

list[InsightsApiModelsResponsesBalancingPhysicalDatasetRowsPhysicalNotificationData] datasets_pn_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Physical Notifications (PN) stream

This endpoint provides Physical Notification data received from NGESO. A Physical Notification is the best estimate of the level of generation or demand that a participant in the BM expects a BM Unit to export or import, respectively, in a Settlement Period. Physical Notifications are submitted as a series of point MW values. The settlement period to query can be specified as a date and settlement period, or as a datetime which will resolve to the settlement period that time falls within. If a settlement period is provided, it will take precedence over the time portion of the datetime. Some examples of date parameter combinations are shown below. Filtering from settlement datetime to settlement datetime: /datasets/PN/stream?from=2022-07-01T00:00Z&to=2022-07-03T06:00Z Filtering from settlement datetime to settlement date and period: /datasets/PN/stream?from=2022-07-01T00:00Z&to=2022-07-03&settlementPeriodTo=15 Filtering from settlement date and period to settlement datetime: /datasets/PN/stream?from=2022-07-01&settlementPeriodFrom=3&to=2022-07-03T06:00Z Filtering from settlement date and period to settlement date and period: /datasets/PN/stream?from=2022-07-01&settlementPeriodFrom=3&to=2022-07-03&settlementPeriodTo=15 This endpoint has an optimised JSON payload and is aimed at frequent requests for PN data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The settlement date to query from.
to = '2013-10-20T19:20:30+01:00'  # datetime | The settlement date to query up to.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Physical Notifications (PN) stream
    api_response = api_instance.datasets_pn_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                       settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_pn_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The settlement date to query from.
to	datetime	The settlement date to query up to.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingPhysicalDatasetRowsPhysicalNotificationData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ppbr_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsPpbrDatasetRow datasets_ppbr_get(publish_date_time_from, publish_date_time_to, format=format)

Prices Of Procured Balancing Reserves (PPBR / B1730)

This endpoint provides prices of procured balancing reserves. This API endpoint has a maximum range of 2 years (731 days).

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Prices Of Procured Balancing Reserves (PPBR / B1730)
    api_response = api_instance.datasets_ppbr_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ppbr_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsPpbrDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ppbr_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsPpbrDatasetRow] datasets_ppbr_stream_get(publish_date_time_from, publish_date_time_to)

Prices Of Procured Balancing Reserves (PPBR / B1730) stream

This endpoint provides prices of procured balancing reserves. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Prices Of Procured Balancing Reserves (PPBR / B1730) stream
    api_response = api_instance.datasets_ppbr_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ppbr_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsPpbrDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_qas_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDatasetRowsBalancingServicesVolumeData datasets_qas_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit, format=format)

Balancing Services Volume (QAS)

This endpoint provides Balancing Services Volume data received from NGESO. Balancing Services Volume is a volume which is received from the System Operator, which represents the volume of energy (MWh) associated with the provision of Applicable Balancing Services for each relevant BM Unit and Settlement Period. QAS can be positive or negative and is normally only provided where there is a non-zero volume. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/qas?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/qas?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/qas?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/qas?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Balancing Services Volume (QAS)
    api_response = api_instance.datasets_qas_get(_from, to, settlement_period_from=settlement_period_from,
                                                 settlement_period_to=settlement_period_to, bm_unit=bm_unit,
                                                 format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_qas_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDatasetRowsBalancingServicesVolumeData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_qas_stream_get

list[InsightsApiModelsResponsesBalancingDatasetRowsBalancingServicesVolumeData] datasets_qas_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Balancing Services Volume (QAS) stream

This endpoint provides Balancing Services Volume data received from NGESO. Balancing Services Volume is a volume which is received from the System Operator, which represents the volume of energy (MWh) associated with the provision of Applicable Balancing Services for each relevant BM Unit and Settlement Period. QAS can be positive or negative and is normally only provided where there is a non-zero volume. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/qas/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/qas/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/qas/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/qas/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1 This endpoint has an optimised JSON payload and is aimed at frequent requests for QAS data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Balancing Services Volume (QAS) stream
    api_response = api_instance.datasets_qas_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                        settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_qas_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDatasetRowsBalancingServicesVolumeData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_qpn_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingPhysicalDatasetRowsPhysicalNotificationData datasets_qpn_get(settlement_date, settlement_period, bm_unit=bm_unit, format=format)

Quiescent Physical Notifications (QPN)

This endpoint provides Quiescent Physical Notification data received from NGESO. It returns the data valid for a single settlement period. Quiescent Physical Notifications describe the MW levels to be deducted from the Physical Notification of a BM Unit to determine a resultant operating level. The settlement period to query must be specified as a date and settlement period. The date should be provided in the format yyyy-MM-dd.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
settlement_date = '2013-10-20'  # date | The settlement date to query. This must be in the format yyyy-MM-dd.
settlement_period = 56  # int | The settlement period to query. This should be an integer from 1-50 inclusive.
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Quiescent Physical Notifications (QPN)
    api_response = api_instance.datasets_qpn_get(settlement_date, settlement_period, bm_unit=bm_unit, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_qpn_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
settlement_date	date	The settlement date to query. This must be in the format yyyy-MM-dd.
settlement_period	int	The settlement period to query. This should be an integer from 1-50 inclusive.
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingPhysicalDatasetRowsPhysicalNotificationData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_qpn_stream_get

list[InsightsApiModelsResponsesBalancingPhysicalDatasetRowsPhysicalNotificationData] datasets_qpn_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Quiescent Physical Notifications (QPN) stream

This endpoint provides Quiescent Physical Notification data received from NGESO. Quiescent Physical Notifications describe the MW levels to be deducted from the Physical Notification of a BM Unit to determine a resultant operating level. The settlement period to query can be specified as a date and settlement period, or as a datetime which will resolve to the settlement period that time falls within. If a settlement period is provided, it will take precedence over the time portion of the datetime. Some examples of date parameter combinations are shown below. Filtering from settlement datetime to settlement datetime: /datasets/QPN/stream?from=2022-07-01T00:00Z&to=2022-07-03T06:00Z Filtering from settlement datetime to settlement date and period: /datasets/QPN/stream?from=2022-07-01T00:00Z&to=2022-07-03&settlementPeriodTo=15 Filtering from settlement date and period to settlement datetime: /datasets/QPN/stream?from=2022-07-01&settlementPeriodFrom=3&to=2022-07-03T06:00Z Filtering from settlement date and period to settlement date and period: /datasets/QPN/stream?from=2022-07-01&settlementPeriodFrom=3&to=2022-07-03&settlementPeriodTo=15 This endpoint has an optimised JSON payload and is aimed at frequent requests for QPN data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The settlement date to query from.
to = '2013-10-20T19:20:30+01:00'  # datetime | The settlement date to query up to.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Quiescent Physical Notifications (QPN) stream
    api_response = api_instance.datasets_qpn_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                        settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_qpn_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The settlement date to query from.
to	datetime	The settlement date to query up to.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingPhysicalDatasetRowsPhysicalNotificationData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_rdre_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicRateData datasets_rdre_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit, format=format)

Run Down Rate Export (RDRE)

This endpoint provides Run Down Rate Export data received from NGESO. Run Down Rate Export (RDRE) expresses the rate of decrease in active power production (MW/minute) for a particular BM Unit which is exporting power within a particular operating range. There can be up to three of these for a given BM Unit. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/rdre?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/rdre?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/rdre?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/rdre?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Run Down Rate Export (RDRE)
    api_response = api_instance.datasets_rdre_get(_from, to, settlement_period_from=settlement_period_from,
                                                  settlement_period_to=settlement_period_to, bm_unit=bm_unit,
                                                  format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_rdre_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicRateData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_rdre_stream_get

list[InsightsApiModelsResponsesBalancingDynamicRateData] datasets_rdre_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Run Down Rate Export (RDRE) stream

This endpoint provides Run Down Rate Export data received from NGESO. Run Down Rate Export (RDRE) expresses the rate of decrease in active power production (MW/minute) for a particular BM Unit which is exporting power within a particular operating range. There can be up to three of these for a given BM Unit. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/rdre/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/rdre/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/rdre/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/rdre/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1 This endpoint has an optimised JSON payload and is aimed at frequent requests for QAS data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Run Down Rate Export (RDRE) stream
    api_response = api_instance.datasets_rdre_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                         settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_rdre_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDynamicRateData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_rdri_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicRateData datasets_rdri_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit, format=format)

Run Down Rate Import (RDRI)

This endpoint provides Run Down Rate Import data received from NGESO. Run Down Rate Import (RDRI) expresses the rate of increase in active power consumption (MW/minute) for a particular BM Unit which is importing power within a particular operating range. There can be up to three of these for a given BM Unit. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/rdri?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/rdri?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/rdri?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/rdri?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Run Down Rate Import (RDRI)
    api_response = api_instance.datasets_rdri_get(_from, to, settlement_period_from=settlement_period_from,
                                                  settlement_period_to=settlement_period_to, bm_unit=bm_unit,
                                                  format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_rdri_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicRateData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_rdri_stream_get

list[InsightsApiModelsResponsesBalancingDynamicRateData] datasets_rdri_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Run Down Rate Import (RDRI) stream

This endpoint provides Run Down Rate Import data received from NGESO. Run Down Rate Import (RDRI) expresses the rate of increase in active power consumption (MW/minute) for a particular BM Unit which is importing power within a particular operating range. There can be up to three of these for a given BM Unit. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/rdri/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/rdri/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/rdri/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/rdri/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1 This endpoint has an optimised JSON payload and is aimed at frequent requests for QAS data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Run Down Rate Import (RDRI) stream
    api_response = api_instance.datasets_rdri_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                         settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_rdri_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDynamicRateData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_remit_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyRemitDatasetRowsRemitMessage datasets_remit_get(publish_date_time_from, publish_date_time_to, format=format)

The Regulation on Wholesale Energy Markets Integrity and Transparency (REMIT)

The Regulation on Wholesale Energy Markets Integrity and Transparency (REMIT) is an EU regulation aimed at preventing market abuse in wholesale energy markets. This endpoint returns information provided by market participants to comply with Article 4 of Regulation on Wholesale Energy Market Integrity and Transparency (REMIT) Regulation (EU) 1227/2011. Only JSON and XML formats are supported for this endpoint.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # The Regulation on Wholesale Energy Markets Integrity and Transparency (REMIT)
    api_response = api_instance.datasets_remit_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_remit_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyRemitDatasetRowsRemitMessage

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_remit_stream_get

list[InsightsApiModelsResponsesTransparencyRemitDatasetRowsRemitMessage] datasets_remit_stream_get(publish_date_time_from, publish_date_time_to)

The Regulation on Wholesale Energy Markets Integrity and Transparency (REMIT) stream

The Regulation on Wholesale Energy Markets Integrity and Transparency (REMIT) is an EU regulation aimed at preventing market abuse in wholesale energy markets. This endpoint returns information provided by market participants to comply with Article 4 of Regulation on Wholesale Energy Market Integrity and Transparency (REMIT) Regulation (EU) 1227/2011. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # The Regulation on Wholesale Energy Markets Integrity and Transparency (REMIT) stream
    api_response = api_instance.datasets_remit_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_remit_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyRemitDatasetRowsRemitMessage]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_rure_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicRateData datasets_rure_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit, format=format)

Run Up Rate Export (RURE)

This endpoint provides Run Up Rate Export data received from NGESO. Run Up Rate Export (RURE) expresses the rate of increase in active power production (MW/minute) for a particular BM Unit which is exporting power within a particular operating range. There can be up to three of these for a given BM Unit. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/rure?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/rure?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/rure?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/rure?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Run Up Rate Export (RURE)
    api_response = api_instance.datasets_rure_get(_from, to, settlement_period_from=settlement_period_from,
                                                  settlement_period_to=settlement_period_to, bm_unit=bm_unit,
                                                  format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_rure_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicRateData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_rure_stream_get

list[InsightsApiModelsResponsesBalancingDynamicRateData] datasets_rure_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Run Up Rate Export (RURE) stream

This endpoint provides Run Up Rate Export data received from NGESO. Run Up Rate Export (RURE) expresses the rate of increase in active power production (MW/minute) for a particular BM Unit which is exporting power within a particular operating range. There can be up to three of these for a given BM Unit. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/rure/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/rure/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/rure/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/rure/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1 This endpoint has an optimised JSON payload and is aimed at frequent requests for QAS data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Run Up Rate Export (RURE) stream
    api_response = api_instance.datasets_rure_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                         settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_rure_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDynamicRateData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ruri_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicRateData datasets_ruri_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit, format=format)

Run Up Rate Import (RURI)

This endpoint provides Run Up Rate Import data received from NGESO. Run Up Rate Import (RURI) expresses the rate of decrease in active power consumption (MW/minute) for a particular BM Unit which is importing power within a particular operating range. There can be up to three of these for a given BM Unit. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/ruri?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/ruri?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/ruri?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/ruri?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Run Up Rate Import (RURI)
    api_response = api_instance.datasets_ruri_get(_from, to, settlement_period_from=settlement_period_from,
                                                  settlement_period_to=settlement_period_to, bm_unit=bm_unit,
                                                  format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ruri_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicRateData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_ruri_stream_get

list[InsightsApiModelsResponsesBalancingDynamicRateData] datasets_ruri_stream_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, bm_unit=bm_unit)

Run Up Rate Import (RURI) stream

This endpoint provides Run Up Rate Import data received from NGESO. Run Up Rate Import (RURI) expresses the rate of decrease in active power consumption (MW/minute) for a particular BM Unit which is importing power within a particular operating range. There can be up to three of these for a given BM Unit. By default, the from and to parameters filter the data by time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01. All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6\" target="_blank">RFC 3339. Some examples of date parameter combinations are shown below. Filtering from start time to start time: /datasets/ruri/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /datasets/ruri/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /datasets/ruri/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /datasets/ruri/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1 This endpoint has an optimised JSON payload and is aimed at frequent requests for QAS data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The \"from\" start time or settlement date for the filter.
to = '2013-10-20T19:20:30+01:00'  # datetime | The \"to\" start time or settlement date for the filter.
settlement_period_from = 56  # int | The \"from\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
settlement_period_to = 56  # int | The \"to\" settlement period for the filter. This should be an integer from 1-50 inclusive. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Run Up Rate Import (RURI) stream
    api_response = api_instance.datasets_ruri_stream_get(_from, to, settlement_period_from=settlement_period_from,
                                                         settlement_period_to=settlement_period_to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_ruri_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The "from" start time or settlement date for the filter.
to	datetime	The "to" start time or settlement date for the filter.
settlement_period_from	int	The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
settlement_period_to	int	The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDynamicRateData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_sel_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicDatasetRowsStablePortageLimitData datasets_sel_get(_from=_from, to=to, bm_unit=bm_unit, format=format)

Stable Export Limit (SEL)

This endpoint provides Stable Export Limit data received from NGESO. Stable Export Limit is a positive megawatt value, expressing the minimum stable operating level at which a particular BM Unit can export power to the transmission system. If no date window is chosen, the search will default to results from last 24 hours.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The start of the data time window. (optional)
to = '2013-10-20T19:20:30+01:00'  # datetime | The end of the data time window. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Stable Export Limit (SEL)
    api_response = api_instance.datasets_sel_get(_from=_from, to=to, bm_unit=bm_unit, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_sel_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The start of the data time window.	[optional]
to	datetime	The end of the data time window.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicDatasetRowsStablePortageLimitData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_sel_stream_get

list[InsightsApiModelsResponsesBalancingDynamicDatasetRowsStablePortageLimitData] datasets_sel_stream_get(_from=_from, to=to, bm_unit=bm_unit)

Stable Export Limit (SEL) stream

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The start of the data time window. (optional)
to = '2013-10-20T19:20:30+01:00'  # datetime | The end of the data time window. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Stable Export Limit (SEL) stream
    api_response = api_instance.datasets_sel_stream_get(_from=_from, to=to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_sel_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The start of the data time window.	[optional]
to	datetime	The end of the data time window.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDynamicDatasetRowsStablePortageLimitData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_sil_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicDatasetRowsStablePortageLimitData datasets_sil_get(_from=_from, to=to, bm_unit=bm_unit, format=format)

Stable Import Limit (SIL)

This endpoint provides Stable Import Limit data received from NGESO. Stable Import Limit is a negative megawatt value, expressing the minimum stable operating level at which a particular BM Unit can import power from the transmission system. If no date window is chosen, the search will default to results from last 24 hours.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The start of the data time window. (optional)
to = '2013-10-20T19:20:30+01:00'  # datetime | The end of the data time window. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Stable Import Limit (SIL)
    api_response = api_instance.datasets_sil_get(_from=_from, to=to, bm_unit=bm_unit, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_sil_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The start of the data time window.	[optional]
to	datetime	The end of the data time window.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesBalancingDynamicDatasetRowsStablePortageLimitData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_sil_stream_get

list[InsightsApiModelsResponsesBalancingDynamicDatasetRowsStablePortageLimitData] datasets_sil_stream_get(_from=_from, to=to, bm_unit=bm_unit)

Stable Import Limit (SIL) stream

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime | The start of the data time window. (optional)
to = '2013-10-20T19:20:30+01:00'  # datetime | The end of the data time window. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed. (optional)

try:
    # Stable Import Limit (SIL) stream
    api_response = api_instance.datasets_sil_stream_get(_from=_from, to=to, bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_sil_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime	The start of the data time window.	[optional]
to	datetime	The end of the data time window.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.	[optional]

Return type

list[InsightsApiModelsResponsesBalancingDynamicDatasetRowsStablePortageLimitData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_soso_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesMiscDatasetRowsSoSoPricesDatasetRow datasets_soso_get(publish_date_time_from, publish_date_time_to, format=format)

SO-SO prices (SOSO)

This endpoint provides system operator to system operator prices data, filtered by publish time. This API endpoint has a maximum range of 24 hours.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # SO-SO prices (SOSO)
    api_response = api_instance.datasets_soso_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_soso_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesMiscDatasetRowsSoSoPricesDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_soso_stream_get

list[InsightsApiModelsResponsesMiscDatasetRowsSoSoPricesDatasetRow] datasets_soso_stream_get(publish_date_time_from, publish_date_time_to)

SO-SO prices (SOSO) stream

This endpoint provides system operator to system operator prices data, filtered by publish time. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # SO-SO prices (SOSO) stream
    api_response = api_instance.datasets_soso_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_soso_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesMiscDatasetRowsSoSoPricesDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_syswarn_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesMiscDatasetRowsSystemWarningsData datasets_syswarn_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

System warnings (SYSWARN)

This endpoint provides system warnings data

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # System warnings (SYSWARN)
    api_response = api_instance.datasets_syswarn_get(publish_date_time_from=publish_date_time_from,
                                                     publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_syswarn_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesMiscDatasetRowsSystemWarningsData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_syswarn_stream_get

list[InsightsApiModelsResponsesMiscDatasetRowsSystemWarningsData] datasets_syswarn_stream_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to)

System warnings (SYSWARN) stream

This endpoint provides system warnings data This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # System warnings (SYSWARN) stream
    api_response = api_instance.datasets_syswarn_stream_get(publish_date_time_from=publish_date_time_from,
                                                            publish_date_time_to=publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_syswarn_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]

Return type

list[InsightsApiModelsResponsesMiscDatasetRowsSystemWarningsData]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_temp_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesMiscDatasetRowsTemperatureData datasets_temp_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

Temperature data (TEMP)

This endpoint provides the average degree celsius value measured at midday deemed to be representative of the temperature for Great Britain. Data is gathered from 6 weather stations. Default output will be the last 31 days. Values are received from 5pm each day.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Temperature data (TEMP)
    api_response = api_instance.datasets_temp_get(publish_date_time_from=publish_date_time_from,
                                                  publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_temp_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesMiscDatasetRowsTemperatureData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_tsdf_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastTransmissionDayAhead datasets_tsdf_get(boundary=boundary, publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

Day and day-ahead Transmission System Demand forecast (TSDF)

This endpoint provides the Transmission System Demand forecast. Data is received daily from NGESO and will show values for the day ahead. Expressed as an average MW value for each settlement period. The Transmission System Demand forecast is based on historically metered generation output for Great Britain. This value INCLUDES interconnector flows and demand from station transformers and pumped storage units. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast. This API endpoint provides a maximum data output range of 1 day.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
boundary = 'boundary_example'  # str |  (optional)
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Day and day-ahead Transmission System Demand forecast (TSDF)
    api_response = api_instance.datasets_tsdf_get(boundary=boundary, publish_date_time_from=publish_date_time_from,
                                                  publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_tsdf_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
boundary	str		[optional]
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastTransmissionDayAhead

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_tsdf_stream_get

list[InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastTransmissionDayAhead] datasets_tsdf_stream_get(boundary=boundary, publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to)

Day and day-ahead Transmission System Demand forecast (TSDF) stream

This endpoint provides the Transmission System Demand forecast . Data is received daily from NGESO and will show values for the day ahead. Expressed as an average MW value for each settlement period. The Transmission System Demand forecast is based on historically metered generation output for Great Britain. This value INCLUDES interconnector flows and demand from station transformers and pumped storage units. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
boundary = 'boundary_example'  # str |  (optional)
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # Day and day-ahead Transmission System Demand forecast (TSDF) stream
    api_response = api_instance.datasets_tsdf_stream_get(boundary=boundary,
                                                         publish_date_time_from=publish_date_time_from,
                                                         publish_date_time_to=publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_tsdf_stream_get: %s\n" % e)

Parameters

Name	Type	Notes
boundary	str	[optional]
publish_date_time_from	datetime	[optional]
publish_date_time_to	datetime	[optional]

Return type

list[InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastTransmissionDayAhead]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_tsdfd_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastTransmissionDaily datasets_tsdfd_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

2-14 days ahead Transmission System Demand and surplus forecast (TSDFD)

This endpoint provides the Transmission System forecast. Data is available daily and will show values for the 2 to 14 days ahead. Expressed as an average MW value for each settlement period. The Transmission System Demand forecast is based on historically metered generation output for Great Britain. This value INCLUDES interconnector flows and demand from station transformers and pumped storage units. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast. This API endpoint provides a maximum data output range of 92 days.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # 2-14 days ahead Transmission System Demand and surplus forecast (TSDFD)
    api_response = api_instance.datasets_tsdfd_get(publish_date_time_from=publish_date_time_from,
                                                   publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_tsdfd_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastTransmissionDaily

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_tsdfd_stream_get

list[InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastTransmissionDaily] datasets_tsdfd_stream_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to)

2-14 days ahead Transmission System Demand and surplus forecast (TSDFD) stream

This endpoint provides the Transmission System Demand forecast. Data is available daily and will show values for the 2 to 14 days ahead. Expressed as an average MW value for each settlement period. The Transmission System Demand forecast is based on historically metered generation output for Great Britain. This value INCLUDES interconnector flows and demand from station transformers and pumped storage units. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # 2-14 days ahead Transmission System Demand and surplus forecast (TSDFD) stream
    api_response = api_instance.datasets_tsdfd_stream_get(publish_date_time_from=publish_date_time_from,
                                                          publish_date_time_to=publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_tsdfd_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]

Return type

list[InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastTransmissionDaily]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_tsdfw_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastTransmissionWeekly datasets_tsdfw_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

2-52 weeks ahead Transmission System Demand and surplus forecast (TSDFW)

This endpoint provides the Transmission System Demand forecast received from NGESO. Data is available from 4pm each Thursday and will show values for the 2 to 52 weeks ahead. Expressed as an average MW value for each week. The forecast is based on historically metered generation output for Great Britain. This value INCLUDES transmission losses, but EXCLUDES interconnector flows and demand from station. This API will provide a maximum data output range of 366 days. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # 2-52 weeks ahead Transmission System Demand and surplus forecast (TSDFW)
    api_response = api_instance.datasets_tsdfw_get(publish_date_time_from=publish_date_time_from,
                                                   publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_tsdfw_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastTransmissionWeekly

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_tsdfw_stream_get

list[InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastTransmissionWeekly] datasets_tsdfw_stream_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to)

2-52 weeks ahead Transmission System Demand and surplus forecast (TSDFW) stream

This endpoint provides the Transmission System Demand forecast received from NGESO. Data is available from 4pm each Thursday and will show values for the 2 to 52 weeks ahead. Expressed as an average MW value for each week. The forecast is based on historically metered generation output for Great Britain. This value INCLUDES transmission losses, but EXCLUDES interconnector flows and demand from station. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # 2-52 weeks ahead Transmission System Demand and surplus forecast (TSDFW) stream
    api_response = api_instance.datasets_tsdfw_stream_get(publish_date_time_from=publish_date_time_from,
                                                          publish_date_time_to=publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_tsdfw_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]

Return type

list[InsightsApiModelsResponsesDemandForecastDatasetRowsDemandForecastTransmissionWeekly]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_tudm_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesMiscDatasetRowsTudmDatasetRow datasets_tudm_get(settlement_date, settlement_period, trading_unit_name=trading_unit_name, trading_unit_type=trading_unit_type, format=format)

Trading unit data (S0491_TUDM)

This endpoint provides trading unit data for a settlement period filtered by trading unit name and type.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
settlement_date = '2013-10-20'  # date | The settlement date to filter. This must be in the format yyyy-MM-dd.
settlement_period = 56  # int | 
trading_unit_name = ['trading_unit_name_example']  # list[str] |  (optional)
trading_unit_type = 'trading_unit_type_example'  # str |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Trading unit data (S0491_TUDM)
    api_response = api_instance.datasets_tudm_get(settlement_date, settlement_period,
                                                  trading_unit_name=trading_unit_name,
                                                  trading_unit_type=trading_unit_type, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_tudm_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
settlement_date	date	The settlement date to filter. This must be in the format yyyy-MM-dd.
settlement_period	int
trading_unit_name	list[str]		[optional]
trading_unit_type	str		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesMiscDatasetRowsTudmDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_tudm_stream_get

list[InsightsApiModelsResponsesMiscDatasetRowsTudmDatasetRow] datasets_tudm_stream_get(settlement_date_from, settlement_period_from, settlement_date_to, settlement_period_to, trading_unit_name=trading_unit_name, trading_unit_type=trading_unit_type)

Trading unit data (S0491_TUDM) stream

This endpoint provides trading unit data filtered by settlement period, trading unit name and type. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
settlement_date_from = '2013-10-20'  # date | The settlement date to filter from. This must be in the format yyyy-MM-dd.
settlement_period_from = 56  # int | 
settlement_date_to = '2013-10-20'  # date | The settlement date to filter to. This must be in the format yyyy-MM-dd.
settlement_period_to = 56  # int | 
trading_unit_name = ['trading_unit_name_example']  # list[str] |  (optional)
trading_unit_type = 'trading_unit_type_example'  # str |  (optional)

try:
    # Trading unit data (S0491_TUDM) stream
    api_response = api_instance.datasets_tudm_stream_get(settlement_date_from, settlement_period_from,
                                                         settlement_date_to, settlement_period_to,
                                                         trading_unit_name=trading_unit_name,
                                                         trading_unit_type=trading_unit_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_tudm_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
settlement_date_from	date	The settlement date to filter from. This must be in the format yyyy-MM-dd.
settlement_period_from	int
settlement_date_to	date	The settlement date to filter to. This must be in the format yyyy-MM-dd.
settlement_period_to	int
trading_unit_name	list[str]		[optional]
trading_unit_type	str		[optional]

Return type

list[InsightsApiModelsResponsesMiscDatasetRowsTudmDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_uou2_t14_d_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsAvailabilityByBmUnitDaily datasets_uou2_t14_d_get(fuel_type=fuel_type, publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, bm_unit=bm_unit, format=format)

2 to 14 days ahead generation availability aggregated by Balancing Mechanism Units (UOU2T14D)

This endpoint provides a forward view of availability (also referred to as Output Usable data under the Grid Code) for generation and interconnector capacity, accounting for planned outages covering availability data from 2 days ahead to 14 days ahead; it is aggregated by National Grid Balancing Mechanism Units (NGC BMUs). In the context of this report, BMUs can be considered as generating units. Elexon BMUs differs from NGC BMUs by including a prefix e.g. 'T_'. The mapping between NGC and Elexon BMUs can be retrieved via reference data API endpoints.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
fuel_type = [
    'fuel_type_example']  # list[str] | The fuel type to query. Add each fuel type separately. If no fuel types are supplied, all fuel types will be returned. (optional)
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | Start of the Publish Time range to query. If specified, PublishDateTimeTo must also be specified.  If both are omitted, latest published data is returned. (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | End of the Publish Time range to query. If specified, PublishDateTimeFrom must also be specified.  If both are omitted, latest published data is returned. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. Either the Elexon ID or the National Grid ID can be used.  If no BM unit is supplied all BM units will be returned. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # 2 to 14 days ahead generation availability aggregated by Balancing Mechanism Units (UOU2T14D)
    api_response = api_instance.datasets_uou2_t14_d_get(fuel_type=fuel_type,
                                                        publish_date_time_from=publish_date_time_from,
                                                        publish_date_time_to=publish_date_time_to, bm_unit=bm_unit,
                                                        format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_uou2_t14_d_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
fuel_type	list[str]	The fuel type to query. Add each fuel type separately. If no fuel types are supplied, all fuel types will be returned.	[optional]
publish_date_time_from	datetime	Start of the Publish Time range to query. If specified, PublishDateTimeTo must also be specified. If both are omitted, latest published data is returned.	[optional]
publish_date_time_to	datetime	End of the Publish Time range to query. If specified, PublishDateTimeFrom must also be specified. If both are omitted, latest published data is returned.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. Either the Elexon ID or the National Grid ID can be used. If no BM unit is supplied all BM units will be returned.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsAvailabilityByBmUnitDaily

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_uou2_t14_d_stream_get

list[InsightsApiModelsResponsesGenerationDatasetRowsAvailabilityByBmUnitDaily] datasets_uou2_t14_d_stream_get(fuel_type=fuel_type, publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, bm_unit=bm_unit)

2 to 14 days ahead generation availability aggregated by Balancing Mechanism Units (UOU2T14D) stream

This endpoint provides a forward view of availability (also referred to as Output Usable data under the Grid Code) for generation and interconnector capacity, accounting for planned outages covering availability data from 2 days ahead to 14 days ahead; it is aggregated by National Grid Balancing Mechanism Units (NGC BMUs). In the context of this report, BMUs can be considered as generating units. Elexon BMUs differs from NGC BMUs by including a prefix e.g. 'T_'. The mapping between NGC and Elexon BMUs can be retrieved via reference data API endpoints. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
fuel_type = [
    'fuel_type_example']  # list[str] | The fuel type to query. Add each fuel type separately. If no fuel types are supplied, all fuel types will be returned. (optional)
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | Start of the Publish Time range to query. If specified, PublishDateTimeTo must also be specified.  If both are omitted, latest published data is returned. (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | End of the Publish Time range to query. If specified, PublishDateTimeFrom must also be specified.  If both are omitted, latest published data is returned. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. Either the Elexon ID or the National Grid ID can be used.  If no BM unit is supplied all BM units will be returned. (optional)

try:
    # 2 to 14 days ahead generation availability aggregated by Balancing Mechanism Units (UOU2T14D) stream
    api_response = api_instance.datasets_uou2_t14_d_stream_get(fuel_type=fuel_type,
                                                               publish_date_time_from=publish_date_time_from,
                                                               publish_date_time_to=publish_date_time_to,
                                                               bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_uou2_t14_d_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
fuel_type	list[str]	The fuel type to query. Add each fuel type separately. If no fuel types are supplied, all fuel types will be returned.	[optional]
publish_date_time_from	datetime	Start of the Publish Time range to query. If specified, PublishDateTimeTo must also be specified. If both are omitted, latest published data is returned.	[optional]
publish_date_time_to	datetime	End of the Publish Time range to query. If specified, PublishDateTimeFrom must also be specified. If both are omitted, latest published data is returned.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. Either the Elexon ID or the National Grid ID can be used. If no BM unit is supplied all BM units will be returned.	[optional]

Return type

list[InsightsApiModelsResponsesGenerationDatasetRowsAvailabilityByBmUnitDaily]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_uou2_t3_yw_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsAvailabilityByBmUnitWeekly datasets_uou2_t3_yw_get(fuel_type=fuel_type, publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, bm_unit=bm_unit, format=format)

2 to 156 weeks ahead generation availability aggregated by Balancing Mechanism Units (UOU2T3YW)

This endpoint forward view of availability (also referred to as Output Usable data under the Grid Code) for generation and interconnector capacity, accounting for planned outages covering availability data from 2 weeks ahead to 156 weeks ahead; it is aggregated by Balancing Mechanism Units (BMUs). In the context of this report, BMUs can be considered as generating units. Elexon BMUs differs from NGC BMUs by including a prefix e.g. 'T_'. The mapping between NGC and Elexon BMUs can be retrieved via reference data API endpoints.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
fuel_type = [
    'fuel_type_example']  # list[str] | The fuel type to query. Add each fuel type separately. If no fuel types are supplied, all fuel types will be returned. (optional)
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | Start of the Publish Time range to query. If specified, PublishDateTimeTo must also be specified.  If both are omitted, latest published data is returned. (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | End of the Publish Time range to query. If specified, PublishDateTimeFrom must also be specified.  If both are omitted, latest published data is returned. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. Either the Elexon ID or the National Grid ID can be used.  If no BM unit is supplied all BM units will be returned. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # 2 to 156 weeks ahead generation availability aggregated by Balancing Mechanism Units (UOU2T3YW)
    api_response = api_instance.datasets_uou2_t3_yw_get(fuel_type=fuel_type,
                                                        publish_date_time_from=publish_date_time_from,
                                                        publish_date_time_to=publish_date_time_to, bm_unit=bm_unit,
                                                        format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_uou2_t3_yw_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
fuel_type	list[str]	The fuel type to query. Add each fuel type separately. If no fuel types are supplied, all fuel types will be returned.	[optional]
publish_date_time_from	datetime	Start of the Publish Time range to query. If specified, PublishDateTimeTo must also be specified. If both are omitted, latest published data is returned.	[optional]
publish_date_time_to	datetime	End of the Publish Time range to query. If specified, PublishDateTimeFrom must also be specified. If both are omitted, latest published data is returned.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. Either the Elexon ID or the National Grid ID can be used. If no BM unit is supplied all BM units will be returned.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsAvailabilityByBmUnitWeekly

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_uou2_t3_yw_stream_get

list[InsightsApiModelsResponsesGenerationDatasetRowsAvailabilityByBmUnitWeekly] datasets_uou2_t3_yw_stream_get(fuel_type=fuel_type, publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, bm_unit=bm_unit)

2 to 156 weeks ahead generation availability aggregated by Balancing Mechanism Units (UOU2T3YW) stream

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
fuel_type = [
    'fuel_type_example']  # list[str] | The fuel type to query. Add each fuel type separately. If no fuel types are supplied, all fuel types will be returned. (optional)
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | Start of the Publish Time range to query. If specified, PublishDateTimeTo must also be specified.  If both are omitted, latest published data is returned. (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | End of the Publish Time range to query. If specified, PublishDateTimeFrom must also be specified.  If both are omitted, latest published data is returned. (optional)
bm_unit = [
    'bm_unit_example']  # list[str] | The BM units to query. Add each unit separately. Either the Elexon ID or the National Grid ID can be used.  If no BM unit is supplied all BM units will be returned. (optional)

try:
    # 2 to 156 weeks ahead generation availability aggregated by Balancing Mechanism Units (UOU2T3YW) stream
    api_response = api_instance.datasets_uou2_t3_yw_stream_get(fuel_type=fuel_type,
                                                               publish_date_time_from=publish_date_time_from,
                                                               publish_date_time_to=publish_date_time_to,
                                                               bm_unit=bm_unit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_uou2_t3_yw_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
fuel_type	list[str]	The fuel type to query. Add each fuel type separately. If no fuel types are supplied, all fuel types will be returned.	[optional]
publish_date_time_from	datetime	Start of the Publish Time range to query. If specified, PublishDateTimeTo must also be specified. If both are omitted, latest published data is returned.	[optional]
publish_date_time_to	datetime	End of the Publish Time range to query. If specified, PublishDateTimeFrom must also be specified. If both are omitted, latest published data is returned.	[optional]
bm_unit	list[str]	The BM units to query. Add each unit separately. Either the Elexon ID or the National Grid ID can be used. If no BM unit is supplied all BM units will be returned.	[optional]

Return type

list[InsightsApiModelsResponsesGenerationDatasetRowsAvailabilityByBmUnitWeekly]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_watl_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsWeekAheadTotalLoadPerBiddingZoneDatasetRow datasets_watl_get(publish_date_time_from, publish_date_time_to, format=format)

Week-Ahead Total Load Forecast Per Bidding Zone (WATL / B0630)

This endpoint provides week-ahead total load forecast per bidding zone data with minimum possible and maximum available loads provided in MW values. This API endpoint has a maximum range of 367 days.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Week-Ahead Total Load Forecast Per Bidding Zone (WATL / B0630)
    api_response = api_instance.datasets_watl_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_watl_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsWeekAheadTotalLoadPerBiddingZoneDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_watl_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsWeekAheadTotalLoadPerBiddingZoneDatasetRow] datasets_watl_stream_get(publish_date_time_from, publish_date_time_to)

Week-Ahead Total Load Forecast Per Bidding Zone (WATL / B0630) stream

This endpoint provides week-ahead total load forecast per bidding zone data with minimum possible and maximum available loads provided in MW values. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Week-Ahead Total Load Forecast Per Bidding Zone (WATL / B0630) stream
    api_response = api_instance.datasets_watl_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_watl_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsWeekAheadTotalLoadPerBiddingZoneDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_windfor_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsWindGenerationForecast datasets_windfor_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to, format=format)

Wind generation forecast (WINDFOR)

This endpoint provides wind generation forecast data. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Wind generation forecast (WINDFOR)
    api_response = api_instance.datasets_windfor_get(publish_date_time_from=publish_date_time_from,
                                                     publish_date_time_to=publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_windfor_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesGenerationDatasetRowsWindGenerationForecast

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_windfor_stream_get

list[InsightsApiModelsResponsesGenerationDatasetRowsWindGenerationForecast] datasets_windfor_stream_get(publish_date_time_from=publish_date_time_from, publish_date_time_to=publish_date_time_to)

Wind generation forecast (WINDFOR) stream

This endpoint provides wind generation forecast data. Specific publish time filters may be supplied, otherwise this will retrieve the latest published forecast. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # Wind generation forecast (WINDFOR) stream
    api_response = api_instance.datasets_windfor_stream_get(publish_date_time_from=publish_date_time_from,
                                                            publish_date_time_to=publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_windfor_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime		[optional]
publish_date_time_to	datetime		[optional]

Return type

list[InsightsApiModelsResponsesGenerationDatasetRowsWindGenerationForecast]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_yafm_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsYearAheadForecastMarginDatasetRow datasets_yafm_get(publish_date_time_from, publish_date_time_to, format=format)

Year Ahead Forecast Margin (YAFM / B0810)

This endpoint provides year-ahead forecast margin data. A year-ahead forecast margin is defined as the difference between yearly forecast of available generation capacity and yearly forecast of total load, taking into account the forecast of total generation capacity, forecast of availability of generation and forecast of reserves contracted for system services. This API endpoint has a maximum range of 20 years (7305 days).

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Year Ahead Forecast Margin (YAFM / B0810)
    api_response = api_instance.datasets_yafm_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_yafm_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsYearAheadForecastMarginDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_yafm_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsYearAheadForecastMarginDatasetRow] datasets_yafm_stream_get(publish_date_time_from, publish_date_time_to)

Year Ahead Forecast Margin (YAFM / B0810) stream

This endpoint provides year-ahead forecast margin data. A year-ahead forecast margin is defined as the difference between yearly forecast of available generation capacity and yearly forecast of total load, taking into account the forecast of total generation capacity, forecast of availability of generation and forecast of reserves contracted for system services. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Year Ahead Forecast Margin (YAFM / B0810) stream
    api_response = api_instance.datasets_yafm_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_yafm_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Return type

list[InsightsApiModelsResponsesTransparencyDatasetRowsYearAheadForecastMarginDatasetRow]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_yatl_get

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsYearAheadTotalLoadPerBiddingZoneDatasetRow datasets_yatl_get(publish_date_time_from, publish_date_time_to, format=format)

Year-Ahead Total Load Forecast Per Bidding Zone (YATL / B0650)

This endpoint provides year-ahead total load per bidding zone forecast data with minimum possible and maximum available loads provided in MW values. This API endpoint has a maximum range of 367 days.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Year-Ahead Total Load Forecast Per Bidding Zone (YATL / B0650)
    api_response = api_instance.datasets_yatl_get(publish_date_time_from, publish_date_time_to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_yatl_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesDatasetResponse1InsightsApiModelsResponsesTransparencyDatasetRowsYearAheadTotalLoadPerBiddingZoneDatasetRow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

datasets_yatl_stream_get

list[InsightsApiModelsResponsesTransparencyDatasetRowsYearAheadTotalLoadPerBiddingZoneDatasetRow] datasets_yatl_stream_get(publish_date_time_from, publish_date_time_to)

Year-Ahead Total Load Forecast Per Bidding Zone (YATL / B0650) stream

This endpoint provides year-ahead total load per bidding zone forecast data with minimum possible and maximum available loads provided in MW values. This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.DatasetsApi()
publish_date_time_from = '2013-10-20T19:20:30+01:00'  # datetime | 
publish_date_time_to = '2013-10-20T19:20:30+01:00'  # datetime | 

try:
    # Year-Ahead Total Load Forecast Per Bidding Zone (YATL / B0650) stream
    api_response = api_instance.datasets_yatl_stream_get(publish_date_time_from, publish_date_time_to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->datasets_yatl_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
publish_date_time_from	datetime
publish_date_time_to	datetime

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]