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

# Get withdrawal queue entries for an account

> Returns all withdrawal queue entries for the specified account,
optionally filtered by status.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/withdraw_queue
openapi: 3.1.0
info:
  title: Decibel Trading API
  description: >-
    RESTful API for Decibel. Provides read-only endpoints for market data,
    trading operations, positions, and analytics.
  contact:
    name: Decibel Team
    url: https://decibel.trade/
  license:
    name: ''
  version: 1.0.0
servers:
  - url: https://api.mainnet.aptoslabs.com/decibel
    description: Mainnet
  - url: https://api.testnet.aptoslabs.com/decibel
    description: Testnet
security:
  - bearerAuth: []
tags:
  - name: Market Data
    description: Market information and real-time data endpoints
  - name: User
    description: User information and account management
  - name: Account
    description: Account-specific endpoints and data
  - name: Trades
    description: Trading operations and history
  - name: Positions
    description: User position management
  - name: Orders
    description: Order management and history
  - name: TWAP
    description: Time-weighted average price orders
  - name: Bulk Orders
    description: Bulk order management
  - name: Vaults
    description: Vault operations and management
  - name: Analytics
    description: Analytics and performance metrics
  - name: Points
    description: Points-related account metrics
  - name: Trading Points
    description: Trading points endpoints
  - name: Trading Hz
    description: Trading Hz endpoints
  - name: Tier
    description: Tier information endpoints
  - name: Streaks
    description: User streak tracking endpoints
  - name: Predeposit Rewards
    description: Season 0 predeposit USDC rewards
  - name: Referrals
    description: Referral code management and tracking
  - name: Affiliates
    description: Affiliate code and earnings endpoints
paths:
  /api/v1/withdraw_queue:
    get:
      tags:
        - User
      summary: Get withdrawal queue entries for an account
      description: |-
        Returns all withdrawal queue entries for the specified account,
        optionally filtered by status.
      operationId: handle_withdraw_queue
      parameters:
        - name: account
          in: query
          description: Account address
          required: true
          schema:
            type: string
        - name: status
          in: query
          description: Optional status filter (Queued, Processed, Cancelled)
          required: false
          schema:
            $ref: '#/components/schemas/WithdrawQueueStatus'
        - name: limit
          in: query
          description: Page size
          required: false
          schema:
            type: integer
            format: int32
            default: 10
            maximum: 200
            minimum: 0
          example: 100
        - name: offset
          in: query
          description: Page offset
          required: false
          schema:
            type: integer
            format: int32
            default: 0
            maximum: 10000
            minimum: 0
          example: 0
      responses:
        '200':
          description: Withdraw queue entries retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_WithdrawQueueEntryDto'
        '500':
          description: Database error
components:
  schemas:
    WithdrawQueueStatus:
      type: string
      enum:
        - Queued
        - Processed
        - Cancelled
    PaginatedResponse_WithdrawQueueEntryDto:
      type: object
      required:
        - items
      properties:
        items:
          type: array
          items:
            type: object
            description: >-
              A single withdrawal queue event (Queued, Processed, or Cancelled).


              The underlying table is an append-log: each state transition is a
              separate row keyed

              by `event_uid`. Unfiltered queries may return multiple rows for
              the same `request_id`

              (e.g., a Queued row and a Processed row). Clients should
              deduplicate by `request_id`,

              keeping the terminal state (Processed or Cancelled) over Queued.
            required:
              - user
              - fungible_amount
              - processed_amount
              - request_id
              - status
              - timestamp_ms
              - transaction_version
            properties:
              cancel_reason:
                oneOf:
                  - type: 'null'
                  - $ref: '#/components/schemas/WithdrawCancelReason'
                    description: >-
                      Reason the withdrawal was cancelled. Only present for
                      Cancelled entries.
              fungible_amount:
                type: number
                format: double
                description: >-
                  Requested withdrawal amount, normalized by collateral
                  decimals.
              market:
                type:
                  - string
                  - 'null'
                description: >-
                  The market address. Absent for non-market (cross-margin)
                  withdrawals.
              processed_amount:
                type: number
                format: double
                description: >-
                  Amount actually withdrawn. Equals `fungible_amount` for
                  Processed entries, 0 otherwise.
              queued_at_ms:
                type:
                  - integer
                  - 'null'
                format: int64
                description: >-
                  Timestamp when the withdrawal was originally queued. Always
                  present for Queued

                  entries. For Processed/Cancelled entries, enriched from the
                  corresponding Queued

                  row. HTTP responses enrich via same-page lookup + DB backfill;
                  WebSocket updates

                  only enrich from the same batch, so this may be absent.
              recipient:
                type:
                  - string
                  - 'null'
                description: >-
                  The intended recipient address. The on-chain CancelledEvent
                  omits this field,

                  so it is enriched from the corresponding Queued row. HTTP
                  responses enrich via

                  same-page lookup + DB backfill; WebSocket updates only enrich
                  from the same batch.
              request_id:
                type: string
              status:
                $ref: '#/components/schemas/WithdrawQueueStatus'
              timestamp_ms:
                type: integer
                format: int64
                description: >-
                  Timestamp of this specific event. For Processed entries this
                  is the settlement

                  time; for Cancelled entries the cancellation time. See
                  `queued_at_ms` for the

                  original queue time.
              transaction_version:
                type: integer
                format: int64
                minimum: 0
              user:
                type: string
          description: The items in the current page
        total_count:
          type:
            - integer
            - 'null'
          format: int32
          description: >-
            The total number of items across all pages.

            Optional: history endpoints omit this field to avoid expensive
            COUNT(*) queries.
          minimum: 0
    WithdrawCancelReason:
      oneOf:
        - type: string
          enum:
            - CancelledByUser
        - type: string
          enum:
            - InsufficientWithdrawableBalance
        - type: string
          enum:
            - DepositCheckFailed
        - type: object
          required:
            - Unknown
          properties:
            Unknown:
              type: string
      description: |-
        Cancel reason for a withdrawal request.

        Serializes as a flat string for all variants (including Unknown).
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer token from Geomi. See
        [Authentication](/api-reference/rest/authentication) for setup
        instructions.

````