swagger_client.AvailabilityApi

July 10, 2024 ยท View on GitHub

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

MethodHTTP requestDescription
generation_availability_summary14_d_getGET /generation/availability/summary/14DFourteen-day generation forecast
generation_availability_summary3_yw_getGET /generation/availability/summary/3YWThree-year generation forecast

generation_availability_summary14_d_get

generation_availability_summary14_d_get(format=format)

Fourteen-day generation forecast

This endpoint has been moved to forecast/availability/summary/14D.

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.AvailabilityApi()
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Fourteen-day generation forecast
    api_instance.generation_availability_summary14_d_get(format=format)
except ApiException as e:
    print("Exception when calling AvailabilityApi->generation_availability_summary14_d_get: %s\n" % e)

Parameters

NameTypeDescriptionNotes
formatstrResponse data format. Use json/xml to include metadata.[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

generation_availability_summary3_yw_get

generation_availability_summary3_yw_get(format=format)

Three-year generation forecast

This endpoint has been moved to forecast/availability/summary/3YW.

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.AvailabilityApi()
format = 'format_example'  # str | Response data format. Use json/xml to include metadata. (optional)

try:
    # Three-year generation forecast
    api_instance.generation_availability_summary3_yw_get(format=format)
except ApiException as e:
    print("Exception when calling AvailabilityApi->generation_availability_summary3_yw_get: %s\n" % e)

Parameters

NameTypeDescriptionNotes
formatstrResponse data format. Use json/xml to include metadata.[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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