clearinghouseState

post

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

/info

Request clearinghouse state.

Body

application/json

Request clearinghouse state.

typeundefined · enumRequired

Type of request.

Possible values:

userstring · min: 42 · max: 42Required

User address.

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

dexstringOptional

DEX name (empty string for main dex).

Responses

200

Account summary for perpetual trading.

application/json

Account summary for perpetual trading.

crossMaintenanceMarginUsedstringRequired

Maintenance margin used for cross-margin positions.

Pattern: ^[0-9]+(\.[0-9]+)?$

withdrawablestringRequired

Amount available for withdrawal.

Pattern: ^[0-9]+(\.[0-9]+)?$

timenumberRequired

Timestamp when data was retrieved (in ms since epoch).

422

Failed to deserialize the JSON body into the target type

text/plain

500

Internal Server Error

application/json

post

/info

TypeScript

import * as hl from "@nktkas/hyperliquid";

const transport = new hl.HttpTransport(); // or `WebSocketTransport`
const client = new hl.InfoClient({ transport });

const data = await client.clearinghouseState({ user: "0x..." });

{
  "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
}