Outages¶
This page provides detailed information about outages-related parameter classes.
entsoe.Outages ¶
ENTSO-E Outages parameter classes.
This module contains parameter classes for ENTSO-E Outages endpoints, providing easy-to-use interfaces for different outage data types based on the ENTSO-E Transparency Platform API specification.
AggregatedUnavailabilityOfConsumptionUnits ¶
AggregatedUnavailabilityOfConsumptionUnits(
bidding_zone_domain: str,
period_start: Optional[int] = None,
period_end: Optional[int] = None,
period_start_update: Optional[int] = None,
period_end_update: Optional[int] = None,
business_type: Optional[str] = None,
offset: int = 0,
)
Bases: Outages
Parameters for 7.1.A-B Aggregated Unavailability of Consumption Units.
Data view: https://transparency.entsoe.eu/outage-domain/r2/unavailabilityInTransmissionGrid/show
Fixed parameters:
- documentType: A76 (Load unavailability)
Notes: - Returns aggregated unavailability data for consumption units - Can be filtered by business type (A53=Planned maintenance, A54=Forced unavailability) - Period parameters are optional if PeriodStartUpdate/PeriodEndUpdate are defined
Initialize aggregated unavailability of consumption units parameters.
Parameters:
-
bidding_zone_domain
(str
) –EIC code of Control Area or Bidding Zone
-
period_start
(Optional[int]
, default:None
) –Start period (YYYYMMDDHHMM format, optional if period_start_update defined)
-
period_end
(Optional[int]
, default:None
) –End period (YYYYMMDDHHMM format, optional if period_end_update defined)
-
period_start_update
(Optional[int]
, default:None
) –Start of update period (YYYYMMDDHHMM format)
-
period_end_update
(Optional[int]
, default:None
) –End of update period (YYYYMMDDHHMM format)
-
business_type
(Optional[str]
, default:None
) –Business type (A53=Planned maintenance, A54=Forced unavailability)
-
offset
(int
, default:0
) –Offset for pagination
Fallbacks ¶
Fallbacks(
process_type: str,
business_type: str,
bidding_zone_domain: str,
period_start: Optional[int] = None,
period_end: Optional[int] = None,
period_start_update: Optional[int] = None,
period_end_update: Optional[int] = None,
doc_status: Optional[str] = None,
m_rid: Optional[str] = None,
offset: int = 0,
)
Bases: Outages
Parameters for Fall-backs [IFs IN 7.2, mFRR 3.11, aFRR 3.10].
Data view: https://transparency.entsoe.eu/outage-domain/r2/unavailabilityInTransmissionGrid/show
Fixed parameters:
- documentType: A53 (Outage publication document)
Required parameters: - processType: A47 (Manual frequency restoration reserve), A51 (Automatic frequency restoration reserve), A63 (Imbalance Netting) - businessType: C47 (Disconnection), A53 (Planned maintenance), A54 (Unplanned outage), A83 (Auction cancellation)
Notes: - Returns fall-back data for frequency restoration reserves and imbalance netting - Both processType and businessType are mandatory for this endpoint - Period parameters are optional if PeriodStartUpdate/PeriodEndUpdate are defined
Initialize fall-backs parameters.
Parameters:
-
process_type
(str
) –Process type (A47=Manual frequency restoration reserve, A51=Automatic frequency restoration reserve, A63=Imbalance Netting)
-
business_type
(str
) –Business type (C47=Disconnection, A53=Planned maintenance, A54=Unplanned outage, A83=Auction cancellation)
-
bidding_zone_domain
(str
) –EIC code of a CTA/LFA/REG
-
period_start
(Optional[int]
, default:None
) –Start period (YYYYMMDDHHMM format, optional if period_start_update defined)
-
period_end
(Optional[int]
, default:None
) –End period (YYYYMMDDHHMM format, optional if period_end_update defined)
-
period_start_update
(Optional[int]
, default:None
) –Start of update period (YYYYMMDDHHMM format)
-
period_end_update
(Optional[int]
, default:None
) –End of update period (YYYYMMDDHHMM format)
-
doc_status
(Optional[str]
, default:None
) –Document status (A13=Withdrawn, by default withdrawn publications not returned)
-
m_rid
(Optional[str]
, default:None
) –Message ID for specific publication versions
-
offset
(int
, default:0
) –Offset for pagination
UnavailabilityOfGenerationUnits ¶
UnavailabilityOfGenerationUnits(
bidding_zone_domain: str,
period_start: Optional[int] = None,
period_end: Optional[int] = None,
period_start_update: Optional[int] = None,
period_end_update: Optional[int] = None,
business_type: Optional[str] = None,
doc_status: Optional[str] = None,
registered_resource: Optional[str] = None,
m_rid: Optional[str] = None,
offset: int = 0,
)
Bases: Outages
Parameters for 15.1.A&B Unavailability of Generation Units.
Data view: https://transparency.entsoe.eu/outage-domain/r2/unavailabilityInTransmissionGrid/show
Fixed parameters:
- documentType: A80 (Generation unavailability)
Notes: - Returns generation unit unavailability data - Can be filtered by business type (A53=Planned maintenance, A54=Forced unavailability) - Supports update-based queries with PeriodStartUpdate/PeriodEndUpdate
Initialize unavailability of generation units parameters.
Parameters:
-
bidding_zone_domain
(str
) –EIC code of Control Area, Bidding Zone
-
period_start
(Optional[int]
, default:None
) –Start period (YYYYMMDDHHMM format)
-
period_end
(Optional[int]
, default:None
) –End period (YYYYMMDDHHMM format)
-
period_start_update
(Optional[int]
, default:None
) –Start of update period (YYYYMMDDHHMM format)
-
period_end_update
(Optional[int]
, default:None
) –End of update period (YYYYMMDDHHMM format)
-
business_type
(Optional[str]
, default:None
) –Business type (A53=Planned maintenance, A54=Forced unavailability)
-
doc_status
(Optional[str]
, default:None
) –Document status (A05=Active, A09=Cancelled, A13=Withdrawn)
-
registered_resource
(Optional[str]
, default:None
) –EIC Code of Generation Unit
-
m_rid
(Optional[str]
, default:None
) –Message ID for specific outage versions
-
offset
(int
, default:0
) –Offset for pagination
UnavailabilityOfOffshoreGridInfrastructure ¶
UnavailabilityOfOffshoreGridInfrastructure(
bidding_zone_domain: str,
period_start: Optional[int] = None,
period_end: Optional[int] = None,
period_start_update: Optional[int] = None,
period_end_update: Optional[int] = None,
doc_status: Optional[str] = None,
m_rid: Optional[str] = None,
offset: int = 0,
)
Bases: Outages
Parameters for 10.1.C Unavailability of Offshore Grid Infrastructure.
Data view: https://transparency.entsoe.eu/outage-domain/r2/unavailabilityInTransmissionGrid/show
Fixed parameters:
- documentType: A79 (Offshore grid infrastructure unavailability)
Notes: - Returns offshore grid infrastructure unavailability data - Period parameters are optional if PeriodStartUpdate/PeriodEndUpdate are defined - No BusinessType parameter available for this endpoint
Initialize unavailability of offshore grid infrastructure parameters.
Parameters:
-
bidding_zone_domain
(str
) –EIC code of Control Area, Bidding Zone
-
period_start
(Optional[int]
, default:None
) –Start period (YYYYMMDDHHMM format, optional if period_start_update defined)
-
period_end
(Optional[int]
, default:None
) –End period (YYYYMMDDHHMM format, optional if period_end_update defined)
-
period_start_update
(Optional[int]
, default:None
) –Start of update period (YYYYMMDDHHMM format, mandatory if period_start/end not defined)
-
period_end_update
(Optional[int]
, default:None
) –End of update period (YYYYMMDDHHMM format, mandatory if period_start/end not defined)
-
doc_status
(Optional[str]
, default:None
) –Document status (A05=Active, A09=Cancelled, A13=Withdrawn)
-
m_rid
(Optional[str]
, default:None
) –Message ID for specific outage versions
-
offset
(int
, default:0
) –Offset for pagination
UnavailabilityOfProductionUnits ¶
UnavailabilityOfProductionUnits(
bidding_zone_domain: str,
period_start: Optional[int] = None,
period_end: Optional[int] = None,
period_start_update: Optional[int] = None,
period_end_update: Optional[int] = None,
business_type: Optional[str] = None,
doc_status: Optional[str] = None,
registered_resource: Optional[str] = None,
m_rid: Optional[str] = None,
offset: int = 0,
)
Bases: Outages
Parameters for 15.1.C-D Unavailability of Production Units.
Data view: https://transparency.entsoe.eu/outage-domain/r2/unavailabilityInTransmissionGrid/show
Fixed parameters:
- documentType: A77 (Production unit unavailability)
Notes: - Returns production unit unavailability data - Can be filtered by business type (A53=Planned maintenance, A54=Forced unavailability) - Supports update-based queries with PeriodStartUpdate/PeriodEndUpdate
Initialize unavailability of production units parameters.
Parameters:
-
bidding_zone_domain
(str
) –EIC code of Control Area, Bidding Zone
-
period_start
(Optional[int]
, default:None
) –Start period (YYYYMMDDHHMM format)
-
period_end
(Optional[int]
, default:None
) –End period (YYYYMMDDHHMM format)
-
period_start_update
(Optional[int]
, default:None
) –Start of update period (YYYYMMDDHHMM format)
-
period_end_update
(Optional[int]
, default:None
) –End of update period (YYYYMMDDHHMM format)
-
business_type
(Optional[str]
, default:None
) –Business type (A53=Planned maintenance, A54=Forced unavailability)
-
doc_status
(Optional[str]
, default:None
) –Document status (A05=Active, A09=Cancelled, A13=Withdrawn)
-
registered_resource
(Optional[str]
, default:None
) –EIC Code of Production Unit
-
m_rid
(Optional[str]
, default:None
) –Message ID for specific outage versions
-
offset
(int
, default:0
) –Offset for pagination
UnavailabilityOfTransmissionInfrastructure ¶
UnavailabilityOfTransmissionInfrastructure(
out_domain: str,
in_domain: str,
period_start: Optional[int] = None,
period_end: Optional[int] = None,
period_start_update: Optional[int] = None,
period_end_update: Optional[int] = None,
time_interval_update: Optional[str] = None,
business_type: Optional[str] = None,
doc_status: Optional[str] = None,
m_rid: Optional[str] = None,
offset: int = 0,
)
Bases: Outages
Parameters for 10.1.A&B Unavailability of Transmission Infrastructure.
Data view: https://transparency.entsoe.eu/outage-domain/r2/unavailabilityInTransmissionGrid/show
Fixed parameters:
- documentType: A78 (Transmission unavailability)
Notes: - Returns transmission infrastructure unavailability data - Uses Out_Domain and In_Domain instead of BiddingZone_Domain - Supports TimeIntervalUpdate as alternative to PeriodStartUpdate/PeriodEndUpdate - Can be filtered by business type (A53=Planned maintenance, A54=Forced unavailability)
Initialize unavailability of transmission infrastructure parameters.
Parameters:
-
out_domain
(str
) –EIC code of Control Area or Bidding Zone (output domain)
-
in_domain
(str
) –EIC code of Control Area or Bidding Zone (input domain)
-
period_start
(Optional[int]
, default:None
) –Start period (YYYYMMDDHHMM format)
-
period_end
(Optional[int]
, default:None
) –End period (YYYYMMDDHHMM format)
-
period_start_update
(Optional[int]
, default:None
) –Start of update period (YYYYMMDDHHMM format)
-
period_end_update
(Optional[int]
, default:None
) –End of update period (YYYYMMDDHHMM format)
-
time_interval_update
(Optional[str]
, default:None
) –Can be used instead of PeriodStartUpdate & PeriodEndUpdate
-
business_type
(Optional[str]
, default:None
) –Business type (A53=Planned maintenance, A54=Forced unavailability)
-
doc_status
(Optional[str]
, default:None
) –Document status (A05=Active, A09=Cancelled, A13=Withdrawn)
-
m_rid
(Optional[str]
, default:None
) –Message ID for specific outage versions
-
offset
(int
, default:0
) –Offset for pagination