Skip to main content

Leader Assets

The /leader/assets/:leaderID endpoint returns a snapshot of a leader’s wallet balances and active positions. It includes margin allocations, USD valuations, and current prices.

All monetary values are expressed in USD unless otherwise stated. upnl and total_margin are in USDT.

Method​

GET /leader/assets/:leaderID

  • :leaderID — the unique identifier of the leader whose asset data is to be fetched.

Response​

{
  "status": 200,
  "data": {
    "total_margin": "44.396779",
    "assets": [
      {
        "symbol": "USDT",
        "amount": "33.867212",
        "margin": "33.867212",
        "usd_value": "33.867212",
        "curr_price": "1",
        "icon": "https://static.bitmex.com/icons/dark/usdt.svg"
      },
      {
        "symbol": "XBT",
        "amount": "0.0000178",
        "margin": "0.00000157",
        "usd_value": "0.1604383",
        "curr_price": "102190",
        "icon": "https://static.bitmex.com/icons/dark/xbt.svg"
      },
      {
        "symbol": "SOL",
        "amount": "0.060010006",
        "margin": "0.060010006",
        "usd_value": "10.36912893674",
        "curr_price": "172.79",
        "icon": "https://static.bitmex.com/icons/dark/sol.svg"
      }
    ],
    "positions": [
      {
        "symbol": "XBTUSD",
        "entry_price": "103944.7",
        "mark_price": "102220.7",
        "amount": "0.0009785693316371",
        "usd_value": "99.999999999995249",
        "upnl": "-0.0158821802524709",
        "real_qty": "100",
        "icon": "https://static.bitmex.com/icons/dark/xbt.svg",
        "root_symbol": "XBT",
        "is_low_liquid": false
      }
    ]
  }
}

Fields Explained​

total_margin​

Total margin in USDT across all assets.

assets (array)​

List of wallet assets.

  • symbol: Asset ticker (e.g., USDT, XBT).
  • amount: Total balance of the asset (in base units).
  • margin: Portion of the asset used as margin (in base units).
  • usd_value: Value of the asset in USD.
  • curr_price: Current USD price of the asset.
  • icon: URL to the asset’s icon.

positions (array)​

List of open derivative positions.

  • symbol: Market symbol (e.g., XBTUSD).
  • entry_price: Position entry price.
  • mark_price: Current mark price of the position.
  • amount: Position size in root symbol-equivalent.
  • usd_value: Notional USD value of the position.
  • upnl: Unrealized PnL in USDT.
  • real_qty: Position size in contract units.
  • icon: URL to the asset’s icon.
  • root_symbol: Root symbol of the position instrument (e.g., XBT).
  • is_low_liquid: Indicates if the position is in a low liquidity market.