Skip to content

Commit 8ae38bf

Browse files
authored
Merge pull request #138 from BerriJ/automated-postman-update
Update Postman Documentation
2 parents 64b66dd + 5d45848 commit 8ae38bf

7 files changed

Lines changed: 118 additions & 10 deletions

File tree

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
{
2+
"name": "IFs mFRR 9.9, aFRR 9.6&9.8 Changes to Bid Availability Archives",
3+
"method": "GET",
4+
"query": [
5+
{
6+
"key": "documentType",
7+
"value": "B45",
8+
"description": "[M] B45 = Bid Availability Document"
9+
},
10+
{
11+
"key": "processType",
12+
"value": "A47",
13+
"description": "[M] A47"
14+
},
15+
{
16+
"key": "Domain",
17+
"value": "10YDE-VE-------2",
18+
"description": "[M] EIC code of a Scheduling Area or LFA"
19+
},
20+
{
21+
"key": "periodStart",
22+
"value": "202309232200",
23+
"description": "[M] Pattern yyyyMMddHHmm e.g. 201601010000"
24+
},
25+
{
26+
"key": "periodEnd",
27+
"value": "202309242200",
28+
"description": "[M] Pattern yyyyMMddHHmm e.g. 201601010000"
29+
},
30+
{
31+
"key": "storageType",
32+
"value": "archive",
33+
"description": "[M] Used to request archives"
34+
},
35+
{
36+
"key": "businessType",
37+
"value": "C46",
38+
"description": "[O] C40 = Conditional bid; C41 = Thermal limit; C42 = Frequency limit; C43 = Voltage limit; C44 = Current limit; C45 = Short-circuit current limits; C46 = Dynamic stability limit",
39+
"disabled": true
40+
},
41+
{
42+
"key": "offset",
43+
"value": "100",
44+
"description": "[O] Integer: Zero‑based index of the first archive to return. The offset parameter paginates the response in batches of 100 archives (e.g., offset = n returns the archives in the range n+1 to n+100).",
45+
"disabled": true
46+
}
47+
]
48+
}

misc/endpoints/Market/11.1 Continuous Allocations - Offered Transfer Capacity.json

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,6 @@
4242
"value": "20240515123900",
4343
"description": "[O] For Offered Capacity Evolution can be quried with datetime in numeric. For example 20210803113900000 for evolution update date time 03.08.2021 13:39:00.000. If there is no OC evolution version with requested update_DateAndOrTime the system selects OC version valid in the given time (e.g., closest previous update_DateAndOrTime). The most recent publish OC version is provided in case the update_DateAndOrTime parameter is omitted. The most recent published OC version and intermediate OC versions is distinguished by document type: − Intermediate OC values: A31 − Most recent published OC values: B33",
4444
"disabled": true
45-
},
46-
{
47-
"key": "offset",
48-
"value": "0",
49-
"description": "[O] Integer: Zero‑based index of the first TimeSeries to return. The offset parameter paginates the response in batches of 100 TimeSeries (e.g., offset = n returns the TimeSeries in the range n+1 to n+100).",
50-
"disabled": true
5145
}
5246
]
5347
}

misc/endpoints/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ To regenerate this list, run:
6666
- [12.3.B&C Balancing energy bids](Balancing/12.3.B%26C%20Balancing%20energy%20bids.json)
6767
- [12.3.B&C Balancing energy bids archives](Balancing/12.3.B%26C%20Balancing%20energy%20bids%20archives.json)
6868
- [IFs mFRR 9.9, aFRR 9.6&9.8 Changes to Bid Availability](Balancing/IFs%20mFRR%209.9%2C%20aFRR%209.6%269.8%20Changes%20to%20Bid%20Availability.json)
69+
- [IFs mFRR 9.9, aFRR 9.6&9.8 Changes to Bid Availability Archives](Balancing/IFs%20mFRR%209.9%2C%20aFRR%209.6%269.8%20Changes%20to%20Bid%20Availability%20Archives.json)
6970
- [12.3.E Aggregated Balancing Energy Bids (GL EB)](Balancing/12.3.E%20Aggregated%20Balancing%20Energy%20Bids%20%28GL%20EB%29.json)
7071
- [IFs 3.10, 3.16 & 3.17 Netted and Exchanged Volumes](Balancing/IFs%203.10%2C%203.16%20%26%203.17%20Netted%20and%20Exchanged%20Volumes.json)
7172
- [IFs 3.10, 3.16 & 3.17 Netted and Exchanged Volumes per Border](Balancing/IFs%203.10%2C%203.16%20%26%203.17%20Netted%20and%20Exchanged%20Volumes%20per%20Border.json)

misc/endpoints/all_endpoints.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@
7777
"12.3.B&C Balancing energy bids",
7878
"12.3.B&C Balancing energy bids archives",
7979
"IFs mFRR 9.9, aFRR 9.6&9.8 Changes to Bid Availability",
80+
"IFs mFRR 9.9, aFRR 9.6&9.8 Changes to Bid Availability Archives",
8081
"12.3.E Aggregated Balancing Energy Bids (GL EB)",
8182
"IFs 3.10, 3.16 & 3.17 Netted and Exchanged Volumes",
8283
"IFs 3.10, 3.16 & 3.17 Netted and Exchanged Volumes per Border",

src/entsoe/Balancing/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
BalancingEnergyBids,
1313
BalancingEnergyBidsArchives,
1414
ChangesToBidAvailability,
15+
ChangesToBidAvailabilityArchives,
1516
CrossBorderMarginalPricesForAFRR,
1617
CurrentBalancingState,
1718
ElasticDemands,
@@ -43,6 +44,7 @@
4344
"BalancingEnergyBidsArchives",
4445
"BalancingEnergyBids",
4546
"ChangesToBidAvailability",
47+
"ChangesToBidAvailabilityArchives",
4648
"CrossBorderMarginalPricesForAFRR",
4749
"CurrentBalancingState",
4850
"ElasticDemands",

src/entsoe/Balancing/specific_params.py

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1183,6 +1183,68 @@ def __init__(
11831183
)
11841184

11851185

1186+
class ChangesToBidAvailabilityArchives(Balancing):
1187+
"""Parameters for IFs mFRR 9.9, aFRR 9.6&9.8 Changes to Bid Availability Archives.
1188+
1189+
Data view:
1190+
https://transparency.entsoe.eu/balancing/r2/changesToBidAvailability/show
1191+
1192+
Fixed parameters:
1193+
1194+
- documentType: B45 (Bid Availability Document)
1195+
- processType: A47 (Manual frequency restoration reserve)
1196+
- storageType: archive
1197+
1198+
Optional parameters:
1199+
- businessType: C40=Conditional bid, C41=Thermal limit, C42=Frequency limit,
1200+
C43=Voltage limit, C44=Current limit,
1201+
C45=Short-circuit current limits,
1202+
C46=Dynamic stability limit
1203+
1204+
Notes:
1205+
- This is the archived version of changes to bid availability
1206+
- The offset parameter paginates the response in batches of 100 archives
1207+
"""
1208+
1209+
code = "IF_mFRR_aFRR_9.6_9.8_9.9_Archives"
1210+
1211+
def __init__(
1212+
self,
1213+
period_start: int,
1214+
period_end: int,
1215+
domain: str,
1216+
# Optional balancing-specific parameters
1217+
business_type: Optional[str] = None,
1218+
# Additional common parameters
1219+
offset: int = 0,
1220+
):
1221+
"""
1222+
Initialize changes to bid availability archives parameters.
1223+
1224+
Args:
1225+
period_start: Start period (YYYYMMDDHHMM format)
1226+
period_end: End period (YYYYMMDDHHMM format)
1227+
domain: EIC code of Scheduling Area or LFA
1228+
business_type: C40=Conditional bid, C41=Thermal limit, C42=Frequency limit,
1229+
C43=Voltage limit, C44=Current limit, C45=Short-circuit limit,
1230+
C46=Dynamic stability limit
1231+
offset: Zero-based index of the first archive to return (batches of 100)
1232+
"""
1233+
# Initialize with preset and user parameters
1234+
super().__init__(
1235+
document_type="B45",
1236+
period_start=period_start,
1237+
period_end=period_end,
1238+
domain=domain,
1239+
process_type="A47",
1240+
business_type=business_type,
1241+
offset=offset,
1242+
)
1243+
1244+
# Add the storageType parameter specific to archives endpoint
1245+
self.add_optional_param("storageType", "archive")
1246+
1247+
11861248
class BalancingBorderCapacityLimitations(Balancing):
11871249
"""Parameters for IFs 4.3 & 4.4 Balancing Border Capacity Limitations.
11881250

src/entsoe/utils/utils.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ def format_entsoe_datetime(dt: datetime) -> int:
3131
"""
3232
Format datetime object to ENTSOE datetime format (YYYYMMDDHHMM).
3333
34-
Convert a (tz-aware) datetime to UTC and format it as an integer in the
35-
ENTSOE format. If the datetime is naive, it is assumed to be in UTC.This
36-
function can be used to convert pd.Timestamp and pl.Datetime objects to the
37-
required format for ENTSOE API calls. Please have a look at the
34+
Convert a (tz-aware) datetime to UTC and format it as an integer in the
35+
ENTSOE format. If the datetime is naive, it is assumed to be in UTC.This
36+
function can be used to convert pd.Timestamp and pl.Datetime objects to the
37+
required format for ENTSOE API calls. Please have a look at the
3838
documentation for more details and examples.
3939
4040
Args:

0 commit comments

Comments
 (0)