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

# Get withdrawal history

> List a user's withdrawal records.

List a user's withdrawal records.

> [!NOTE]
>
> Use a Broker API Key and pass the target user's wallet in X-User-Wallet-Address. The gateway checks that the wallet belongs to your Broker. See [Broker API Key and signing](https://dexbuilder.mintlify.site/en/api-reference/common/broker-authentication.md).

## Usage notes

* Current history records do not contain creation or update timestamps. Record the submission time in your own system if you need a timeline.


## OpenAPI

````yaml openapi/dexbuilder-en.yaml GET /api/v4/dexbuilder/withdraw/history
openapi: 3.0.3
info:
  title: DexBuilder Platform Broker API
  version: 1.0.0
  description: >-
    DexBuilder Platform Broker API for asset configuration, user queries,
    deposits, and withdrawals. See the shared gateway documentation for
    authentication and wallet verification.
servers:
  - url: https://api.dexbuilder.com
security: []
paths:
  /api/v4/dexbuilder/withdraw/history:
    get:
      tags:
        - Withdrawal
      summary: Get withdrawal history
      operationId: listDexBuilderWithdrawHistory
      parameters:
        - $ref: '#/components/parameters/SubUserWalletAddr'
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/PageSize'
      responses:
        '200':
          description: Query successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeWithdrawHistory'
        '400':
          $ref: '#/components/responses/OpenAPIBadRequest'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          $ref: '#/components/responses/GatewayUnauthorized'
        '403':
          $ref: '#/components/responses/ProjectAccessDenied'
      security:
        - BrokerAPIKey: []
          Timestamp: []
          Signature: []
components:
  parameters:
    SubUserWalletAddr:
      name: X-User-Wallet-Address
      in: header
      required: true
      description: >-
        Target user's wallet address. The gateway verifies that the user belongs
        to the current Broker.
      schema:
        type: string
    Page:
      name: page
      in: query
      schema:
        type: integer
        minimum: 1
        default: 1
      description: Page number, starting at 1
    PageSize:
      name: page_size
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      description: Number of records per page, maximum 100
  schemas:
    EnvelopeWithdrawHistory:
      allOf:
        - $ref: '#/components/schemas/EnvelopeBase'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/WithdrawHistoryPage'
    ErrorEnvelope:
      allOf:
        - $ref: '#/components/schemas/EnvelopeBase'
        - type: object
          required:
            - label
          properties:
            label:
              type: string
              description: Stable machine-readable error label
            data:
              nullable: true
              description: Usually null on error
    EnvelopeBase:
      type: object
      properties:
        code:
          type: integer
          example: 0
          description: Business code; 0 indicates success
        message:
          type: string
          example: success
          description: Human-readable message; success responses use success
        reason:
          type: string
          description: Error reason identifier; usually empty on success
        trace_id:
          type: string
          description: Trace ID to provide when requesting support
    WithdrawHistoryPage:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/WithdrawHistoryItem'
        page:
          type: integer
          description: Current page number
        page_size:
          type: integer
          description: Page size
        total:
          type: integer
          format: int64
          description: Total matching records, not just the current page
    WithdrawHistoryItem:
      type: object
      properties:
        event_id:
          type: string
          description: Withdrawal event UUID
        tx_hash:
          type: string
          description: Onchain transaction hash; empty before submission onchain
        status:
          type: integer
          description: >-
            0 not found; 10 pending withdrawal; 11 confirming; 20 successful; 30
            failed
        amount:
          type: string
          description: Withdrawal amount as a decimal string in token units
        asset:
          type: string
          description: Asset symbol
        network:
          type: string
          description: Network identifier
  responses:
    OpenAPIBadRequest:
      description: 'Invalid request: parameters, body, user identity, or business validation'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            invalidArgument:
              summary: Invalid parameter
              value:
                label: INVALID_ARGUMENT
                message: invalid argument
            userNotFound:
              summary: User not found
              value:
                label: USER_NOT_FOUND
                message: User not found
            missingHeader:
              summary: Missing required header
              value:
                label: MISSING_REQUIRED_HEADER
                message: invalid headers
    GatewayUnauthorized:
      description: Invalid Broker API Key, signature, or timestamp
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            invalidKey:
              summary: Invalid API Key
              value:
                label: INVALID_KEY
                message: Invalid key provided
                code: 401
                trace_id: abc123
            invalidSignature:
              summary: Invalid signature
              value:
                label: INVALID_SIGNATURE
                message: Invalid signature
                code: 401
                trace_id: abc123
    ProjectAccessDenied:
      description: Project not bound, or Broker and API Key do not match
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            code: 40300801
            reason: P_DEX_BUILDER_IN_PROJECT_ACCESS_DENIED
            label: PROJECT_ACCESS_DENIED
            message: project access denied
            data: null
  securitySchemes:
    BrokerAPIKey:
      type: apiKey
      in: header
      name: KEY
      description: Broker API Key
    Timestamp:
      type: apiKey
      in: header
      name: Timestamp
      description: Unix timestamp in seconds
    Signature:
      type: apiKey
      in: header
      name: SIGN
      description: Hexadecimal HMAC-SHA512 signature generated with the Broker Secret Key

````

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