portfolioState

Get clearinghouse state, spot clearinghouse state, and account abstraction mode for a single user in one request.

Get clearinghouse state, spot clearinghouse state, and account abstraction mode for a single user in one request.

New endpoint - this endpoint is not a part of original Hyperliquid API and is added by us for builder convenience.

POST Request

Field	Type	Description
type	string	Must be "portfolioState"
user	string	Ethereum address (0x-prefixed, 42 characters)
dex	string	(Optional) Perp DEX name. Omit for native DEX (default). Use "ALL_DEXES" to fetch clearinghouse state across all dexes (native + all HIP-3 dexes) in one request.

Usage

This endpoint combines three calls into one:

• clearinghouseState - perp positions and margin

• spotClearinghouseState - spot balances

• userAbstraction - account abstraction mode

cURL

curl -X POST https://api.hydromancer.xyz/info \
  -H "Authorization: Bearer $HYDROMANCER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "portfolioState",
    "user": "0x0000000000000000000000000000000000000000"
  }'

Python

Javascript

---

Response Fields

Field	Type	Description
clearinghouseState	object	Perp clearinghouse state (marginSummary, crossMarginSummary, assetPositions, time)
spotClearinghouseState	object	Spot clearinghouse state containing balances array
spotClearinghouseState.balances[n].coin	string	Coin symbol
spotClearinghouseState.balances[n].token	int	Token index
spotClearinghouseState.balances[n].total	string	Total balance
spotClearinghouseState.balances[n].hold	string	Amount on hold
spotClearinghouseState.balances[n].entryNtl	string	Entry notional
userAbstraction	string	Account abstraction mode (see values below)

Response

{
  "clearinghouseState": {
    "marginSummary": {..},
    "crossMarginSummary": {..},
    "assetPositions": [..],
    "time": 1234567890123
  },
  "spotClearinghouseState": {
    "balances": [
      {
        "coin": "USDC",
        "token": 0,
        "total": "0.02221591",
        "hold": "0.0",
        "entryNtl": "0.0"
      }
    ]
  },
  "userAbstraction": "unifiedAccount"
}

Response ALL_DEXES

{
  "clearinghouseState": {
    "native": {
      "marginSummary": {..},
      "crossMarginSummary": {..},
      "assetPositions": [..],
      "time": 1234567890123
    },
    "xyz": {
      "marginSummary": {..},
      "crossMarginSummary": {..},
      "assetPositions": [..],
      "time": 1234567890123
    }
  },
  "spotClearinghouseState": {
    "balances": [
      {
        "coin": "USDC",
        "token": 0,
        "total": "0.02221591",
        "hold": "0.0",
        "entryNtl": "0.0"
      }
    ]
  },
  "userAbstraction": "unifiedAccount"
}

userAbstraction values

The user's account abstraction mode. Possible values:

Value	Description
"unifiedAccount"	Unified account mode - single balance per asset across all DEXes, all cross margin positions share collateral
"portfolioMargin"	Portfolio margin mode - single portfolio unifying eligible assets with borrowing/LTV
"disabled"	Abstraction disabled - separate perp and spot balances
"default"	Default mode
"dexAbstraction"	DEX abstraction mode (legacy, being discontinued)