Skip to main content
GET
List Imbalance Series

Authorizations

Authorization
string
header
required

Query Parameters

external_id
string[] | null

External ids of the imbalance series to read.

Maximum array length: 500
scheduling_area
string[] | null

EIC codes of the scheduling areas to read, for example 10YDE-EON------1. Omit to read every area.

Maximum array length: 500
balance_group
string[] | null

Balance groups to read. Omit to read every group.

Maximum array length: 500
component_kind
enum<string>[] | null

Component kinds to read. Omit to read both.

The level of an imbalance series. The total contains the adjustments, thus do not add a total and its adjustments together.

Available imbalance component kinds

  • total — The imbalance of the balance group, with all adjustments included.

  • adjustment — An adjustment that the market included in the imbalance, with the sign it has in the imbalance.

Available options:
total,
adjustment
component_value
enum<string>[] | null

Component values to read. Omit to read every value.

The adjustment class of an imbalance series and its suffix: _up or _down for the regulation direction, _net for one signed series. ALL contains the classes, and each _net contains its _up and _down, thus never add across these levels.

Available imbalance component values

  • ALL — On a total, the imbalance. On an adjustment, the net of all the adjustments that the market sends.

  • afrr_up — Automatic frequency restoration reserve (aFRR), upward regulation.

  • afrr_down — aFRR, downward regulation.

  • afrr_net — aFRR, both directions in one signed series.

  • mfrr_up — Manual frequency restoration reserve (mFRR), upward regulation.

  • mfrr_down — mFRR, downward regulation.

  • mfrr_net — mFRR, both directions in one signed series.

  • redispatch_up — Redispatch, upward regulation.

  • redispatch_down — Redispatch, downward regulation.

  • redispatch_net — Redispatch, both directions in one signed series.

  • other_up — A different adjustment class, upward. The market's own code for the class is in the market dimensions.

  • other_down — A different adjustment class, downward. The market's own code for the class is in the market dimensions.

  • other_net — A different adjustment class, both directions in one signed series. The market's own code for the class is in the market dimensions.

Available options:
ALL,
afrr_up,
afrr_down,
afrr_net,
mfrr_up,
mfrr_down,
mfrr_net,
redispatch_up,
redispatch_down,
redispatch_net,
other_up,
other_down,
other_net
market_dimension
string[] | null

Market dimensions to filter by, as key:value. A market dimension is the market's own key and code for an imbalance series, for example the code of an adjustment class. A series matches when it has every pair.

Maximum array length: 500
offset
integer
default:0

The position of the first imbalance series of the page in the list. The first imbalance series in the list has the position 0.

Required range: 0 <= x <= 9223372036854776000
limit
integer
default:100

The maximum number of imbalance series on the page.

Required range: 1 <= x <= 1000

Response

Successful Response

items
ImbalanceSeries · object[]
required
limit
integer
required
offset
integer
required
total
integer
required

The number of imbalance series that agree with the filters, on all pages.