Skip to main content
POST
/
info
subAccounts
curl --request POST \
  --url https://hypercore.goldrushdata.com/info \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "user": "<string>"
}
'
{
  "name": "<string>",
  "subAccountUser": "<string>",
  "master": "<string>",
  "clearinghouseState": {},
  "spotState": {}
}

Documentation Index

Fetch the complete documentation index at: https://goldrush.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Credit Cost

1 per call

Processing

Realtime
  • Wire-equal to POST api.hyperliquid.xyz/info with {"type": "subAccounts", "user": "..."}.
  • For per-sub-account real-time updates, subscribe to walletTxs on each subAccountUser returned here.
  • For multi-wallet polling without traversing master/sub-account hierarchy, see batchClearinghouseState and batchSpotClearinghouseState.
Returns the sub-accounts owned by a master wallet, with each sub-account’s perp clearinghouseState and spot spotClearinghouseState inlined per slot - so a single call returns the full balance picture across the master plus its sub-accounts. User-keyed. The result is null for wallets that aren’t master accounts.

​
Endpoint

POST https://hypercore.goldrushdata.com/info
Authorization: Bearer <GOLDRUSH_API_KEY>
Content-Type: application/json

​
Request

​
type
string
required
Always "subAccounts".
​
user
string
required
The master wallet address (lowercase 0x-prefixed hex).

​
Example

curl -X POST https://hypercore.goldrushdata.com/info \
  -H "Authorization: Bearer $GOLDRUSH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "subAccounts",
    "user": "0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036"
  }'

​
Response

An array of sub-account objects, or null if the queried wallet is not a master account. 
[
  {
    "name": "trading-bot-1",
    "subAccountUser": "0x2b804617c6f63c040377e95bb276811747006f4b",
    "master": "0x2ba553d9f990a3b66b03b2dc0d030dfc1c061036",
    "clearinghouseState": {
      "marginSummary": {
        "accountValue": "5000.00",
        "totalNtlPos": "0.0",
        "totalRawUsd": "5000.00",
        "totalMarginUsed": "0.0"
      },
      "crossMarginSummary": {
        "accountValue": "5000.00",
        "totalNtlPos": "0.0",
        "totalRawUsd": "5000.00",
        "totalMarginUsed": "0.0"
      },
      "crossMaintenanceMarginUsed": "0.0",
      "withdrawable": "5000.00",
      "assetPositions": [],
      "time": 1735689600000
    },
    "spotState": {
      "balances": [
        { "coin": "USDC", "token": 0, "hold": "0.0", "total": "1000.00", "entryNtl": "1000.00" }
      ]
    }
  }
]

​
Field descriptions

​
name
string
Optional human-readable label assigned to the sub-account.
​
subAccountUser
string
The sub-account’s wallet address (0x-prefixed hex).
​
master
string
The master wallet address that owns this sub-account.
​
clearinghouseState
object
Perp account state for this sub-account. Identical shape to the single-wallet clearinghouseState response - margin summaries, asset positions, withdrawable balance, snapshot timestamp.
​
spotState
object
Spot account state for this sub-account. Identical shape to the single-wallet spotClearinghouseState response - per-token balances and the optional tokenToAvailableAfterMaintenance array.