info
endpoint with type: "subAccounts"
retrieves information about all sub-accounts associated with a master account on the Hyperliquid exchange. This endpoint provides comprehensive data about sub-account configurations, balances, positions, and trading activity for advanced account management and portfolio segregation.
type
(string, required) — The request type. Must be "subAccounts"
to retrieve sub-accounts associated with a user.user
(string, required) — Address in 42-character hexadecimal format of the master account (e.g., 0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036
).subAccountUser
(string) — Address of the sub-account in 42-character hexadecimal formatname
(string) — Human-readable name assigned to the sub-account for identificationmaster
(string) — Address of the master account (matches the requested user)clearinghouseState
(object) — Current perpetuals trading state of the sub-account:
marginSummary
(object) — Overall margin information:
accountValue
(string) — Total account value including unrealized profit and losstotalNtlPos
(string) — Total notional position valuetotalRawUsd
(string) — Total raw USD value in the accounttotalMarginUsed
(string) — Total margin currently allocated to open positionscrossMarginSummary
(object) — Cross-margin specific information:
accountValue
(string) — Account value for cross-margin calculationstotalNtlPos
(string) — Total notional position value for cross-margintotalRawUsd
(string) — Total raw USD for cross-margintotalMarginUsed
(string) — Total margin used in cross-margin modecrossMaintenanceMarginUsed
(string) — Cross maintenance margin currently in usewithdrawable
(string) — Amount available for withdrawalassetPositions
(array) — Array of current perpetuals positions (empty if no positions)time
(integer) — Timestamp of the state snapshot in millisecondsspotState
(object) — Current spot trading state of the sub-account:
balances
(array) — Array of spot token balances:
coin
(string) — Token symbol (e.g., “USDC”)token
(integer) — Token index identifiertotal
(string) — Total balance including held amountshold
(string) — Amount currently on hold (locked in orders)entryNtl
(string) — Entry notional value for cost basis trackinginfo
endpoint with type: "subAccounts"
is essential for applications that need to:
List of sub-accounts associated with the user
List of sub-account details and their configurations