Hyperliquid Get Account
Get Hyperliquid perpetual account summary including positions, open orders, and margin status. Returns account value, active positions with PnL, and all resting orders. Ideal for: portfolio monitoring, risk assessment, and pre-trade checks.
Catalog action Hyperliquid wallet
Get Hyperliquid perpetual account summary including positions, open orders, and margin status. Returns account value, active positions with PnL, and all resting orders. Ideal for: portfolio monitoring, risk assessment, and pre-trade checks.
At a Glance
| Field | Value |
|---|---|
| Action ID | hyperliquid-get-account |
| Category | Hyperliquid |
| Connector | wallet |
| Requires gas | No |
| Funds movement | None declared |
| Tags | hyperliquid, perps, positions, portfolio, balance |
Payload Schema
| Field | Type | Required | Description |
|---|---|---|---|
dex | string | No | HIP-3 DEX name for TradFi markets. Omit for standard crypto perps. xyz = trade.xyz (stocks, indices, commodities), flx = flx.finance, vntl = vntl.exchange |
Result Schema
| Field | Type | Required | Description |
|---|---|---|---|
accountValue | string | Yes | Total account value in USD |
totalMarginUsed | string | No | Total margin currently in use |
totalPositionValue | string | No | Total notional value of all positions |
availableBalance | string | No | Available balance for new positions |
positions | array | Yes | Active perpetual positions |
openOrders | array | Yes | Open orders on the book |
Examples
json{ "type": "hyperliquid-get-account", "payload": { "dex": "xyz" }, "children": [], "connector": { "type": "wallet", "id": "conn_wallet" }}
bashcurl -X POST "https://api.b3os.org/v1/actions/hyperliquid-get-account/test" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "inputs": { "dex": "xyz" }}'
Payload fields can use workflow expressions such as {{$trigger.body.amount}}, {{$nodes.fetch.result.price}}, and {{$props.asset}} when the value should come from a trigger, prior node, or reusable workflow prop.