Get Implicit and Flow-based Allocations — Congestion Income (12.1.E)

Congestion income from implicit and flow-based allocations. For implicit allocations, In_Domain and Out_Domain must be the same border EIC code. For flow-based, both must be the same bidding zone EIC.

Usage

congestion_income(
  eic = NULL,
  period_start = lubridate::ymd(Sys.Date() - lubridate::days(x = 1L), tz = "CET"),
  period_end = lubridate::ymd(Sys.Date(), tz = "CET"),
  contract_type = "A01",
  tidy_output = FALSE,
  security_token = Sys.getenv("ENTSOE_PAT")
)

Arguments

eic: Energy Identification Code of the border or bidding zone
period_start: POSIXct or YYYY-MM-DD HH:MM:SS format One year range limit applies
period_end: POSIXct or YYYY-MM-DD HH:MM:SS format One year range limit applies
contract_type: Contract market agreement type, valid values can be checked from contract_types table; "A01" = Day ahead "A02" = Weekly "A032 = Monthly "A04" = Yearly "A06" = Long Term "A07" = Intraday "A08" = Quarterly Defaults to "A01" (Day ahead)
tidy_output: Defaults to FALSE. If TRUE, then flatten nested tables.
security_token: Security token for ENTSO-E transparency platform

Examples

df <- entsoeapi::congestion_income(
  eic = "10YDOM-1001A083J",
  period_start = lubridate::ymd(x = "2016-01-01", tz = "CET"),
  period_end = lubridate::ymd(x = "2016-01-02", tz = "CET"),
  contract_type = "A01",
  tidy_output = TRUE
)
#> 
#> ── API call ────────────────────────────────────────────────────────────────────────────────────────────────────────────
#> → https://web-api.tp.entsoe.eu/api?documentType=A25&businessType=B10&contract_MarketAgreement.Type=A01&in_Domain=10YDOM-1001A083J&out_Domain=10YDOM-1001A083J&periodStart=201512312300&periodEnd=201601012300&securityToken=<...>
#> <- HTTP/2 200 
#> <- date: Thu, 05 Mar 2026 16:11:52 GMT
#> <- content-type: text/xml
#> <- content-length: 1674
#> <- content-disposition: inline; filename="Implicit_Allocations_Congestion_income_201512312300-201601012300.xml"
#> <- x-content-type-options: nosniff
#> <- x-xss-protection: 0
#> <- strict-transport-security: max-age=15724800; includeSubDomains
#> <- 
#> ✔ response has arrived
#> ℹ No additional definitions added!

str(df)
#> tibble [24 × 22] (S3: tbl_df/tbl/data.frame)
#>  $ ts_in_domain_mrid                    : chr [1:24] "10YDOM-1001A083J" "10YDOM-1001A083J" "10YDOM-1001A083J" "10YDOM-1001A083J" ...
#>  $ ts_in_domain_name                    : chr [1:24] "Border Area Czech Republic Slovakia" "Border Area Czech Republic Slovakia" "Border Area Czech Republic Slovakia" "Border Area Czech Republic Slovakia" ...
#>  $ ts_out_domain_mrid                   : chr [1:24] "10YDOM-1001A083J" "10YDOM-1001A083J" "10YDOM-1001A083J" "10YDOM-1001A083J" ...
#>  $ ts_out_domain_name                   : chr [1:24] "Border Area Czech Republic Slovakia" "Border Area Czech Republic Slovakia" "Border Area Czech Republic Slovakia" "Border Area Czech Republic Slovakia" ...
#>  $ type                                 : chr [1:24] "A25" "A25" "A25" "A25" ...
#>  $ type_def                             : chr [1:24] "Allocation result document" "Allocation result document" "Allocation result document" "Allocation result document" ...
#>  $ ts_contract_market_agreement_type    : chr [1:24] "A01" "A01" "A01" "A01" ...
#>  $ ts_contract_market_agreement_type_def: chr [1:24] "Daily contract" "Daily contract" "Daily contract" "Daily contract" ...
#>  $ ts_auction_type                      : chr [1:24] "A01" "A01" "A01" "A01" ...
#>  $ ts_auction_type_def                  : chr [1:24] "Implicit" "Implicit" "Implicit" "Implicit" ...
#>  $ ts_business_type                     : chr [1:24] "B10" "B10" "B10" "B10" ...
#>  $ ts_business_type_def                 : chr [1:24] "Congestion income" "Congestion income" "Congestion income" "Congestion income" ...
#>  $ created_date_time                    : POSIXct[1:24], format: "2026-03-05 16:11:52" "2026-03-05 16:11:52" "2026-03-05 16:11:52" "2026-03-05 16:11:52" ...
#>  $ revision_number                      : num [1:24] 1 1 1 1 1 1 1 1 1 1 ...
#>  $ ts_resolution                        : chr [1:24] "PT60M" "PT60M" "PT60M" "PT60M" ...
#>  $ ts_time_interval_start               : POSIXct[1:24], format: "2015-12-31 23:00:00" "2015-12-31 23:00:00" "2015-12-31 23:00:00" "2015-12-31 23:00:00" ...
#>  $ ts_time_interval_end                 : POSIXct[1:24], format: "2016-01-01 23:00:00" "2016-01-01 23:00:00" "2016-01-01 23:00:00" "2016-01-01 23:00:00" ...
#>  $ ts_mrid                              : num [1:24] 1 1 1 1 1 1 1 1 1 1 ...
#>  $ ts_point_dt_start                    : POSIXct[1:24], format: "2015-12-31 23:00:00" "2016-01-01 00:00:00" "2016-01-01 01:00:00" "2016-01-01 02:00:00" ...
#>  $ ts_point_price_amount                : num [1:24] 0 0 0 0 0 0 0 0 0 0 ...
#>  $ ts_currency_unit_name                : chr [1:24] "EUR" "EUR" "EUR" "EUR" ...
#>  $ ts_price_measure_unit_name           : chr [1:24] "MWH" "MWH" "MWH" "MWH" ...