Hyperliquid - Positions

Get Hyperliquid wallet account summary

Clearinghouse account summary of one wallet at the latest live snapshot: account value, margin used, and position totals. Billed at 1 credit per request.

get/v1/hyperliquid/wallets/{address}/account

Request

  • Base URL: https://api.0xarchive.io
  • URL: https://api.0xarchive.io/v1/hyperliquid/wallets/{address}/account
  • Auth: API key in header X-API-Key

Path parameters

addressstring required
Example:0x31ca8395cf837de08b24da3f660e77761dfb974b

Wallet address: 0x followed by 40 hex characters (case-insensitive).

Response

Get Hyperliquid wallet account summary

successboolean required

Example response

{
  "success": true,
  "data": [
    {
      "account_index": "513030",
      "dex": "xyz",
      "account_value": "125000.5",
      "cross_account_value": "118000.25",
      "collateral": "100000",
      "total_margin_used": "20500.75",
      "cross_maintenance_margin_used": "6100.2",
      "total_position_value": "412000.5",
      "total_unrealized_pnl": "2510.25",
      "long_value": "300000",
      "short_value": "112000.5",
      "n_positions": 4,
      "account_mode": "standard",
      "quality": "complete"
    }
  ],
  "meta": {
    "totals": {
      "symbol": "BTC",
      "coin": "BTC",
      "dex": "xyz",
      "long_count": 18234,
      "short_count": 15102,
      "long_size": "8123.45",
      "short_size": "8120.1",
      "long_value": "528000000.5",
      "short_value": "527800000.25",
      "long_avg_entry_price": "63120.4",
      "short_avg_entry_price": "66210.9",
      "long_positions_with_entry": 18230,
      "short_positions_with_entry": 15100,
      "long_top10_value_share": "0.412345",
      "short_top10_value_share": "0.385",
      "top10_value_share": "0.301",
      "quality": "complete"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.