Generated Reference

This page lists every Julia name produced by OpenAPI Generator from spec/openapi.json — operation functions, response model types, and shared API helpers. The set is regenerated wholesale by gen/regenerate.jl whenever the spec changes; do not edit src/api/ directly.

The interactive REST browser under REST API Reference covers the same surface from the spec side (parameter shapes, response schemas, example payloads). This page is the Julia side: function signatures and the docstrings codegen attached to them.

ENTSOE.ENTSOEAPI.balancing123_a_current_balancing_state_gl_eb Method

12.3.A Current balancing state [GL EB]

<u><b>Request limit:</b></u> Each request may cover a period of up to 100 days.

Params:

document_type::String (required)
business_type::String (required)
area_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing123_b_c_balancing_energy_bids Method

12.3.B&C Balancing energy bids

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements in total, counted across all XML documents contained in the ZIP response. The offsetparameter can be used to retrieve the data in batches of up to 100 TimeSeries, where offset=0 returns the first 100 elements, offset=100 returns the next 100, and so on.

Params:

document_type::String (required)
business_type::String (required)
process_type::String (required)
connecting_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
offset::Int64
standard_market_product::String
original_market_product::String
direction::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing123_b_c_balancing_energy_bids_archives Method

12.3.B&C Balancing energy bids archives

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 ZIP files contained in the ZIP response. The offsetparameter can be used to retrieve the data in batches of up to 100 ZIP archives, whereoffset=0 returns the first 100 archives, offset=100 returns the next 100, and so on.

Params:

document_type::String (required)
business_type::String (required)
process_type::String (required)
connecting_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
storage_type::String (required)
offset::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing123_e_aggregated_balancing_energy_bids_gl_eb Method

12.3.E Aggregated Balancing Energy Bids (GL EB)

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
process_type::String (required)
area_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing123_f_procured_balancing_capacity_gl_eb Method

12.3.F Procured balancing capacity (GL EB)

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements in total, counted across all XML documents contained in the ZIP response. The offsetparameter can be used to retrieve the data in batches of up to 100 TimeSeries, where offset=0 returns the first 100 elements, offset=100 returns the next 100, and so on.

Params:

document_type::String (required)
process_type::String (required)
area_domain::String (required)
period_start::Int64 (required)
period_end::Int64
offset::Int64
type_market_agreement_type::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing123_h_i_allocation_and_use_of_cross_zonal_balancing_capacity Method

12.3.H&I Allocation and use of cross-zonal balancing capacity

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 instances contained in the ZIP response. One instance can be split into up to 8 TimeSeries. The total number of files in the ZIP file is variable and depends on the values of the dividing elements - allocation decision time, domain.mRID, etc.

Params:

document_type::String (required)
process_type::String (required)
connecting_domain::String (required)
acquiring_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
type_market_agreement_type::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing171_b_c_volumes_and_prices_of_contracted_reserves Method

17.1.B&C Volumes and Prices of Contracted Reserves

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements in total, counted across all XML documents contained in the ZIP response. The offsetparameter can be used to retrieve the data in batches of up to 100 TimeSeries, where offset=0 returns the first 100 elements, offset=100 returns the next 100, and so on.

Params:

document_type::String (required)
business_type::String (required)
type_market_agreement_type::String (required)
control_area_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
process_type::String
psr_type::String
offset::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing171_f_prices_of_activated_balancing_energy Method

17.1.F Prices of Activated Balancing Energy

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
process_type::String (required)
control_area_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
business_type::String
export_type::String
psr_type::String
standard_market_product::String
original_market_product::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing171_g_imbalance_prices Method

17.1.G Imbalance prices

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
control_area_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
psr_type::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing171_h_total_imbalance_volumes Method

17.1.H Total Imbalance Volumes

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
control_area_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
business_type::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing171_i_financial_expenses_and_income_for_balancing Method

17.1.I Financial Expenses and Income for Balancing

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
control_area_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing1854_results_of_the_criteria_application_process_measurements_so_gl Method

185.4 Results of the Criteria Application Process - Measurements (SO GL)

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
process_type::String (required)
area_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing1872_fcr_total_capacity_so_gl Method

187.2 FCR Total capacity (SO GL)

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String
business_type::String
area_domain::String
period_start::Int64
period_end::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing1872_shares_of_fcr_capacity_so_gl Method

187.2 Shares of FCR capacity (SO GL)

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String
business_type::String
area_domain::String
period_start::Int64
period_end::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing18831892_frr_rr_capacity_outlook_so_gl Method

188.3 & 189.2 FRR & RR Capacity Outlook (SO GL)

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
process_type::String (required)
business_type::String (required)
area_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing18841893_frr_and_rr_actual_capacity_so_gl Method

188.4 & 189.3 FRR and RR Actual Capacity (SO GL)

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
process_type::String (required)
business_type::String (required)
area_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing1892_outlook_of_reserve_capacities_on_rr_so_gl Method

189.2 Outlook of Reserve Capacities on RR (SO GL)

Params:

document_type::String
process_type::String
business_type::String
area_domain::String
period_start::Int64
period_end::Int64
offset::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing1893_rr_actual_capacity_so_gl Method

189.3 RR Actual Capacity(SO GL)

Params:

document_type::String
process_type::String
business_type::String
area_domain::String
period_start::Int64
period_end::Int64
offset::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing1901_sharing_of_rr_and_frr_so_gl Method

190.1 Sharing of RR and FRR (SO GL)

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response. The offsetparameter can be used to retrieve the data in batches of up to 100 TimeSeries, where offset=0 returns the first 100 elements, offset=100 returns the next 100, and so on.

Params:

document_type::String
process_type::String
business_type::String
acquiring_domain::String
connecting_domain::String
period_start::Int64
period_end::Int64
offset::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing1902_sharing_of_fcr_between_sas_so_gl Method

190.2 Sharing of FCR between SAs (SO GL)

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response. The offsetparameter can be used to retrieve the data in batches of up to 100 TimeSeries, where offset=0 returns the first 100 elements, offset=100 returns the next 100, and so on.

Params:

document_type::String
process_type::String
business_type::String
area_domain::String
period_start::Int64
period_end::Int64
offset::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing1903_exchanged_reserve_capacity_so_gl Method

190.3 Exchanged Reserve Capacity (SO GL)

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements in total, counted across all XML documents contained in the ZIP response. The offsetparameter can be used to retrieve the data in batches of up to 100 TimeSeries, where offset=0 returns the first 100 elements, offset=100 returns the next 100, and so on.

Params:

document_type::String
process_type::String
business_type::String
acquiring_domain::String
connecting_domain::String
period_start::Int64
period_end::Int64
offset::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing_if_afrr316_cross_border_marginal_prices_cbmps_for_afrr_central_selection_cs Method

IF aFRR 3.16 Cross Border Marginal Prices (CBMPs) for aFRR Central Selection (CS)

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 day.

Params:

document_type::String (required)
process_type::String (required)
business_type::String (required)
standard_market_product::String (required)
control_area_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing_ifs310316317_netted_and_exchanged_volumes Method

IFs 3.10, 3.16 & 3.17 Netted and Exchanged Volumes

<u><b>Request limit:</b></u> - For aFRR: Each request may cover a period of up to 1 day. - For other process types: Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
process_type::String (required)
acquiring_domain::String (required)
connecting_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing_ifs310316317_netted_and_exchanged_volumes_per_border Method

IFs 3.10, 3.16 & 3.17 Netted and Exchanged Volumes per Border

<u><b>Request limit:</b></u> - For aFRR: Each request may cover a period of up to 1 day. - For other process types: Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
process_type::String (required)
acquiring_domain::String (required)
connecting_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing_ifs4344_balancing_border_capacity_limitations Method

IFs 4.3 & 4.4 Balancing Border Capacity Limitations

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
business_type::String (required)
process_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
registered_resource::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing_ifs45_permanent_allocation_limitations_to_cross_border_capacity_on_hvdc_lines Method

IFs 4.5 Permanent Allocation Limitations to Cross-border Capacity on HVDC Lines

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response.

Params:

document_type::String (required)
process_type::String (required)
business_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
registered_resource::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing_ifs_afrr34_mfrr34_elastic_demands Method

IFs aFRR 3.4 & mFRR 3.4 Elastic Demands

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response. The offsetparameter can be used to retrieve the data in batches of up to 100 TimeSeries, where offset=0 returns the first 100 elements, offset=100 returns the next 100, and so on.

Params:

document_type::String (required)
business_type::String (required)
process_type::String (required)
acquiring_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
offset::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing_ifs_mfrr99_afrr9698_changes_to_bid_availability Method

IFs mFRR 9.9, aFRR 9.6&9.8 Changes to Bid Availability

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response. The offsetparameter can be used to retrieve the data in batches of up to 100 TimeSeries, where offset=0 returns the first 100 elements, offset=100 returns the next 100, and so on.

Params:

document_type::String (required)
process_type::String (required)
domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
business_type::String
offset::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.balancing_ifs_mfrr99_afrr9698_changes_to_bid_availability_archives Method

IFs mFRR 9.9, aFRR 9.6&9.8 Changes to Bid Availability Archives

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 ZIP files contained in the ZIP response. The offsetparameter can be used to retrieve the data in batches of up to 100 ZIP archives, whereoffset=0 returns the first 100 archives, offset=100 returns the next 100, and so on.

Params:

document_type::String (required)
process_type::String (required)
domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
storage_type::String (required)
business_type::String
offset::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.generation141_a_installed_capacity_per_production_type Method

14.1.A Installed Capacity per Production Type

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
process_type::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
psr_type::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.generation141_b_installed_capacity_per_production_unit Method

14.1.B Installed Capacity Per Production Unit

Params:

document_type::String (required)
process_type::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
psr_type::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.generation141_c_generation_forecast_day_ahead Method

14.1.C Generation Forecast - Day ahead

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. Time series with inBiddingZone_Domain attribute reflects Generation values while outBiddingZone_Domain reflects Consumption values.

Params:

document_type::String (required)
process_type::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.generation141_d_generation_forecasts_for_wind_and_solar Method

14.1.D Generation Forecasts for Wind and Solar

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
process_type::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
psr_type::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.generation161_a_actual_generation_per_generation_unit Method

16.1.A Actual Generation per Generation Unit

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 day. Important notes: - Response from API is same irrespective of querying for Document Types A74 - Wind & Solar & A75 - Actual Generation Per Type - Time series with inBiddingZone_Domain attribute reflects generation values while outBiddingZone_Domain reflects consumption values.

Params:

document_type::String (required)
process_type::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
psr_type::String
registered_resource::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.generation161_b_c_actual_generation_per_production_type Method

16.1.B&C Actual Generation per Production Type

<u><b>Request limit</b></u>: Each request may cover a period of up to 1 year. Response from API is same irrespective of querying for Document Types A74 - Wind & Solar & A75 - Actual Generation Per Type Time series with inBiddingZone_Domain attribute reflects Generation values while outBiddingZone_Domain reflects Consumption values.**

Params:

document_type::String (required)
process_type::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
psr_type::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.generation161_d_water_reservoirs_and_hydro_storage_plants Method

16.1.D Water Reservoirs and Hydro Storage Plants

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
process_type::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.load61_a_actual_total_load Method

6.1.A Actual Total Load

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
process_type::String (required)
out_bidding_zone_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.load61_a_actual_total_load_post Method

6.1.A Actual Total Load (Post)

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.load61_a_actual_total_load_security_token_in_header Method

6.1.A Actual Total Load - SECURITY_TOKEN in header

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. Note: This is an example where the security token is included in the request header rather than in the query parameters.

Params:

document_type::String (required)
process_type::String (required)
out_bidding_zone_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.load61_b_day_ahead_total_load_forecast Method

6.1.B Day-ahead Total Load Forecast

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
process_type::String (required)
out_bidding_zone_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.load61_c_week_ahead_total_load_forecast Method

6.1.C Week-ahead Total Load Forecast

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
process_type::String (required)
out_bidding_zone_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.load61_d_month_ahead_total_load_forecast Method

6.1.D Month-ahead Total Load Forecast

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
process_type::String (required)
out_bidding_zone_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.load61_e_year_ahead_total_load_forecast Method

6.1.E Year-ahead Total Load Forecast

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
process_type::String (required)
out_bidding_zone_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.load81_year_ahead_forecast_margin Method

8.1 Year-ahead Forecast Margin

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
process_type::String (required)
out_bidding_zone_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.market111_a_explicit_allocations_offered_transfer_capacity Method

11.1.A Explicit Allocations - Offered Transfer Capacity

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response.

Params:

document_type::String (required)
auction_type::String (required)
contract_market_agreement_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
auction_category::String
update_date_and_or_time::Int64
classification_sequence_attribute_instance_component_position::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.market111_b_flow_based_allocations Method

11.1.B Flow Based Allocations

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 1 instances contained in the ZIP response, split into several files within the response ZIP file.

Params:

document_type::String (required)
process_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.market111_b_flow_based_allocations_archives Method

11.1.B Flow Based Allocations Archives

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 1 archive in the ZIP response.

Params:

document_type::String (required)
process_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
storage_type::String (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.market111_continuous_allocations_offered_transfer_capacity Method

11.1 Continuous Allocations - Offered Transfer Capacity

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response. The offsetparameter can be used to retrieve the data in batches of up to 100 TimeSeries, where offset=0 returns the first 100 elements, offset=100 returns the next 100, and so on.

Params:

document_type::String (required)
auction_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
contract_market_agreement_type::String (required)
update_date_and_or_time::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.market111_implicit_allocations_offered_transfer_capacity Method

11.1 Implicit Allocations - Offered Transfer Capacity

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response.

Params:

document_type::String (required)
auction_type::String (required)
contract_market_agreement_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
update_date_and_or_time::Int64
classification_sequence_attribute_instance_component_position::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.market121_a_explicit_allocations_auction_revenue Method

12.1.A Explicit Allocations - Auction Revenue

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response.

Params:

document_type::String (required)
business_type::String (required)
contract_market_agreement_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.market121_a_explicit_allocations_use_of_the_transfer_capacity Method

12.1.A Explicit Allocations - Use of the Transfer Capacity

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response.

Params:

document_type::String (required)
business_type::String (required)
contract_market_agreement_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
auction_category::String
classification_sequence_attribute_instance_component_position::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.market121_b_total_nominated_capacity Method

12.1.B Total Nominated Capacity

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
business_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.market121_c_total_capacity_already_allocated Method

12.1.C Total Capacity Already Allocated

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response.

Params:

document_type::String (required)
business_type::String (required)
contract_market_agreement_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
auction_category::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.market121_d_energy_prices Method

12.1.D Energy Prices

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response. The offsetparameter can be used to retrieve the data in batches of up to 100 TimeSeries, where offset=0 returns the first 100 elements, offset=100 returns the next 100, and so on.

Params:

document_type::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
out_domain::String (required)
in_domain::String (required)
contract_market_agreement_type::String
classification_sequence_attribute_instance_component_position::Int64
offset::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.market121_e_implicit_and_flow_based_allocations_congestion_income Method

12.1.E Implicit and Flow-based Allocations - Congestion Income

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response.

Params:

document_type::String (required)
business_type::String (required)
contract_market_agreement_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.market121_e_implicit_auction_net_positions Method

12.1.E Implicit Auction — Net Positions

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
business_type::String (required)
contract_market_agreement_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.market121_h_transfer_capacities_allocated_with_third_countries121_h_explicit Method

12.1.H Transfer Capacities Allocated with Third Countries [12.1.H] (explicit)

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response.

Params:

document_type::String (required)
auction_type::String (required)
contract_market_agreement_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
auction_category::String
classification_sequence_attribute_instance_component_position::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.master_data_production_and_generation_units Method

Production and Generation Units

Response contains commissioned production units for given day

Params:

document_type::String (required)
business_type::String (required)
bidding_zone_domain::String (required)
implementation_date_and_or_time::String (required)
psr_type::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.omi_other_market_information Method

Other Market Information

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. - It applies to PeriodStart and PeriodEnd if PeriodStartUpdate and PeriodEndUpdate parameters are not included in the request. - It applies only to PeriodStartUpdate and PeriodEndUpdate if included in the request. <u><b>Response limit</b></u>: A maximum of 200 XML documents contained in the ZIP response. The offsetparameter can be used to retrieve the data in batches of up to 200 XML documents, where offset=0 returns the first 200 documents, offset=200 returns the next 200, and so on.

Params:

document_type::String (required)
control_area_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
doc_status::String
period_start_update::Int64
period_end_update::Int64
offset::Int64
m_r_i_d::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.outages101_a_b_unavailability_of_transmission_infrastructure Method

10.1.A&B Unavailability of Transmission Infrastructure

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. - It applies to PeriodStart and PeriodEnd if PeriodStartUpdate and PeriodEndUpdate parameters are not included in the request. - It applies only to PeriodStartUpdate and PeriodEndUpdate if included in the request. <u><b>Response limit</b></u>: A maximum of 200 XML documents contained in the ZIP response. The offsetparameter can be used to retrieve the data in batches of up to 200 XML documents, where offset=0 returns the first 200 documents, offset=200 returns the next 200, and so on.

Params:

document_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
business_type::String
doc_status::String
period_start_update::Int64
period_end_update::Int64
m_r_i_d::String
offset::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.outages101_a_b_unavailability_of_transmission_infrastructure_available_capacity Method

10.1.A&B Unavailability of Transmission Infrastructure - Available Capacity

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. - It applies to PeriodStart and PeriodEnd if PeriodStartUpdate and PeriodEndUpdate parameters are not included in the request. - It applies only to PeriodStartUpdate and PeriodEndUpdate if included in the request. <u><b>Response limit</b></u>: A maximum of 200 XML documents contained in the ZIP response. The offsetparameter can be used to retrieve the data in batches of up to 200 XML documents, where offset=0 returns the first 200 documents, offset=200 returns the next 200, and so on.

Params:

document_type::String (required)
control_area_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
business_type::String
asset_registered_resource_m_r_i_d::String
doc_status::String
period_start_update::Int64
period_end_update::Int64
m_r_i_d::String
offset::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.outages101_a_b_unavailability_of_transmission_infrastructure_net_position_impact Method

10.1.A&B Unavailability of Transmission Infrastructure - Net Position Impact

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. - It applies to PeriodStart and PeriodEnd if PeriodStartUpdate and PeriodEndUpdate parameters are not included in the request. - It applies only to PeriodStartUpdate and PeriodEndUpdate if included in the request. <u><b>Response limit</b></u>: A maximum of 200 XML documents contained in the ZIP response. The offsetparameter can be used to retrieve the data in batches of up to 200 XML documents, where offset=0 returns the first 200 documents, offset=200 returns the next 200, and so on.

Params:

document_type::String (required)
p_t_d_f_domain_m_r_i_d::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
business_type::String
doc_status::String
period_start_update::Int64
period_end_update::Int64
m_r_i_d::String
offset::Int64
asset_registered_resource_m_r_i_d::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.outages101_c_unavailability_of_offshore_grid_infrastructure Method

10.1.C Unavailability of Offshore Grid Infrastructure

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. - It applies to PeriodStart and PeriodEnd if PeriodStartUpdate and PeriodEndUpdate parameters are not included in the request. - It applies only to PeriodStartUpdate and PeriodEndUpdate if included in the request. <u><b>Response limit</b></u>: A maximum of 200 XML documents contained in the ZIP response. The offsetparameter can be used to retrieve the data in batches of up to 200 XML documents, where offset=0 returns the first 200 documents, offset=200 returns the next 200, and so on.

Params:

document_type::String (required)
bidding_zone_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
doc_status::String
period_start_update::Int64
period_end_update::Int64
m_r_i_d::String
offset::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.outages151_a_b_unavailability_of_generation_units Method

15.1.A&B Unavailability of Generation Units

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. - It applies to PeriodStart and PeriodEnd if PeriodStartUpdate and PeriodEndUpdate parameters are not included in the request. - It applies only to PeriodStartUpdate and PeriodEndUpdate if included in the request. <u><b>Response limit</b></u>: A maximum of 200 XML documents contained in the ZIP response. The offsetparameter can be used to retrieve the data in batches of up to 200 XML documents, where offset=0 returns the first 200 documents, offset=200 returns the next 200, and so on.

Params:

document_type::String (required)
bidding_zone_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
business_type::String
doc_status::String
period_start_update::Int64
period_end_update::Int64
registered_resource::String
m_r_i_d::String
offset::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.outages151_c_d_unavailability_of_production_units Method

15.1.C-D Unavailability of Production Units

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. - It applies to PeriodStart and PeriodEnd if PeriodStartUpdate and PeriodEndUpdate parameters are not included in the request. - It applies only to PeriodStartUpdate and PeriodEndUpdate if included in the request. <u><b>Response limit</b></u>: A maximum of 200 XML documents contained in the ZIP response. The offsetparameter can be used to retrieve the data in batches of up to 200 XML documents, where offset=0 returns the first 200 documents, offset=200 returns the next 200, and so on.

Params:

document_type::String (required)
bidding_zone_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
business_type::String
doc_status::String
period_start_update::Int64
period_end_update::Int64
registered_resource::String
m_r_i_d::String
offset::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.outages71_a_b_aggregated_unavailability_of_consumption_units Method

7.1.A-B Aggregated Unavailability of Consumption Units

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
bidding_zone_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
business_type::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.outages_fall_backs_ifs_in72_mfrr311_afrr310 Method

Fall-backs [IFs IN 7.2, mFRR 3.11, aFRR 3.10]

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 XML documents contained in the ZIP response. The offsetparameter can be used to retrieve the data in batches of up to 100 XML documents, where offset=0 returns the first 100 documents, offset=100 returns the next 100, and so on.

Params:

document_type::String (required)
process_type::String (required)
business_type::String (required)
bidding_zone_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
doc_status::String
m_r_i_d::String
offset::Int64

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.transmission111_a_forecasted_transfer_capacities Method

11.1.A Forecasted Transfer Capacities

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
contract_market_agreement_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.transmission113_cross_border_capacity_of_dc_links_intraday_transfer_limits Method

11.3 Cross Border Capacity of DC Links - Intraday Transfer Limits

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response.

Params:

document_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.transmission121_f_commercial_schedules Method

12.1.F Commercial Schedules

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
contract_market_agreement_type::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.transmission121_f_commercial_schedules_net_positions Method

12.1.F Commercial Schedules - Net Positions

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
contract_market_agreement_type::String

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.transmission121_g_cross_border_physical_flows Method

12.1.G Cross-Border Physical Flows

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. Unlike Web GUI, API responds not netted values as data is requested per direction.

Params:

document_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.transmission131_a_redispatching_cross_border Method

13.1.A Redispatching Cross Border

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response.

Params:

document_type::String (required)
business_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.transmission131_a_redispatching_internal Method

13.1.A Redispatching Internal

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response.

Params:

document_type::String (required)
business_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.transmission131_b_countertrading Method

13.1.B Countertrading

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response.

Params:

document_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.transmission131_c_costs_of_congestion_management Method

13.1.C Costs of Congestion Management

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year.

Params:

document_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)

Return: String, OpenAPI.Clients.ApiResponse

ENTSOE.ENTSOEAPI.transmission91_expansion_and_dismantling_project Method

9.1 Expansion and Dismantling Project

<u><b>Request limit:</b></u> Each request may cover a period of up to 1 year. <u><b><br>Response limit</b></u>: A maximum of 100 TimeSeries elements is returned per XML response.

Params:

document_type::String (required)
out_domain::String (required)
in_domain::String (required)
period_start::Int64 (required)
period_end::Int64 (required)
business_type::String
doc_status::String

Return: String, OpenAPI.Clients.ApiResponse

Per-API base paths

The basepath function returns the canonical server URL declared in spec/openapi.json for each tagged API. It is the default used by the domain client constructor when no explicit base_url is supplied.

ENTSOE.ENTSOEAPI.basepath Method

The default API base path for APIs in BalancingApi. This can be used to construct the OpenAPI.Clients.Client instance.

ENTSOE.ENTSOEAPI.basepath Method

The default API base path for APIs in GenerationApi. This can be used to construct the OpenAPI.Clients.Client instance.

ENTSOE.ENTSOEAPI.basepath Method

The default API base path for APIs in LoadApi. This can be used to construct the OpenAPI.Clients.Client instance.

ENTSOE.ENTSOEAPI.basepath Method

The default API base path for APIs in MarketApi. This can be used to construct the OpenAPI.Clients.Client instance.

ENTSOE.ENTSOEAPI.basepath Method

The default API base path for APIs in MasterDataApi. This can be used to construct the OpenAPI.Clients.Client instance.

ENTSOE.ENTSOEAPI.basepath Method

The default API base path for APIs in OMIApi. This can be used to construct the OpenAPI.Clients.Client instance.

ENTSOE.ENTSOEAPI.basepath Method

The default API base path for APIs in OutagesApi. This can be used to construct the OpenAPI.Clients.Client instance.

ENTSOE.ENTSOEAPI.basepath Method

The default API base path for APIs in TransmissionApi. This can be used to construct the OpenAPI.Clients.Client instance.