> ## 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 Allocation Series

> Show the allocation series that agree with the filters.

Each series holds the allocations of one flow direction at one accounting point. Use its `accounting_point_id` to read its values in List Allocations. Use the `market_identifier` filter to find the accounting point that the market identifies by an EAN code or another identifier.

The list shows the series in the sequence of `accounting_point_id`, then `flow_direction`. 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:

- An `accounting_point_id` filter is not a UUID.

- A `flow_direction` filter has an unknown value.

- An `accounting_point_id` or `market_identifier` 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/allocations
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/allocations:
    get:
      tags:
        - timeseries
      summary: List Allocation Series
      description: >-
        Show the allocation series that agree with the filters.


        Each series holds the allocations of one flow direction at one
        accounting point. Use its `accounting_point_id` to read its values in
        List Allocations. Use the `market_identifier` filter to find the
        accounting point that the market identifies by an EAN code or another
        identifier.


        The list shows the series in the sequence of `accounting_point_id`, then
        `flow_direction`. 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:


        - An `accounting_point_id` filter is not a UUID.


        - A `flow_direction` filter has an unknown value.


        - An `accounting_point_id` or `market_identifier` 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_allocation_series_market_access_v1alpha1_timeseries_series_allocations_get
      parameters:
        - description: Accounting points to read. Omit to read every point.
          in: query
          name: accounting_point_id
          required: false
          schema:
            anyOf:
              - items:
                  format: uuid
                  type: string
                maxItems: 500
                type: array
              - type: 'null'
            description: Accounting points to read. Omit to read every point.
            title: Accounting Point Id
        - description: >-
            Market identifiers of the accounting points to read, for example EAN
            codes. A series matches when its identifier has one of the values,
            whatever its kind. Omit to read every identifier.
          in: query
          name: market_identifier
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                maxItems: 500
                type: array
              - type: 'null'
            description: >-
              Market identifiers of the accounting points to read, for example
              EAN codes. A series matches when its identifier has one of the
              values, whatever its kind. Omit to read every identifier.
            title: Market Identifier
        - description: Flow directions to read. Omit to read both.
          in: query
          name: flow_direction
          required: false
          schema:
            anyOf:
              - items:
                  enum:
                    - consumption
                    - production
                  type: string
                type: array
              - type: 'null'
            description: Flow directions to read. Omit to read both.
            title: Flow Direction
        - 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/AllocationSeriesPage'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    AllocationSeriesPage:
      properties:
        items:
          items:
            $ref: '#/components/schemas/AllocationSeriesItem'
          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: AllocationSeriesPage
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    AllocationSeriesItem:
      description: The allocations of one flow direction at one accounting point.
      properties:
        accounting_point_id:
          description: >-
            The accounting point of the series. Use it to read the volumes of
            the series in List Allocations.
          format: uuid
          title: Accounting Point Id
          type: string
        flow_direction:
          enum:
            - consumption
            - production
          title: Flow Direction
          type: string
        market_identifier:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The identifier that the market gives to the accounting point, for
            example its EAN code. Null for a series that Engrate stored before
            it recorded identifiers.
          examples:
            - '871687123456789011'
          title: Market Identifier
      required:
        - accounting_point_id
        - flow_direction
        - market_identifier
      title: AllocationSeriesItem
      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.