subAccounts

post

https://api.hyperliquid.xyzhttps://api.hyperliquid-testnet.xyz

/info

Request user sub-accounts.

Body

application/json

Request user sub-accounts.

typeundefined · enumRequired

Type of request.

Possible values:

userstring · min: 42 · max: 42Required

User address.

Pattern: ^0[xX][0-9a-fA-F]+$

Responses

200

Array of user sub-account or null if the user does not have any sub-accounts.

application/json

Responseany of

Array of user sub-account or null if the user does not have any sub-accounts.

422

Failed to deserialize the JSON body into the target type

text/plain

500

Internal Server Error

application/json

post

/info

HTTPcURLJavaScriptPython

POST /info HTTP/1.1
Host: api.hyperliquid.xyz
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "type": "subAccounts",
  "user": "text"
}

[
  {
    "name": "text",
    "subAccountUser": "text",
    "master": "text",
    "clearinghouseState": {
      "marginSummary": {
        "accountValue": "text",
        "totalNtlPos": "text",
        "totalRawUsd": "text",
        "totalMarginUsed": "text"
      },
      "crossMarginSummary": {
        "accountValue": "text",
        "totalNtlPos": "text",
        "totalRawUsd": "text",
        "totalMarginUsed": "text"
      },
      "crossMaintenanceMarginUsed": "text",
      "withdrawable": "text",
      "assetPositions": [
        {
          "type": "oneWay",
          "position": {
            "coin": "text",
            "szi": "text",
            "leverage": {
              "type": "isolated",
              "value": 1,
              "rawUsd": "text"
            },
            "entryPx": "text",
            "positionValue": "text",
            "unrealizedPnl": "text",
            "returnOnEquity": "text",
            "liquidationPx": "text",
            "marginUsed": "text",
            "maxLeverage": 1,
            "cumFunding": {
              "allTime": "text",
              "sinceOpen": "text",
              "sinceChange": "text"
            }
          }
        }
      ],
      "time": 1
    },
    "spotState": {
      "balances": [
        {
          "coin": "text",
          "token": 1,
          "total": "text",
          "hold": "text",
          "entryNtl": "text"
        }
      ],
      "evmEscrows": [
        {
          "coin": "text",
          "token": 1,
          "total": "text"
        }
      ]
    }
  }
]