> ## 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 Confirmed Schedule Series

> Show the series of your confirmed schedules.

Each series is one series identity in the scheduling area of its schedule, across delivery days. The list shows only the series that have a confirmation. Use its `series_id` to read its values in List Confirmed Schedules.

The list shows the series in the sequence of `series_id`. To read the full list, use `offset` and `limit` to get one page at a time. `total` is the number of series that agree with the filters, on all pages.

The API gives the status code 422 in these conditions:

- A `scheduling_area` filter has more values than its maximum.

- `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/confirmed-schedules
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/confirmed-schedules:
    get:
      tags:
        - timeseries
      summary: List Confirmed Schedule Series
      description: >-
        Show the series of your confirmed schedules.


        Each series is one series identity in the scheduling area of its
        schedule, across delivery days. The list shows only the series that have
        a confirmation. Use its `series_id` to read its values in List Confirmed
        Schedules.


        The list shows the series in the sequence of `series_id`. To read the
        full list, use `offset` and `limit` to get one page at a time. `total`
        is the number of series that agree with the filters, on all pages.


        The API gives the status code 422 in these conditions:


        - A `scheduling_area` filter has more values than its maximum.


        - `offset` is less than 0 or more than its maximum, or `limit` is less  
        than 1 or more than its maximum.
      operationId: >-
        list_confirmed_schedule_series_market_access_v1alpha1_timeseries_series_confirmed_schedules_get
      parameters:
        - 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: >-
            The position of the first series of the page in the list. The first
            series in the list has the position 0.
          in: query
          name: offset
          required: false
          schema:
            default: 0
            description: >-
              The position of the first series of the page in the list. The
              first series in the list has the position 0.
            maximum: 9223372036854776000
            minimum: 0
            title: Offset
            type: integer
        - description: The maximum number of series on the page.
          in: query
          name: limit
          required: false
          schema:
            default: 100
            description: The maximum number of series on the page.
            maximum: 1000
            minimum: 1
            title: Limit
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmedScheduleSeriesPage'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    ConfirmedScheduleSeriesPage:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ConfirmedScheduleSeriesItem'
          title: Items
          type: array
        limit:
          title: Limit
          type: integer
        offset:
          title: Offset
          type: integer
        total:
          description: The number of series that agree with the filters, on all pages.
          title: Total
          type: integer
      required:
        - items
        - limit
        - offset
        - total
      title: ConfirmedScheduleSeriesPage
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ConfirmedScheduleSeriesItem:
      description: >-
        One series of the confirmed schedules: one series identity in one
        scheduling area, across delivery days.
      properties:
        scheduling_area:
          description: >-
            The EIC of the scheduling area of the schedule. An external series
            is in the schedules of both its areas, and the Scheduling Area
            Responsible of each area confirms it separately. Thus it is a
            different series in each area.
          examples:
            - 10YDE-EON------1
          title: Scheduling Area
          type: string
        series:
          description: The kind, areas and parties that identify the series.
          discriminator:
            mapping:
              external: '#/components/schemas/ExternalSeriesResponse'
              internal: '#/components/schemas/InternalSeriesResponse'
              production_consumption: '#/components/schemas/ProductionConsumptionSeriesResponse'
            propertyName: type
          oneOf:
            - $ref: '#/components/schemas/ProductionConsumptionSeriesResponse'
            - $ref: '#/components/schemas/InternalSeriesResponse'
            - $ref: '#/components/schemas/ExternalSeriesResponse'
          title: Series
        series_id:
          description: >-
            The key of the series. It stays the same on each delivery day. Use
            it to read the values of the series in List Confirmed Schedules.
          format: uuid
          title: Series Id
          type: string
      required:
        - scheduling_area
        - series
        - series_id
      title: ConfirmedScheduleSeriesItem
      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
    ExternalSeriesResponse:
      properties:
        in_area:
          title: In Area
          type: string
        in_party:
          title: In Party
          type: string
        market_agreement_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Market Agreement Id
        out_area:
          title: Out Area
          type: string
        out_party:
          title: Out Party
          type: string
        type:
          const: external
          default: external
          title: Type
          type: string
      required:
        - in_area
        - in_party
        - market_agreement_id
        - out_area
        - out_party
      title: ExternalSeriesResponse
      type: object
    InternalSeriesResponse:
      properties:
        in_party:
          title: In Party
          type: string
        out_party:
          title: Out Party
          type: string
        scheduling_area:
          title: Scheduling Area
          type: string
        type:
          const: internal
          default: internal
          title: Type
          type: string
      required:
        - in_party
        - out_party
        - scheduling_area
      title: InternalSeriesResponse
      type: object
    ProductionConsumptionSeriesResponse:
      properties:
        direction:
          enum:
            - production
            - consumption
          title: Direction
          type: string
        scheduling_area:
          title: Scheduling Area
          type: string
        type:
          const: production_consumption
          default: production_consumption
          title: Type
          type: string
      required:
        - direction
        - scheduling_area
      title: ProductionConsumptionSeriesResponse
      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.