Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

userFundings

Private funding settlement update (Hyperliquid-compatible). Historical settlements are userFundings.

ChanneluserFundingsserver → client · type userFundings

Append funding settlements to Funding History as they happen.

Subscribe
{
  "method": "subscribe",
  "type": "userFundings",
  "subscription": {
    "type": "userFundings",
    "user": "0x0000000000000000000000000000000000000000"
  }
}
Try it
WS wss://rpc.txflow-testnet.xyz/ws
Subscription parameters
typestringrequired
"userFundings"
userstringrequired

User to follow. Use the account address, not an agent's.

exchangeIdExchangeScopeoptional

Filter by an instrument's configured exchange_id. Same three-state semantics as the HTTP /info ExchangeScope: missing, null, or 0 -> Default (only instruments with no configured exchange_id); the string "all" (case-insensitive) -> All (no filter, every exchange); a positive integer n -> Exchange(n) (only that exchange_id).

oneOf · variant 1
null
oneOf · variant 2
integer
oneOf · variant 3
string
Server message
channelstring
"userFundings"
dataWsFundingUpdate

Hyperliquid-compatible funding settlement update.

coinstring
fundingRateDecimalString

Funding rate, percentage form (e.g. "0.01" means 0.01%).

sziDecimalString

Signed position size at settlement time.

timeinteger

Settlement timestamp, milliseconds.

usdcDecimalString

Funding amount in USDC. Negative = paid, positive = received.

Message example
{
  "channel": "userFundings",
  "data": {
    "time": 1700000000000,
    "coin": "4",
    "usdc": "",
    "szi": "",
    "fundingRate": ""
  }
}