swagger_client.SystemApi

July 10, 2024 · View on GitHub

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

Method	HTTP request	Description
system_demand_control_instructions_get	GET /system/demand-control-instructions	Demand control instructions (DCI)
system_frequency_get	GET /system/frequency	System frequency (FREQ)
system_frequency_stream_get	GET /system/frequency/stream	System frequency (FREQ) stream
system_warnings_get	GET /system/warnings	System warnings (SYSWARN)

system_demand_control_instructions_get

InsightsApiModelsResponsesResponseWithMetadata1InsightsApiModelsResponsesMiscDemandControlInstructionData system_demand_control_instructions_get(_from=_from, to=to, format=format)

Demand control instructions (DCI)

This endpoint provides demand control instruction data, filtered by the time range of the instruction. There is no date range limit on parameters. If no query parameters are supplied all data is returned.

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.SystemApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
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.system_demand_control_instructions_get(_from=_from, to=to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemApi->system_demand_control_instructions_get: %s\n" % e)

Parameters

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

Return type

InsightsApiModelsResponsesResponseWithMetadata1InsightsApiModelsResponsesMiscDemandControlInstructionData

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]

system_frequency_get

InsightsApiModelsResponsesResponseWithMetadata1InsightsApiModelsResponsesMiscSystemFrequency system_frequency_get(_from=_from, to=to, format=format)

System frequency (FREQ)

This endpoint allows for retrieving a collection of recent system frequency data from National Grid ESO. Results can be filtered by a range of DateTime parameters. This endpoint is useful for ad-hoc querying frequency 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.SystemApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
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.system_frequency_get(_from=_from, to=to, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemApi->system_frequency_get: %s\n" % e)

Parameters

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

Return type

InsightsApiModelsResponsesResponseWithMetadata1InsightsApiModelsResponsesMiscSystemFrequency

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]

system_frequency_stream_get

list[InsightsApiModelsResponsesMiscSystemFrequency] system_frequency_stream_get(_from=_from, to=to)

System frequency (FREQ) stream

This endpoint allows for retrieving a stream of recent system frequency data from National Grid ESO. Results can be filtered by a range of DateTime parameters. This endpoint has an optimised JSON payload and aimed at frequent request for the frequency 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.SystemApi()
_from = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)
to = '2013-10-20T19:20:30+01:00'  # datetime |  (optional)

try:
    # System frequency (FREQ) stream
    api_response = api_instance.system_frequency_stream_get(_from=_from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemApi->system_frequency_stream_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
_from	datetime		[optional]
to	datetime		[optional]

Return type

list[InsightsApiModelsResponsesMiscSystemFrequency]

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]

system_warnings_get

InsightsApiModelsResponsesResponseWithMetadata1InsightsApiModelsResponsesMiscSystemWarningsData system_warnings_get(warning_type=warning_type, 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. Results can be filtered by warning type and a range of DateTime parameters. - If no parameters are specified then the latest message is returned - If just a warning type is specified then the latest message of that type is returned - If just publish times are specified then all messages within that range are returned

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.SystemApi()
warning_type = 'warning_type_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:
    # System warnings (SYSWARN)
    api_response = api_instance.system_warnings_get(warning_type=warning_type,
                                                    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 SystemApi->system_warnings_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
warning_type	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]

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]