> ## Documentation Index > Fetch the complete documentation index at: https://docs.engrate.io/llms.txt > Use this file to discover all available pages before exploring further. # List Imbalance Series > List the imbalance series that agree with the filters. Each imbalance series holds the imbalance of one balance group in one scheduling area, or one adjustment that the market included in it. Use its `external_id` to read its volumes in List Imbalances. The list shows the imbalance series in the sequence of `external_id`. To read the full list, use `offset` and `limit` to get one page at a time. `total` is the number of imbalance series that agree with the filters, on all pages. The API gives the status code 422 in these conditions: - A `market_dimension` filter is not in the format `key:value`. - A `market_dimension` filter has one key two times. - A `component_kind` or `component_value` filter has an unknown value. - An `external_id`, `scheduling_area`, `balance_group` or `market_dimension` filter exceeds its maximum number of values. - `offset` is less than 0 or more than its maximum, or `limit` is less than 1 or more than its maximum. ## OpenAPI ````yaml /openapi.json get /market-access/v1alpha1/timeseries/series/imbalance openapi: 3.1.0 info: title: Engrate API version: 1.0.0 servers: - url: https://api.engrate.io security: - apiKeyAuth: [] paths: /market-access/v1alpha1/timeseries/series/imbalance: get: tags: - timeseries summary: List Imbalance Series description: >- List the imbalance series that agree with the filters. Each imbalance series holds the imbalance of one balance group in one scheduling area, or one adjustment that the market included in it. Use its `external_id` to read its volumes in List Imbalances. The list shows the imbalance series in the sequence of `external_id`. To read the full list, use `offset` and `limit` to get one page at a time. `total` is the number of imbalance series that agree with the filters, on all pages. The API gives the status code 422 in these conditions: - A `market_dimension` filter is not in the format `key:value`. - A `market_dimension` filter has one key two times. - A `component_kind` or `component_value` filter has an unknown value. - An `external_id`, `scheduling_area`, `balance_group` or `market_dimension` filter exceeds its maximum number of values. - `offset` is less than 0 or more than its maximum, or `limit` is less than 1 or more than its maximum. operationId: >- list_imbalance_series_market_access_v1alpha1_timeseries_series_imbalance_get parameters: - description: External ids of the imbalance series to read. in: query name: external_id required: false schema: anyOf: - items: type: string maxItems: 500 type: array - type: 'null' description: External ids of the imbalance series to read. title: External Id - description: >- EIC codes of the scheduling areas to read, for example `10YDE-EON------1`. Omit to read every area. in: query name: scheduling_area required: false schema: anyOf: - items: type: string maxItems: 500 type: array - type: 'null' description: >- EIC codes of the scheduling areas to read, for example `10YDE-EON------1`. Omit to read every area. title: Scheduling Area - description: Balance groups to read. Omit to read every group. in: query name: balance_group required: false schema: anyOf: - items: type: string maxItems: 500 type: array - type: 'null' description: Balance groups to read. Omit to read every group. title: Balance Group - description: Component kinds to read. Omit to read both. in: query name: component_kind required: false schema: anyOf: - items: $ref: '#/components/schemas/ImbalanceComponentKind' type: array - type: 'null' description: Component kinds to read. Omit to read both. title: Component Kind - description: Component values to read. Omit to read every value. in: query name: component_value required: false schema: anyOf: - items: $ref: '#/components/schemas/ImbalanceComponentValue' type: array - type: 'null' description: Component values to read. Omit to read every value. title: Component Value - description: >- 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. in: query name: market_dimension required: false schema: anyOf: - items: type: string maxItems: 500 type: array - type: 'null' description: >- 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. title: Market Dimension - description: >- The position of the first imbalance series of the page in the list. The first imbalance series in the list has the position 0. in: query name: offset required: false schema: default: 0 description: >- The position of the first imbalance series of the page in the list. The first imbalance series in the list has the position 0. maximum: 9223372036854776000 minimum: 0 title: Offset type: integer - description: The maximum number of imbalance series on the page. in: query name: limit required: false schema: default: 100 description: The maximum number of imbalance series on the page. maximum: 1000 minimum: 1 title: Limit type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/ImbalanceSeriesPage' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error components: schemas: ImbalanceComponentKind: description: >- 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. enum: - total - adjustment examples: - total title: ImbalanceComponentKind type: string ImbalanceComponentValue: description: >- 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. enum: - 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 examples: - ALL title: ImbalanceComponentValue type: string ImbalanceSeriesPage: properties: items: items: $ref: '#/components/schemas/ImbalanceSeries' title: Items type: array limit: title: Limit type: integer offset: title: Offset type: integer total: description: >- The number of imbalance series that agree with the filters, on all pages. title: Total type: integer required: - items - limit - offset - total title: ImbalanceSeriesPage type: object HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' title: Detail type: array title: HTTPValidationError type: object ImbalanceSeries: description: >- An imbalance series and its dimensions: the imbalance of one balance group in one scheduling area, or one adjustment that the market included in it. properties: balance_group: description: The market's identifier of the balance group. examples: - 11XBILANZKREIS-X title: Balance Group type: string component_kind: $ref: '#/components/schemas/ImbalanceComponentKind' component_value: $ref: '#/components/schemas/ImbalanceComponentValue' external_id: description: >- The identifier of the imbalance series. The market gives it, or Engrate gives it in markets that do not give a stable identifier. title: External Id type: string market_dimensions: additionalProperties: type: string description: >- The market's own codes for the series, for example the code of an adjustment class. Empty when the market gives no code. examples: - {} - business_type: A97 product_type: A02 title: Market Dimensions type: object scheduling_area: description: The EIC code of the scheduling area. examples: - 10YDE-RWENET---I title: Scheduling Area type: string required: - balance_group - component_kind - component_value - external_id - market_dimensions - scheduling_area title: ImbalanceSeries type: object ValidationError: properties: ctx: title: Context type: object input: title: Input loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: title: Error Type type: string required: - loc - msg - type title: ValidationError type: object securitySchemes: apiKeyAuth: in: header name: Authorization type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.