pywind.elexon
¶
Warning
Use of the Elexon API requires registration and use of an API key. Registration is free.
Details of the Elexon API can be found in https://www.elexon.co.uk/wp-content/uploads/2016/10/Application-Programming-Interfaces-API-and-Data-Push-user-guide.pdf
pywind.elexon.api
¶
Information taken from the Elexon API User Guide.
-
class
pywind.elexon.api.
B1320
(apikey)[source]¶ Bases:
pywind.elexon.api.ElexonAPI
-
XML_MAPPING
= ['timeSeriesID', 'settlementDate', 'settlementPeriod', 'quantity', 'flowDirection', 'reasonCode', 'documentType', 'processType', 'resolution', 'curveType', 'activeFlag', 'documentID', 'documentRevNum']¶
-
-
class
pywind.elexon.api.
B1330
(apikey)[source]¶ Bases:
pywind.elexon.api.ElexonAPI
-
XML_MAPPING
= ['timeSeriesID', 'year', 'month', 'congestionAmount', 'documentType', 'processType', 'businessType', 'resolution', 'activeFlag', 'documentID', 'documentRevNum']¶
-
-
class
pywind.elexon.api.
B1420
(apikey)[source]¶ Bases:
pywind.elexon.api.ElexonAPI
-
XML_MAPPING
= ['documentType', 'businessType', 'processType', 'timeSeriesID', 'powerSystemResourceType', 'year', 'bMUnitID', 'registeredResourceEICCode', 'nominal', 'nGCBMUnitID', 'registeredResourceName', 'activeFlag', 'documentID', 'implementationDate', 'powerSystemResourceType']¶
-
-
class
pywind.elexon.api.
B1610
(apikey)[source]¶ Bases:
pywind.elexon.api.ElexonAPI
-
class
pywind.elexon.api.
B1630
(apikey)[source]¶ Bases:
pywind.elexon.api.ElexonAPI
-
XML_MAPPING
= ['documentType', 'businessType', 'processType', 'timeSeriesID', 'quantity', 'curveType', 'resolution', 'settlementDate', 'settlementPeriod', 'PSRType', 'powerSystemResourceType', 'registeredResourceEICCode', 'marketGenerationUnitEICCode', 'activeFlag', 'documentID', 'documentRevNum']¶
-
-
class
pywind.elexon.api.
BMUNITSEARCH
(apikey=None)[source]¶ Bases:
pywind.elexon.api.ElexonAPI
Balancing Mechanism Unit Search
-
CATEGORIES
= {'C': 'Additional Supplier', '2': 'Supplier', 'E': 'Embedded', 'T': 'Directly connected', 'G': 'Unknown', 'I': 'Interconnector', 'M': 'Miscellaneous', 'S': 'Unknown'}¶
-
XML_MAPPING
= ['recordType', 'bmUnitID', 'bmUnitType', 'leadPartyName', 'ngcBMUnitName', 'activeFlag']¶
-
-
class
pywind.elexon.api.
DERBMDATA
(apikey=None)[source]¶ Bases:
pywind.elexon.api.ElexonAPI
Derived Balancing Mechanism Data
-
MULTI_RESULTS
= (('bav', '/response/responseBody/bav/responseList/item'), ('oav', '/response/responseBody/oav/responseList/item'), ('ipbav', '/response/responseBody/ipbav/responseList/item'), ('ipoav', '/response/responseBody/ipoav/responseList/item'), ('ipbc', '/response/responseBody/ipbc/responseList/item'), ('ipoc', '/response/responseBody/ipoc/responseList/item'))¶
-
-
class
pywind.elexon.api.
DERSYSDATA
(apikey=None)[source]¶ Bases:
pywind.elexon.api.ElexonAPI
Derived System Data
-
class
pywind.elexon.api.
ElexonAPI
(apikey=None, report=None)[source]¶ Bases:
object
-
MULTI_RESULTS
= None¶
-
XML_MAPPING
= None¶
-
-
class
pywind.elexon.api.
FUELINST
(apikey=None)[source]¶ Bases:
pywind.elexon.api.ElexonAPI
Instant Generation by Fuel Type
-
XML_MAPPING
= ['recordType', 'startTimeOfHalfHrPeriod', 'settlementPeriod', 'publishingPeriodCommencingTime', 'ccgt', 'oil', 'coal', 'nuclear', 'wind', 'ps', 'npshyd', 'ocgt', 'other', 'intfr', 'intirl', 'intned', 'intew', 'activeFlag']¶
-
pywind.elexon.unit
¶
-
class
pywind.elexon.unit.
BalancingData
(api_key)[source]¶ Bases:
object
Parent class to hold data from the :mod:DERBMDATA API.