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

# List TWAP orders

> List TWAP orders.

 List TWAP parent orders for the authenticated user with pagination and
 optional filtering by state and trading pair.



## OpenAPI

````yaml /proto-openapi/api/openapi.yaml get /api/v1/orders/twap
openapi: 3.0.3
info:
  title: Monaco Protocol API
  description: REST API for the Monaco Protocol hybrid CLOB exchange.
  version: 1.0.0
servers:
  - url: https://staging.apimonaco.xyz
    description: Staging server (Testnet)
security: []
tags:
  - name: AccountsService
  - name: ApplicationsService
  - name: AuthService
  - name: BuildercodeRewardsService
  - name: CopyTradingService
  - name: DelegatedAgentsService
  - name: FaucetService
  - name: FeesService
  - name: HealthService
  - name: ManagedMarketsService
    description: |-
      Wallet-authenticated maker assignments. The signed session must match both
       configured maker user and application. Owner IDs are process fences, never auth.
       Only wallet sessions are supported; delegated-agent sessions receive 403.
  - name: MarginAccountsService
    description: |-
      Current public isolated-margin semantics:
       - a user has one parent margin account per application scope
       - opening orders create or reuse isolated position buckets under that parent
       - parent account creation is handled internally by margin workflows
  - name: MarketService
  - name: OrderbookService
  - name: OrdersService
  - name: PositionsService
    description: |-
      Current public isolated-margin semantics:
       - positions link to a parent margin account and, when applicable, a bucket id
       - opening orders create or reuse isolated position buckets under the parent
       - users can open another isolated position by reusing the parent account with a different market bucket
  - name: PulseService
  - name: SweeperService
  - name: TraderCodeService
  - name: TradesService
  - name: WhitelistService
  - name: WithdrawalsService
paths:
  /api/v1/orders/twap:
    get:
      tags:
        - OrdersService
        - Orders
      summary: List TWAP orders
      description: |-
        List TWAP orders.

         List TWAP parent orders for the authenticated user with pagination and
         optional filtering by state and trading pair.
      operationId: list_twap_orders
      parameters:
        - name: pageSize
          in: query
          schema:
            type: integer
            format: uint32
            minimum: 1
            maximum: 1000
            default: 20
          description: >-
            Items per page (max 100 in page-number mode; up to 1000 when
            pageToken is present)
        - name: state
          in: query
          schema:
            type: string
        - name: tradingPairId
          in: query
          schema:
            type: string
            minLength: 1
            format: uuid
          description: Trading pair identifier (UUID)
        - name: pageToken
          in: query
          description: |-
            Pagination cursor with two states:
              - Omitted or empty string (""): start a cursor walk with no prior
                position, from the newest TWAP parent.
              - Non-empty: an opaque cursor from a previous response's
                `next_page_token`; results resume immediately after that position.

             `total` is the matching row count, bounded at a server ceiling of 10,000
             and saturating there. Pages are keyset seeks on `(createdAt, id)`, so a
             page size up to 1000 is allowed. Filters must match the request that
             produced the token; a token replayed against different filters is
             rejected.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTwapOrdersResponse'
        '400':
          description: Invalid query parameters
        '401':
          description: Authentication required
        '429':
          description: >-
            Read rate limit exceeded — every authenticated read draws one
            request from the account's read budget; retry after the interval in
            details.retryAfter
        '500':
          description: Internal server error
      security:
        - monacoSignature: []
        - monacoHttpSignature: []
components:
  schemas:
    ListTwapOrdersResponse:
      type: object
      properties:
        orders:
          type: array
          items:
            $ref: '#/components/schemas/TwapOrder'
          nullable: true
        total:
          example: 3
          type: integer
          description: >-
            Matching TWAP orders, counted up to a server ceiling of 10,000 and
            saturating there, so a caller with more than that reads the cap
            rather than a lifetime total.
          format: uint32
          nullable: true
        pageSize:
          example: 20
          type: integer
          description: Items per page
          format: uint32
          nullable: true
        nextPageToken:
          type: string
          description: >-
            Cursor for the next page, minted only when a further page exists —
            the
             read over-fetches one row to decide, so there is no "maybe more" state.
             Empty on the final page (including a full final page, since nothing
             follows it).
             Follow it until it comes back empty; that empty token is the definitive
             end of the walk, so no extra zero-row request is needed. Do not feed the
             empty token back as `page_token` — an empty input `page_token` restarts
             the walk from the newest row.
          nullable: true
    TwapOrder:
      type: object
      properties:
        twapOrderId:
          type: string
          description: TWAP parent order UUID
          format: uuid
          nullable: true
        tradingPairId:
          type: string
          description: Trading pair UUID
          format: uuid
          nullable: true
        side:
          example: BUY
          type: string
          description: 'Order side: BUY or SELL'
          nullable: true
        tradingMode:
          example: SPOT
          type: string
          description: 'Trading mode: SPOT or MARGIN'
          nullable: true
        totalQuantity:
          example: '10'
          type: string
          description: Total quantity requested
          nullable: true
        executedQuantity:
          example: '4.5'
          type: string
          description: Quantity executed so far across all child orders
          nullable: true
        executedNotional:
          example: '157500.00'
          type: string
          description: Notional (quote) value executed so far
          nullable: true
        averageFillPrice:
          example: '35000.00'
          type: string
          description: >-
            Volume-weighted average fill price (executedNotional /
            executedQuantity); absent until the first fill
          nullable: true
        progress:
          example: '0.45'
          type: string
          description: >-
            Execution progress as a decimal fraction (executedQuantity /
            totalQuantity, 0 to 1)
          nullable: true
        limitPrice:
          example: '35000.00'
          type: string
          description: >-
            Parent-level limit price; absent when only the slippage band
            protects child orders
          nullable: true
        slippageToleranceBps:
          example: 100
          type: integer
          description: Per-slice protective price band in basis points
          format: int32
          nullable: true
        reduceOnly:
          example: false
          type: boolean
          description: Whether the parent is reduce-only
          nullable: true
        marginAccountId:
          type: string
          description: Margin account UUID for margin TWAP orders
          format: uuid
          nullable: true
        riskBucketId:
          type: string
          description: Isolated risk bucket UUID for risk-bucket-scoped margin TWAP orders
          format: uuid
          nullable: true
        leverage:
          example: '5'
          type: string
          description: Leverage for margin TWAP orders
          nullable: true
        useMasterBalance:
          example: false
          type: boolean
          description: Whether child orders use the master account balance
          nullable: true
        strategyKey:
          type: string
          description: Strategy key used to group risk buckets
          nullable: true
        clientTwapId:
          type: string
          description: Client-assigned idempotency key
          nullable: true
        randomize:
          example: true
          type: boolean
          description: Whether seeded size/timing randomization is applied to the schedule
          nullable: true
        startTime:
          example: '2026-08-01T10:00:00Z'
          type: string
          description: Window start (ISO 8601)
          nullable: true
        endTime:
          example: '2026-08-01T11:00:00Z'
          type: string
          description: Window end (ISO 8601). Execution stops hard at this time.
          nullable: true
        intervalMs:
          example: 30000
          type: integer
          description: Derived base slice interval in milliseconds (stored for audit)
          format: int64
          nullable: true
        plannedSlices:
          example: 120
          type: integer
          description: Number of slices in the planned schedule
          format: int32
          nullable: true
        slicesPlaced:
          example: 54
          type: integer
          description: Number of child orders placed so far
          format: int32
          nullable: true
        slicesSkipped:
          example: 2
          type: integer
          description: >-
            Number of slices skipped or failed so far (limit price through the
            market, self-trade prevention, halted market, failed admission).
            Skips never terminate the parent; the deficit flows into catch-up.
          format: int32
          nullable: true
        nextSliceAt:
          example: '2026-08-01T10:27:30Z'
          type: string
          description: >-
            Planned time of the next slice (ISO 8601); absent once the parent is
            terminal
          nullable: true
        state:
          example: ACTIVE
          type: string
          description: 'Parent state: PENDING, ACTIVE, COMPLETED, or CANCELLED'
          nullable: true
        terminalReason:
          type: string
          description: >-
            Terminal cause detail, e.g. an end-of-window shortfall ('ended with
            shortfall <qty>'); absent for non-terminal parents
          nullable: true
        createdAt:
          example: '2026-08-01T09:59:58Z'
          type: string
          description: Creation timestamp (ISO 8601)
          nullable: true
        updatedAt:
          type: string
          description: Last update timestamp (ISO 8601)
          nullable: true
        cancelledAt:
          type: string
          description: Cancellation timestamp (ISO 8601)
          nullable: true
        completedAt:
          type: string
          description: Completion timestamp (ISO 8601)
          nullable: true
        executionStyle:
          example: TAKER
          type: string
          description: >-
            Child execution style: TAKER (banded MARKET slices) or PASSIVE
            (post-only children at the touch with a taker sweep at each slice
            deadline)
          nullable: true
        triggerPrice:
          type: string
          description: Price-triggered activation level, when this parent is conditional
          nullable: true
        triggerDirection:
          type: string
          description: 'Trigger crossing direction: ABOVE or BELOW'
          nullable: true
        conditionalExpiry:
          type: string
          description: >-
            Deadline for the trigger to fire (ISO 8601 UTC); reaching it cancels
            the parent with terminal reason 'trigger expired'
          nullable: true
        triggeredAt:
          type: string
          description: >-
            When the trigger fired and the floating window started (ISO 8601
            UTC); unset while waiting
          nullable: true
  securitySchemes:
    monacoSignature:
      type: apiKey
      description: >-
        Ed25519 session-key request signing. Every authenticated request carries
        three headers: `X-Monaco-PublicKey` (64-char lowercase-hex session
        public key), `X-Monaco-Timestamp` (Unix milliseconds, within 30s of
        server time), and `X-Monaco-Signature` (hex ed25519 signature). The
        signature is over `METHOD\npath?query\ntimestamp_ms\nSHA256_hex(body)`,
        where the body hash is the SHA-256 of the empty byte string when there
        is no body. Obtain the session keypair from `POST
        /api/v1/auth/challenge` followed by `POST /api/v1/auth/verify`.
      name: X-Monaco-Signature
      in: header
    monacoHttpSignature:
      type: apiKey
      description: >-
        RFC 9421 Ed25519 session-key request signatures. Send Signature-Input,
        Signature, and Content-Digest together; never combine them with
        X-Monaco-* credentials. The monaco signature covers @method, @path,
        @query, and content-digest in that order, with created (Unix seconds
        within 30s of server time), keyid (registered lowercase-hex session
        public key), and alg=ed25519 parameters. Content-Digest uses RFC 9530
        sha-256 over the exact body bytes, including the empty body. Query
        coverage retains ordering and percent encoding. Timestamp freshness does
        not reject repeated identical requests; use endpoint idempotency where
        supported. Existing legacy signing remains supported during server-first
        migration; SDK RFC 9421 signing is opt-in. See
        https://docs.0xmonaco.com/reference/http-message-signatures for the
        complete profile and trust model.
      name: Signature
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.