> ## 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 fund statistics

> Get a user's cumulative deposits and withdrawals by chain.

Get a user's cumulative deposits and withdrawals by chain.

> [!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

* `network` identifies the network. `deposit` and `withdraw` are cumulative amounts in USDT. Pass the required `x-perp-device-type` header.


## OpenAPI

````yaml openapi/dexbuilder-en.yaml GET /api/v4/dexbuilder/fund_stats
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/fund_stats:
    get:
      tags:
        - User
      summary: Get fund statistics
      description: Return the user's fund statistics.
      operationId: getDexBuilderFundStats
      parameters:
        - $ref: '#/components/parameters/SubUserWalletAddr'
        - $ref: '#/components/parameters/DeviceType'
      responses:
        '200':
          description: Query successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopePerpFundStats'
        '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
    DeviceType:
      name: x-perp-device-type
      in: header
      required: true
      description: >-
        DexBuilder device type: 1 Android, 2 iOS, 3 WEB. A missing or invalid
        value returns INVALID_DEVICE_TYPE. Required only on the platform
        endpoints that specify this header.
      schema:
        type: string
        enum:
          - '1'
          - '2'
          - '3'
      example: '3'
  schemas:
    EnvelopePerpFundStats:
      allOf:
        - $ref: '#/components/schemas/EnvelopeBase'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/PerpQueryFundStatsResponse'
    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
    PerpQueryFundStatsResponse:
      type: object
      properties:
        list:
          type: array
          items:
            $ref: '#/components/schemas/PerpQueryFundStatItem'
    PerpQueryFundStatItem:
      type: object
      properties:
        deposit:
          type: string
          description: Cumulative deposit amount as a USDT decimal string
        withdraw:
          type: string
          description: Cumulative withdrawal amount as a USDT decimal string
        network:
          type: string
          description: 'Network identifier: base, bsc, ethereum, solana, or arbitrum.'
  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.