Market¶
This page provides detailed information about market-related parameter classes.
entsoe.Market ¶
__all__
module-attribute
¶
__all__ = [
"ContinuousAllocationsOfferedCapacity",
"EnergyPrices",
"ExplicitAllocationsAuctionRevenue",
"ExplicitAllocationsOfferedCapacity",
"ExplicitAllocationsUseTransferCapacity",
"FlowBasedAllocations",
"FlowBasedAllocationsArchives",
"ImplicitAllocationsOfferedCapacity",
"ImplicitAuctionNetPositions",
"ImplicitFlowBasedAllocationsCongestionIncome",
"TotalCapacityAllocated",
"TotalNominatedCapacity",
"TransferCapacitiesThirdCountriesExplicit",
]
ContinuousAllocationsOfferedCapacity ¶
ContinuousAllocationsOfferedCapacity(
period_start: int,
period_end: int,
in_domain: str,
out_domain: str,
document_type: Literal["A31", "B33"],
contract_market_agreement_type: Literal["A07"] = "A07",
business_type: Optional[str] = None,
update_date_and_or_time: Optional[str] = None,
offset: int = 0,
)
Bases: Market
Parameters for 11.1 Continuous Allocations - Offered Transfer Capacity.
Data view: https://transparency.entsoe.eu/transmission-domain/r2/implicitAllocationsIntraday/show https://transparency.entsoe.eu/transmission-domain/r2/implicitAllocationsDayAhead/show
Fixed parameters:
- auction_Type: A08 (Continuous)
Required parameters: - document_type: A31=Agreed capacity (intermediate OC values), B33=Published offered capacity (most recent published OC values)
Notes: - A31 provides intermediate OC values - B33 provides most recent published OC values
Initialize continuous allocations offered transfer capacity parameters.
Parameters:
-
period_start(int) –Start period (YYYYMMDDHHMM format)
-
period_end(int) –End period (YYYYMMDDHHMM format)
-
in_domain(str) –EIC code of Control Area, Bidding Zone or Aggregation
-
out_domain(str) –EIC code of Control Area, Bidding Zone or Aggregation
-
document_type(Literal['A31', 'B33']) –A31=Agreed capacity (intermediate), B33=Published offered capacity
-
contract_market_agreement_type(Literal['A07'], default:'A07') –A07=Intraday (Continuous)
-
business_type(Optional[str], default:None) –Business type (e.g., A31)
-
update_date_and_or_time(Optional[str], default:None) –Update date and time filter
-
offset(int, default:0) –Offset for pagination
EnergyPrices ¶
EnergyPrices(
period_start: int,
period_end: int,
in_domain: str,
out_domain: str,
contract_market_agreement_type: Optional[Literal["A01", "A07"]] = None,
classification_sequence_position: Optional[int] = None,
offset: int = 0,
)
Bases: Market
Parameters for 12.1.D Energy Prices.
Data view: https://transparency.entsoe.eu/market/prices/show
Fixed parameters:
- documentType: A44 (Price Document)
Request Limits: - One year range limit applies
Response Limits: - 100 documents (TimeSeries) - Offset parameter can be used - Minimum time interval ranges from part of day to 29 hours
Initialize energy prices parameters.
Parameters:
-
period_start(int) –Start period (YYYYMMDDHHMM format)
-
period_end(int) –End period (YYYYMMDDHHMM format)
-
in_domain(str) –EIC code of a Bidding Zone
-
out_domain(str) –EIC code of a Bidding Zone (must be same as in_domain)
-
contract_market_agreement_type(Optional[Literal['A01', 'A07']], default:None) –A01=Day-ahead; A07=Intraday
-
classification_sequence_position(Optional[int], default:None) –Integer for classification
-
offset(int, default:0) –Offset for pagination (max 4800, allows max 4900 documents)
ExplicitAllocationsAuctionRevenue ¶
ExplicitAllocationsAuctionRevenue(
period_start: int,
period_end: int,
in_domain: str,
out_domain: str,
contract_market_agreement_type: Literal[
"A01", "A02", "A03", "A04", "A06", "A07", "A08"
] = "A01",
)
Bases: Market
Parameters for 12.1.A Explicit Allocations - Auction Revenue.
Data view: https://transparency.entsoe.eu/transmission-domain/r2/explicitAllocationsRevenue/show
Fixed parameters:
- documentType: A25 (Allocation result document)
- businessType: B07 (Auction Revenue)
Initialize explicit allocations auction revenue parameters.
Parameters:
-
period_start(int) –Start period (YYYYMMDDHHMM format)
-
period_end(int) –End period (YYYYMMDDHHMM format)
-
in_domain(str) –EIC code of a Control Area, Bidding Zone or Bidding Zone Aggregation
-
out_domain(str) –EIC code of a Control Area, Bidding Zone or Bidding Zone Aggregation
-
contract_market_agreement_type(Literal['A01', 'A02', 'A03', 'A04', 'A06', 'A07', 'A08'], default:'A01') –A01=Daily; A02=Weekly; A03=Monthly; A04=Yearly; A06=Long Term; A07=Intraday; A08=Quarterly
ExplicitAllocationsOfferedCapacity ¶
ExplicitAllocationsOfferedCapacity(
period_start: int,
period_end: int,
in_domain: str,
out_domain: str,
contract_market_agreement_type: Literal["A01", "A07"] = "A01",
auction_category: Optional[str] = None,
classification_sequence_position: Optional[int] = None,
)
Bases: Market
Parameters for 11.1.A Explicit Allocations - Offered Transfer Capacity.
Data view: https://transparency.entsoe.eu/transmission/r2/explicitAllocationsIntraday/show
Fixed parameters:
- documentType: A31 (Agreed capacity)
- auction_Type: A02 (Explicit)
Initialize explicit allocations offered transfer capacity parameters.
Parameters:
-
period_start(int) –Start period (YYYYMMDDHHMM format)
-
period_end(int) –End period (YYYYMMDDHHMM format)
-
in_domain(str) –EIC code of Control Area, Bidding Zone or Aggregation
-
out_domain(str) –EIC code of Control Area, Bidding Zone or Aggregation
-
contract_market_agreement_type(Literal['A01', 'A07'], default:'A01') –A01=Day ahead; A07=Intraday
-
auction_category(Optional[str], default:None) –Auction category (e.g., A04)
-
classification_sequence_position(Optional[int], default:None) –Integer for classification
ExplicitAllocationsUseTransferCapacity ¶
ExplicitAllocationsUseTransferCapacity(
period_start: int,
period_end: int,
in_domain: str,
out_domain: str,
contract_market_agreement_type: Literal[
"A01", "A02", "A03", "A04", "A06", "A07", "A08"
],
business_type: Literal["A43", "B05"],
auction_category: Optional[str] = None,
classification_sequence_position: Optional[int] = None,
)
Bases: Market
Parameters for 12.1.A Explicit Allocations - Use of the Transfer Capacity.
Data view: https://transparency.entsoe.eu/transmission/r2/explicitAllocationsIntraday/show
Fixed parameters:
- documentType: A25 (Allocation result document)
Required parameters: - businessType: A43=Requested capacity (without price), B05=Capacity allocated (including price)
Initialize explicit allocations use of transfer capacity parameters.
Parameters:
-
period_start(int) –Start period (YYYYMMDDHHMM format)
-
period_end(int) –End period (YYYYMMDDHHMM format)
-
in_domain(str) –EIC code of a Control Area, Bidding Zone or Bidding Zone Aggregation
-
out_domain(str) –EIC code of a Control Area, Bidding Zone or Bidding Zone Aggregation
-
contract_market_agreement_type(Literal['A01', 'A02', 'A03', 'A04', 'A06', 'A07', 'A08']) –A01=Day ahead; A02=Weekly; A03=Monthly; A04=Yearly; A06=Long Term; A07=Intraday; A08=Quarterly
-
business_type(Literal['A43', 'B05']) –A43=Requested capacity (without price), B05=Capacity allocated (including price)
-
auction_category(Optional[str], default:None) –Auction category (e.g., A04=Hourly)
-
classification_sequence_position(Optional[int], default:None) –Integer for classification
FlowBasedAllocations ¶
FlowBasedAllocations(
period_start: int,
period_end: int,
in_domain: str,
out_domain: str,
process_type: str,
)
Bases: Market
Parameters for 11.1.B Flow Based Allocations.
Data view: https://transparency.entsoe.eu/transmission/r2/flowBasedAllocationsDayAhead/show
Fixed parameters:
- documentType: B09 (Flow based domain publication)
Request Limits: - One year range limit applies - Minimum time interval in query response is one MTU period
Initialize flow based allocations parameters.
Parameters:
-
period_start(int) –Start period (YYYYMMDDHHMM format)
-
period_end(int) –End period (YYYYMMDDHHMM format)
-
in_domain(str) –EIC code of a Region
-
out_domain(str) –EIC code of a Region
-
process_type(str) –Process type (A43=Day ahead, A44=Intraday, A32=Month-ahead, A33=Year-ahead)
FlowBasedAllocationsArchives ¶
FlowBasedAllocationsArchives(
period_start: int,
period_end: int,
in_domain: str,
out_domain: str,
process_type: str,
)
Bases: Market
Parameters for 11.1.B Flow Based Allocations Archives.
Data view: https://transparency.entsoe.eu/transmission/r2/flowBasedAllocationsDayAhead/show
Fixed parameters:
- documentType: B09 (Flow based domain publication)
- StorageType: archive
Request Limits: - One year range limit applies - Minimum time interval in query response is one MTU period
Initialize flow based allocations archives parameters.
Parameters:
-
period_start(int) –Start period (YYYYMMDDHHMM format)
-
period_end(int) –End period (YYYYMMDDHHMM format)
-
in_domain(str) –EIC code of a Region
-
out_domain(str) –EIC code of a Region
-
process_type(str) –Process type (A43=Day ahead, A44=Intraday, A32=Month-ahead, A33=Year-ahead)
ImplicitAllocationsOfferedCapacity ¶
ImplicitAllocationsOfferedCapacity(
period_start: int,
period_end: int,
in_domain: str,
out_domain: str,
contract_market_agreement_type: Literal["A01", "A07"] = "A01",
update_date_and_or_time: Optional[str] = None,
classification_sequence_position: Optional[int] = None,
)
Bases: Market
Parameters for 11.1 Implicit Allocations - Offered Transfer Capacity.
Data view: https://transparency.entsoe.eu/transmission-domain/r2/implicitAllocationsIntraday/show https://transparency.entsoe.eu/transmission-domain/r2/implicitAllocationsDayAhead/show
Fixed parameters:
- documentType: A31 (Agreed capacity)
- auction_Type: A01 (Implicit)
Initialize implicit allocations offered transfer capacity parameters.
Parameters:
-
period_start(int) –Start period (YYYYMMDDHHMM format)
-
period_end(int) –End period (YYYYMMDDHHMM format)
-
in_domain(str) –EIC code of Control Area, Bidding Zone or Aggregation
-
out_domain(str) –EIC code of Control Area, Bidding Zone or Aggregation
-
contract_market_agreement_type(Literal['A01', 'A07'], default:'A01') –A01=Day ahead; A07=Intraday
-
update_date_and_or_time(Optional[str], default:None) –For Offered Capacity Evolution
-
classification_sequence_position(Optional[int], default:None) –Integer for classification
ImplicitAuctionNetPositions ¶
ImplicitAuctionNetPositions(
period_start: int,
period_end: int,
in_domain: str,
out_domain: str,
contract_market_agreement_type: Literal["A01", "A05", "A07"] = "A07",
)
Bases: Market
Parameters for 12.1.E Implicit Auction — Net Positions.
Fixed parameters:
- documentType: A25 (Allocation results)
- businessType: B09 (Net position)
Initialize implicit auction net positions parameters.
Parameters:
-
period_start(int) –Start period (YYYYMMDDHHMM format)
-
period_end(int) –End period (YYYYMMDDHHMM format)
-
in_domain(str) –EIC code of a Bidding Zone or Control Area
-
out_domain(str) –EIC code of a Bidding Zone or Control Area (must be same as in_domain)
-
contract_market_agreement_type(Literal['A01', 'A05', 'A07'], default:'A07') –A01=Daily; A05=Total; A07=Intraday
ImplicitFlowBasedAllocationsCongestionIncome ¶
ImplicitFlowBasedAllocationsCongestionIncome(
period_start: int,
period_end: int,
in_domain: str,
out_domain: str,
contract_market_agreement_type: Literal["A01", "A07"] = "A01",
)
Bases: Market
Parameters for 12.1.E Implicit and Flow-based Allocations - Congestion Income.
Data view: https://transparency.entsoe.eu/transmission/r2/intradayImplicitAllocationsCongestionIncome/show https://transparency.entsoe.eu/transmission/r2/dailyFlowBasedImplicitAllocationsCongestionIncome/show
Fixed parameters:
- documentType: A25 (Allocation results)
- businessType: B10 (Congestion income)
Initialize congestion income parameters.
Parameters:
-
period_start(int) –Start period (YYYYMMDDHHMM format)
-
period_end(int) –End period (YYYYMMDDHHMM format)
-
in_domain(str) –EIC code of a Border or Bidding Zone
-
out_domain(str) –EIC code of a Border or Bidding Zone
-
contract_market_agreement_type(Literal['A01', 'A07'], default:'A01') –A01=Daily; A07=Intraday
TotalCapacityAllocated ¶
TotalCapacityAllocated(
period_start: int,
period_end: int,
in_domain: str,
out_domain: str,
contract_market_agreement_type: Literal[
"A01", "A02", "A03", "A04", "A06", "A07", "A08"
],
auction_category: Optional[Literal["A01", "A02", "A03", "A04"]] = None,
)
Bases: Market
Parameters for 12.1.C Total Capacity Already Allocated.
Data view: https://transparency.entsoe.eu/transmission/r2/totalCapacityAllocated/show
Fixed parameters:
- documentType: A26 (Capacity document)
- businessType: A29 (Already Allocated Capacity)
Required parameters: - contract_market_agreement_type: A01=Daily, A02=Weekly, A03=Monthly, A04=Yearly, A06=Long Term, A07=Intraday, A08=Quarterly
Optional parameters: - auction_category: A01=Base, A02=Peak, A03=Off Peak, A04=Hourly
Initialize total capacity already allocated parameters.
Parameters:
-
period_start(int) –Start period (YYYYMMDDHHMM format)
-
period_end(int) –End period (YYYYMMDDHHMM format)
-
in_domain(str) –EIC code of a Control Area, Bidding Zone or Bidding Zone Aggregation
-
out_domain(str) –EIC code of a Control Area, Bidding Zone or Bidding Zone Aggregation
-
contract_market_agreement_type(Literal['A01', 'A02', 'A03', 'A04', 'A06', 'A07', 'A08']) –A01=Daily, A02=Weekly, A03=Monthly, A04=Yearly, A06=Long Term, A07=Intraday, A08=Quarterly
-
auction_category(Optional[Literal['A01', 'A02', 'A03', 'A04']], default:None) –A01=Base, A02=Peak, A03=Off Peak, A04=Hourly (optional)
TotalNominatedCapacity ¶
Bases: Market
Parameters for 12.1.B Total Nominated Capacity.
Data view: https://transparency.entsoe.eu/transmission-domain/r2/totalCapacityNominated/show
Fixed parameters:
- documentType: A26 (Capacity document)
- businessType: B08 (Total nominated capacity)
Initialize total nominated capacity parameters.
Parameters:
-
period_start(int) –Start period (YYYYMMDDHHMM format)
-
period_end(int) –End period (YYYYMMDDHHMM format)
-
in_domain(str) –EIC code of a Control Area or Bidding Zone
-
out_domain(str) –EIC code of a Control Area or Bidding Zone
TransferCapacitiesThirdCountriesExplicit ¶
TransferCapacitiesThirdCountriesExplicit(
period_start: int,
period_end: int,
in_domain: str,
out_domain: str,
contract_market_agreement_type: Literal[
"A01", "A02", "A03", "A04", "A06", "A07", "A08"
] = "A07",
auction_category: Optional[str] = None,
classification_sequence_position: Optional[int] = None,
)
Bases: Market
Parameters for 12.1.H Transfer Capacities Allocated with Third Countries.
Data view: https://transparency.entsoe.eu/transmission/r2/transCapAllocThirdCountries/show
Fixed parameters:
- documentType: A94 (Non EU allocations)
- auction_Type: A02 (Explicit)
Initialize transfer capacities allocated with third countries parameters.
Parameters:
-
period_start(int) –Start period (YYYYMMDDHHMM format)
-
period_end(int) –End period (YYYYMMDDHHMM format)
-
in_domain(str) –EIC code of a Control Area, Bidding Zone, Bidding Zone Aggregation
-
out_domain(str) –EIC code of a Control Area, Bidding Zone, Bidding Zone Aggregation
-
contract_market_agreement_type(Literal['A01', 'A02', 'A03', 'A04', 'A06', 'A07', 'A08'], default:'A07') –A01=Daily; A02=Weekly; A03=Monthly; A04=Yearly; A06=Long Term; A07=Intraday; A08=Quarterly
-
auction_category(Optional[str], default:None) –Auction category (e.g., A04=Hourly)
-
classification_sequence_position(Optional[int], default:None) –Integer for classification