swagger_client.BalancingServicesAdjustmentNetApi

July 10, 2024 · View on GitHub

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

Method	HTTP request	Description
balancing_nonbm_netbsad_events_get	GET /balancing/nonbm/netbsad/events	Net balancing services adjustment events (NETBSAD)
balancing_nonbm_netbsad_get	GET /balancing/nonbm/netbsad	Net balancing services adjustment time series (NETBSAD)

balancing_nonbm_netbsad_events_get

InsightsApiModelsResponsesResponseWithMetadata1InsightsApiModelsResponsesBalancingNetBalancingServicesAdjustmentResponse balancing_nonbm_netbsad_events_get(count, before=before, settlement_period_before=settlement_period_before, format=format)

Net balancing services adjustment events (NETBSAD)

This endpoint provides data about the start of NGESO Net Balancing Services Adjustment (NETBSAD) events. An event is a point in time where one of the NETBSAD values has changed from 0 to a value. Each event details the start time of the event and the NETBSAD values associated with the start of the event. By default, the before parameter filters the data by start time. If the settlementPeriodBefore parameter is provided, the before parameter instead filters on settlement date, allowing for searching by start time or settlement date & settlement period. Note: When filtering via settlement date, before is treated as a Date 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 latest 3 events: /balancing/nonbm/netbsad/events?count=3 Filtering latest 3 events before start time: /balancing/nonbm/netbsad/events?before=2022-08-01T00:00Z&count=3 Filtering latest 3 events before settlement date and settlement period: /balancing/nonbm/netbsad/events?before=2022-08-01T00:00Z&settlementPeriodBefore=48&count=3

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.BalancingServicesAdjustmentNetApi()
count = 56  # int | The number of events to return.
before = '2013-10-20T19:20:30+01:00'  # datetime | If specified, filters events to those with a start time before or at the date, or a settlement date before the date if  settlementPeriodBefore is also specified.  If omitted, latest events are returned. (optional)
settlement_period_before = 56  # int | Filters events to those with a settlement period before or at the value.  Before parameter must be specified if this is specified. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Net balancing services adjustment events (NETBSAD)
    api_response = api_instance.balancing_nonbm_netbsad_events_get(count, before=before,
                                                                   settlement_period_before=settlement_period_before,
                                                                   format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalancingServicesAdjustmentNetApi->balancing_nonbm_netbsad_events_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
count	int	The number of events to return.
before	datetime	If specified, filters events to those with a start time before or at the date, or a settlement date before the date if settlementPeriodBefore is also specified. If omitted, latest events are returned.	[optional]
settlement_period_before	int	Filters events to those with a settlement period before or at the value. Before parameter must be specified if this is specified.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

Return type

InsightsApiModelsResponsesResponseWithMetadata1InsightsApiModelsResponsesBalancingNetBalancingServicesAdjustmentResponse

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]

balancing_nonbm_netbsad_get

InsightsApiModelsResponsesResponseWithMetadata1InsightsApiModelsResponsesBalancingNetBalancingServicesAdjustmentResponse balancing_nonbm_netbsad_get(_from, to, settlement_period_from=settlement_period_from, settlement_period_to=settlement_period_to, include_zero=include_zero, format=format)

Net balancing services adjustment time series (NETBSAD)

This endpoint provides data about the Net Balancing Services Adjustment (NETBSAD). Each entry in the time series contains the NETBSAD values for that 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: /balancing/nonbm/netbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z Filtering from start time to settlement date and period: /balancing/nonbm/netbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1 Filtering from settlement date and period to start time: /balancing/nonbm/netbsad?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1 Filtering from settlement date and period to settlement date and period: /balancing/nonbm/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.BalancingServicesAdjustmentNetApi()
_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)
include_zero = true  # bool | Include data points with a generation of zero. (optional)
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Net balancing services adjustment time series (NETBSAD)
    api_response = api_instance.balancing_nonbm_netbsad_get(_from, to, settlement_period_from=settlement_period_from,
                                                            settlement_period_to=settlement_period_to,
                                                            include_zero=include_zero, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalancingServicesAdjustmentNetApi->balancing_nonbm_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]
include_zero	bool	Include data points with a generation of zero.	[optional]
format	str	Response data format. Use json/xml to include metadata.	[optional]

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]