> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# List OT settlement cycles

> A filterable, cursor-paginated page of the rail's own OT deferred-net cycles, newest first.



## OpenAPI

````yaml pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/cycles
openapi: 3.1.0
info:
  description: >-
    Interface OpenAPI 3.1 do Lerian SILOC, o trilho do lado do participante que
    conecta a instituição à liquidação interbancária diferida por compensação
    SILOC da Núclea. Abrange as capacidades de cobertura de liquidação, o
    registro de participantes e seu status operacional, o ciclo de vida dos
    certificados regulados, o relay de mensagens do domínio de cartões e seu
    status, o reenvio administrativo de falhas de relay estacionadas, os ciclos
    OT e as rodadas de recálculo, as instruções de liquidação, a ingestão de
    ROC, os alertas operacionais, as mudanças de agenda de contingência, a
    leitura do calendário de dias úteis e a trilha de auditoria.
  title: Lerian SILOC API
  version: 1.0.0
servers:
  - url: http://localhost:9820
security: []
paths:
  /api/v1/siloc/cycles:
    get:
      tags:
        - Settlement
      summary: List OT settlement cycles
      description: >-
        A filterable, cursor-paginated page of the rail's own OT deferred-net
        cycles, newest first.
      operationId: listCycles
      parameters:
        - description: Filter by the cycle's business (reference) date.
          explode: false
          in: query
          name: referenceDate
          schema:
            description: Filter by the cycle's business (reference) date.
            format: date
            type: string
        - description: Filter by cycle status.
          explode: false
          in: query
          name: status
          schema:
            description: Filter by cycle status.
            enum:
              - OPEN
              - SETTLING
              - RECALCULATING
              - SETTLED
              - CLOSED
            type: string
        - description: Opaque pagination cursor.
          explode: false
          in: query
          name: cursor
          schema:
            description: Opaque pagination cursor.
            type: string
        - description: Page size (default 50, max 200).
          explode: false
          in: query
          name: limit
          schema:
            default: 50
            description: Page size (default 50, max 200).
            format: int64
            maximum: 200
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CycleListResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    CycleListResponse:
      additionalProperties: false
      properties:
        hasMore:
          description: Whether more pages follow.
          type: boolean
        items:
          description: The page of cycles (never null).
          items:
            $ref: '#/components/schemas/CycleResponse'
          type:
            - array
            - 'null'
        nextCursor:
          description: Opaque cursor for the next page; empty when exhausted.
          type: string
      required:
        - items
        - hasMore
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    CycleResponse:
      additionalProperties: false
      properties:
        closedAt:
          description: Close instant; omitted until closed.
          format: date-time
          type: string
        createdAt:
          description: Row creation instant (list cursor key).
          format: date-time
          type: string
        id:
          description: Cycle id.
          format: uuid
          type: string
        movementDate:
          description: Business (reference) date, YYYY-MM-DD.
          type: string
        netPosition:
          $ref: '#/components/schemas/NetPosition'
          description: >-
            The FI's net position, from the single correlated instruction;
            omitted for a pre-intake OPEN cycle.
        openedAt:
          description: PAG0102 open instant (DtHrAbert).
          format: date-time
          type: string
        periodCode:
          description: Operating-period token (e.g. 01, 02).
          type: string
        product:
          description: Rail product; always OT.
          type: string
        settledAt:
          description: Settlement instant; omitted until settled.
          format: date-time
          type: string
        status:
          description: Cycle lifecycle.
          enum:
            - OPEN
            - SETTLING
            - RECALCULATING
            - SETTLED
            - CLOSED
          type: string
      required:
        - id
        - product
        - movementDate
        - periodCode
        - status
        - openedAt
        - createdAt
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    NetPosition:
      additionalProperties: false
      properties:
        amount:
          description: Canonical net amount (NUMERIC(19,2)), decimal string.
          type: string
        side:
          description: Money direction of the FI's net obligation.
          enum:
            - DEBIT
            - CREDIT
          type: string
      required:
        - side
        - amount
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````