account_summary

Send POST request to /info with method: “account_summary”

POST /info

cURL

curl --request POST \
  --url https://api.hotstuff.trade/info \
  --header 'Content-Type: application/json' \
  --data '{
    "method": "account_summary",
    "params": {
        "user": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
    }
}'

200

{
  "address": "0x42C183edba036906447372a7c81Eb89D0B9f2175",
  "margin_mode": "cross",
  "multi_asset_mode": false,
  "hedge_mode": false,
  "spot_collateral": {
    "USDC": {
      "balance": 2985.5150005,
      "withdrawable_balance": 2985.5150005
    },
    "USDT": {
      "balance": 2351.2922,
      "withdrawable_balance": 2351.2922
    }
  },
  "collateral": {
    "USDC": {
      "balance": 722.080604,
      "withdrawable_balance": 717.699421
    }
  },
  "vault_balances": {
    "0xdE66c594AF8e4AD2C62DcFadCb6714F8b176A4ef": {
      "withdrawable_shares": 0.000002,
      "total_shares": 0.000002,
      "amount": 1.3209
    }
  },
  "staked_collateral": 0,
  "perp_positions": {
    "BTC-PERP": {
      "position_type": "oneWay",
      "legs": [
        {
          "instrument_id": 1,
          "instrument_name": "BTC-PERP",
          "side": "BOTH",
          "size": 0.00282,
          "entry_price": 76740.5,
          "leverage": {
            "type": "isolated",
            "value": 50
          },
          "position_value": 216.40821
        }
      ],
      "liquidation_price": 75973,
      "mm": 2.217101,
      "im": 4.381183,
      "upnl": -0.71487
    }
  },
  "initial_margin_utilization": 0.006067,
  "maintenance_margin_utilization": 0.00307,
  "upnl": -0.71487,
  "total_account_equity": 6057.39466341,
  "margin_balance": 722.080604,
  "initial_margin": 4.381183,
  "maintenance_margin": 2.217101,
  "total_volume": 21901045,
  "total_pnl": 50287.895644,
  "available_balance": 717.699421,
  "transfer_margin_req": 4.381183,
  "max_drawdown": 0.417427,
  "spot_account_equity": 5335.31405941,
  "derivative_account_equity": 722.080604,
  "spot_volume": 2968
}

Retrieve comprehensive account summary including positions, balances, margin information, and account equity for a user.

cURL

curl --request POST \
  --url https://api.hotstuff.trade/info \
  --header 'Content-Type: application/json' \
  --data '{
    "method": "account_summary",
    "params": {
        "user": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
    }
}'

Body

application/json

method · string · required

params · object · required

Show child attributes

Response

200

application/json

Successful response

address · string

margin_mode · string

multi_asset_mode · boolean

hedge_mode · boolean

spot_collateral · object

Show child attributes

collateral · object

Show child attributes

vault_balances · object

Show child attributes

staked_collateral · integer

perp_positions · object

Show child attributes

initial_margin_utilization · number

maintenance_margin_utilization · number

upnl · number

total_account_equity · number

margin_balance · number

initial_margin · number

maintenance_margin · number

total_volume · integer

total_pnl · number

available_balance · number

transfer_margin_req · number

max_drawdown · number

spot_account_equity · number

derivative_account_equity · number

spot_volume · integer