The goal of entsoeapi package is to create an easy wrapper for querying the ENTSO-E API's Load, Generation, Transmission, Balancing & Outages data which are available on the ENTSO-E transparency platform website as well.
- Already available ENTSO-E API endpoints:
- BALANCING
- balancing_accepted_aggr_offers (17.1.D)
- balancing_activated_reserves (17.1.E)
- balancing_border_cap_limit (IFs 4.3 & 4.4)
- exchanged_volumes (aFRR 3.16, mFRR 3.17)
- netted_volumes (IFs IN 3.10)
- elastic_demands (IF mFRR 3.4)
- GENERATION
- gen_day_ahead (14.1.C)
- gen_installed_capacity_per_pt (14.1.A)
- the gen_installed_capacity_per_pu (14.1.B)
- gen_per_gen_unit (16.1.A)
- gen_per_prod_type (16.1.B&C)
- gen_wind_solar_forecasts (14.1.D)
- the gen_storage_mean_filling_rate (16.1.D)
- LOAD
- load_actual_total (6.1.A)
- load_day_ahead_total_forecast (6.1.B)
- load_week_ahead_total_forecast (6.1.C)
- load_month_ahead_total_forecast (6.1.D)
- load_year_ahead_total_forecast (6.1.E)
- load_year_ahead_forecast_margin (8.1)
- UNAVAILABILITY
- outages_gen_units (15.1.A&B)
- outages_prod_units (15.1.C&D)
- outages_both (15.1.A&B + 15.1.C&D)
- outages_cons_units (7.1.A&B)
- outages_fallbacks (IFs IN 7.2, mFRR 3.11, aFRR 3.10)
- outages_offshore_grid (10.1.A&B)
- outages_transmission_grid (10.1.A&B)
- TRANSMISSION
- transm_already_allocated_cap (12.1.C)
- transm_day_ahead_comm_sched (12.1.F)
- transm_day_ahead_prices (12.1.D)
- transm_day_ahead_transf_cap (11.1)
- transm_total_comm_sched (12.1.F)
- transm_total_nominated_cap (12.1.B)
- transm_x_border_phys_flow (12.1.G)
- CONGESTION MANAGEMENT
- redispatching_internal (13.1.A)
- redispatching_x_border (13.1.A)
- countertrading (13.1.B)
- costs_of_congestion_management (13.1.C)
- BALANCING
All the function calls convert the xml responses to tabular data. Be aware, that not all endpoints are implemented. If you want to use an unimplemented endpoint, please submit an issue and we'll do our best to resolve it.
IMPORTANT!
Since the underlying engine has fairly been standardized with the introduction of version 0.7.0.0, there are significant (breaking) changes between the 0.7.0.0 and the previous versions.
You can install the development version from GitHub with:
install.packages("devtools")
devtools::install_github("krose/entsoeapi")Read here how to get a security token. You should also create a .Renviron file in your working directory with a security token and call it ENTSOE_PAT.
ENTSOE_PAT = "your_security_token"
You use the eic codes to get the data. Let’s try to find the eic code for Germany.
library(dplyr)
library(lubridate)
library(entsoeapi)
all_approved_eic() |>
filter(EicLongName == "Germany") |>
glimpse()
#> Rows: 1
#> Columns: 11
#> $ EicCode <chr> "10Y1001A1001A83F"
#> $ EicDisplayName <chr> "DE"
#> $ EicLongName <chr> "Germany"
#> $ EicParent <chr> NA
#> $ EicResponsibleParty <chr> NA
#> $ EicStatus <chr> "Active"
#> $ MarketParticipantPostalCode <chr> NA
#> $ MarketParticipantIsoCountryCode <chr> NA
#> $ MarketParticipantVatCode <chr> NA
#> $ EicTypeFunctionList <chr> "Member State"
#> $ type <chr> "Y"For some of the data you need to translate the generation codes.
glimpse(asset_types)
#> Rows: 29
#> Columns: 3
#> $ CODE <chr> "A01", "A02", "A03", "A04", "A05", "B01", "B02", "B0…
#> $ DEFINITION <chr> "Tieline", "Line", "Resource Object", "Generation", …
#> $ DESCRIPTION <chr> "A high voltage line used for cross border energy in…Let’s get the demand in Germany.
load_actual_total(eic = "10Y1001A1001A83F",
period_start = ymd("2020-01-01", tz = "CET"),
period_end = ymd("2020-01-02", tz = "CET")) |>
glimpse()
#> Rows: 96
#> Columns: 21
#> $ ts_out_bidding_zone_domain_mrid <chr> "10Y1001A1001A83F", "10Y1001A1001A83F", "1…
#> $ ts_out_bidding_zone_domain_name <chr> "Germany", "Germany", "Germany", "Germany"…
#> $ type <chr> "A65", "A65", "A65", "A65", "A65", "A65", …
#> $ type_def <chr> "System total load", "System total load", …
#> $ process_type <chr> "A16", "A16", "A16", "A16", "A16", "A16", …
#> $ process_type_def <chr> "Realised", "Realised", "Realised", "Reali…
#> $ ts_object_aggregation <chr> "A01", "A01", "A01", "A01", "A01", "A01", …
#> $ ts_object_aggregation_def <chr> "Area", "Area", "Area", "Area", "Area", "A…
#> $ ts_business_type <chr> "A04", "A04", "A04", "A04", "A04", "A04", …
#> $ ts_business_type_def <chr> "Consumption", "Consumption", "Consumption…
#> $ created_date_time <dttm> 2024-10-05 19:48:09, 2024-10-05 19:48:09,…
#> $ revision_number <dbl> 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, …
#> $ time_period_time_interval_start <dttm> 2019-12-31 23:00:00, 2019-12-31 23:00:00,…
#> $ time_period_time_interval_end <dttm> 2020-01-01 23:00:00, 2020-01-01 23:00:00,…
#> $ ts_resolution <chr> "PT15M", "PT15M", "PT15M", "PT15M", "PT15M…
#> $ ts_time_interval_start <dttm> 2019-12-31 23:00:00, 2019-12-31 23:00:00,…
#> $ ts_time_interval_end <dttm> 2020-01-01 23:00:00, 2020-01-01 23:00:00,…
#> $ ts_mrid <dbl> 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, …
#> $ ts_point_dt_start <dttm> 2019-12-31 23:00:00, 2019-12-31 23:15:00,…
#> $ ts_point_quantity <dbl> 43882, 43640, 43331, 43149, 43017, 42806, …
#> $ ts_quantity_measure_unit_name <chr> "MAW", "MAW", "MAW", "MAW", "MAW", "MAW", …This is basically how all the functions work, so let’s try to get the production data too.
gen_per_prod_type(eic = "10Y1001A1001A83F",
period_start = ymd("2020-01-01", tz = "CET"),
period_end = ymd("2020-01-02", tz = "CET"),
gen_type = NULL,
tidy_output = TRUE) |>
glimpse()
#> Rows: 1,632
#> Columns: 25
#> $ ts_in_bidding_zone_domain_mrid <chr> "10Y1001A1001A83F", "10Y1001A1001A83F", "10Y100…
#> $ ts_in_bidding_zone_domain_name <chr> "Germany", "Germany", "Germany", "Germany", "Ge…
#> $ ts_out_bidding_zone_domain_mrid <chr> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA,…
#> $ ts_out_bidding_zone_domain_name <chr> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA,…
#> $ type <chr> "A75", "A75", "A75", "A75", "A75", "A75", "A75"…
#> $ type_def <chr> "Actual generation per type", "Actual generatio…
#> $ process_type <chr> "A16", "A16", "A16", "A16", "A16", "A16", "A16"…
#> $ process_type_def <chr> "Realised", "Realised", "Realised", "Realised",…
#> $ ts_object_aggregation <chr> "A08", "A08", "A08", "A08", "A08", "A08", "A08"…
#> $ ts_object_aggregation_def <chr> "Resource type", "Resource type", "Resource typ…
#> $ ts_business_type <chr> "A01", "A01", "A01", "A01", "A01", "A01", "A01"…
#> $ ts_business_type_def <chr> "Production", "Production", "Production", "Prod…
#> $ ts_mkt_psr_type <chr> "B01", "B01", "B01", "B01", "B01", "B01", "B01"…
#> $ ts_mkt_psr_type_def <chr> "Biomass", "Biomass", "Biomass", "Biomass", "Bi…
#> $ created_date_time <dttm> 2024-10-05 19:51:35, 2024-10-05 19:51:35, 2024…
#> $ revision_number <dbl> 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,…
#> $ time_period_time_interval_start <dttm> 2019-12-31 23:00:00, 2019-12-31 23:00:00, 2019…
#> $ time_period_time_interval_end <dttm> 2020-01-01 23:00:00, 2020-01-01 23:00:00, 2020…
#> $ ts_resolution <chr> "PT15M", "PT15M", "PT15M", "PT15M", "PT15M", "P…
#> $ ts_time_interval_start <dttm> 2019-12-31 23:00:00, 2019-12-31 23:00:00, 2019…
#> $ ts_time_interval_end <dttm> 2020-01-01 23:00:00, 2020-01-01 23:00:00, 2020…
#> $ ts_mrid <dbl> 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,…
#> $ ts_point_dt_start <dttm> 2019-12-31 23:00:00, 2019-12-31 23:15:00, 2019…
#> $ ts_point_quantity <dbl> 4918, 4913, 4899, 4897, 4896, 4877, 4886, 4896,…
#> $ ts_quantity_measure_unit_name <chr> "MAW", "MAW", "MAW", "MAW", "MAW", "MAW", "MAW"…
