> ## 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.

# Account overview

> User's account overview including equity, margin, and PnL



## AsyncAPI

````yaml api-reference/asyncapi.json accountOverview
id: accountOverview
title: Account overview
description: User's account overview including equity, margin, and PnL
servers:
  - id: testnet
    protocol: wss
    host: api.testnet.aptoslabs.com/decibel/ws
    bindings: []
    variables: []
address: account_overview:{userAddr}
parameters:
  - id: userAddr
    jsonSchema:
      type: string
      description: User wallet address (Aptos address format, e.g. 0x123...)
    description: User wallet address (Aptos address format, e.g. 0x123...)
    type: string
    required: true
    deprecated: false
bindings: []
operations:
  - &ref_10
    id: receiveaccountOverview
    title: Receiveaccount overview
    description: >-
      Receive updates for user's account overview including equity, margin, and
      pnl
    type: receive
    messages:
      - &ref_11
        id: AccountOverviewMessage
        payload:
          - name: AccountOverviewMessage
            description: User's account overview including equity, margin, and PnL
            type: object
            properties:
              - name: account_overview
                type: object
                required: true
                properties:
                  - name: all_time_return
                    type: &ref_0
                      - number
                      - 'null'
                    required: false
                  - name: average_cash_position
                    type: &ref_1
                      - number
                      - 'null'
                    required: false
                  - name: average_leverage
                    type: &ref_2
                      - number
                      - 'null'
                    required: false
                  - name: cross_account_leverage_ratio
                    type: number
                    required: false
                  - name: cross_account_position
                    type: &ref_3
                      - number
                      - 'null'
                    required: false
                  - name: cross_margin_ratio
                    type: number
                    required: false
                  - name: maintenance_margin
                    type: number
                    required: false
                  - name: max_drawdown
                    type: &ref_4
                      - number
                      - 'null'
                    required: false
                  - name: perp_equity_balance
                    type: number
                    required: false
                  - name: pnl_90d
                    type: &ref_5
                      - number
                      - 'null'
                    required: false
                  - name: realized_pnl
                    type: &ref_6
                      - number
                      - 'null'
                    required: false
                  - name: sharpe_ratio
                    type: &ref_7
                      - number
                      - 'null'
                    required: false
                  - name: total_margin
                    type: number
                    required: false
                  - name: unrealized_funding_cost
                    type: number
                    required: false
                  - name: unrealized_pnl
                    type: number
                    required: false
                  - name: usdc_cross_withdrawable_balance
                    type: number
                    required: false
                  - name: usdc_isolated_withdrawable_balance
                    type: number
                    required: false
                  - name: volume
                    type: &ref_8
                      - number
                      - 'null'
                    required: false
                  - name: weekly_win_rate_12w
                    type: &ref_9
                      - number
                      - 'null'
                    required: false
              - name: topic
                type: string
                required: true
        headers: []
        jsonPayloadSchema:
          type: object
          required:
            - topic
            - account_overview
          properties:
            account_overview:
              type: object
              required:
                - perp_equity_balance
                - unrealized_pnl
                - unrealized_funding_cost
                - cross_margin_ratio
                - maintenance_margin
                - cross_account_leverage_ratio
                - total_margin
                - usdc_cross_withdrawable_balance
                - usdc_isolated_withdrawable_balance
              properties:
                all_time_return:
                  type: *ref_0
                  format: double
                  x-parser-schema-id: <anonymous-schema-162>
                average_cash_position:
                  type: *ref_1
                  format: double
                  x-parser-schema-id: <anonymous-schema-163>
                average_leverage:
                  type: *ref_2
                  format: double
                  x-parser-schema-id: <anonymous-schema-164>
                cross_account_leverage_ratio:
                  type: number
                  format: double
                  example: 40.99
                  x-parser-schema-id: <anonymous-schema-165>
                cross_account_position:
                  type: *ref_3
                  format: double
                  x-parser-schema-id: <anonymous-schema-166>
                cross_margin_ratio:
                  type: number
                  format: double
                  example: 0.01
                  x-parser-schema-id: <anonymous-schema-167>
                maintenance_margin:
                  type: number
                  format: double
                  example: 115.29
                  x-parser-schema-id: <anonymous-schema-168>
                max_drawdown:
                  type: *ref_4
                  format: double
                  x-parser-schema-id: <anonymous-schema-169>
                perp_equity_balance:
                  type: number
                  format: double
                  example: 10064.88
                  x-parser-schema-id: <anonymous-schema-170>
                pnl_90d:
                  type: *ref_5
                  format: double
                  x-parser-schema-id: <anonymous-schema-171>
                realized_pnl:
                  type: *ref_6
                  format: double
                  example: 1250.5
                  x-parser-schema-id: <anonymous-schema-172>
                sharpe_ratio:
                  type: *ref_7
                  format: double
                  x-parser-schema-id: <anonymous-schema-173>
                total_margin:
                  type: number
                  format: double
                  example: 9998.72
                  x-parser-schema-id: <anonymous-schema-174>
                unrealized_funding_cost:
                  type: number
                  format: double
                  example: -87.84
                  x-parser-schema-id: <anonymous-schema-175>
                unrealized_pnl:
                  type: number
                  format: double
                  example: 154
                  x-parser-schema-id: <anonymous-schema-176>
                usdc_cross_withdrawable_balance:
                  type: number
                  format: double
                  example: 9843.79
                  x-parser-schema-id: <anonymous-schema-177>
                usdc_isolated_withdrawable_balance:
                  type: number
                  format: double
                  example: 0
                  x-parser-schema-id: <anonymous-schema-178>
                volume:
                  type: *ref_8
                  format: double
                  x-parser-schema-id: <anonymous-schema-179>
                weekly_win_rate_12w:
                  type: *ref_9
                  format: double
                  x-parser-schema-id: <anonymous-schema-180>
              x-parser-schema-id: AccountOverviewDto
            topic:
              type: string
              x-parser-schema-id: <anonymous-schema-181>
          x-parser-schema-id: AccountOverviewResponse
        title: Account overview message
        description: User's account overview including equity, margin, and PnL
        example: |-
          {
            "topic": "account_overview:0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
            "account_overview": {
              "perp_equity_balance": 50250.75,
              "unrealized_pnl": 1250.5,
              "realized_pnl": 0,
              "unrealized_funding_cost": -125.25,
              "cross_margin_ratio": 0.15,
              "maintenance_margin": 2500,
              "cross_account_leverage_ratio": 500,
              "volume": 125000,
              "all_time_return": 0.25,
              "pnl_90d": 5000,
              "sharpe_ratio": 1.8,
              "max_drawdown": -0.08,
              "weekly_win_rate_12w": 0.65,
              "average_cash_position": 45000,
              "average_leverage": 5.5,
              "cross_account_position": 25000,
              "total_margin": 10000,
              "usdc_cross_withdrawable_balance": 7500,
              "usdc_isolated_withdrawable_balance": 2500
            }
          }
        bindings: []
        extensions:
          - id: x-parser-unique-object-id
            value: AccountOverviewMessage
          - id: x-parser-message-name
            value: AccountOverviewMessage
    bindings: []
    extensions:
      - id: x-parser-unique-object-id
        value: accountOverview
sendOperations:
  - *ref_10
receiveOperations: []
sendMessages:
  - *ref_11
receiveMessages: []
extensions:
  - id: x-parser-unique-object-id
    value: accountOverview
securitySchemes: []

````