API reference · Liquidations & positions

Position changes

Each perp position change, one per block, account and coin.

WebSocket channel hc.positions on wss://api.femtos.xyz/v1/ws

Parameters

Param	In	Example or values	Meaning
`coin`	filter	`BTC`	HyperCore market (BTC, @107, xyz:TSLA)
`user`	filter	(optional)	Account: 0x address or a named wallet's handle
`min_notional`	filter	`100000`	Minimum notional, USD: default 100000, "0" for all

{"op":"subscribe","channel":"hc.positions","filter":{"coin":"BTC","min_notional":"100000"}}

Key: Authorization: Bearer $FEMTOS_KEY. Get a free key, or with no browser through agent onboarding.

Field	Type	Meaning
`data`	HcPositionChange	each perp position change, one per block, account and coin: {coin, user, kind, dir, start_position, end_position, sz, px, notional, liquidation, n_fills, tid, …}
`data.kind`	open \| increase \| reduce \| close \| flip \| unchanged	open, increase, reduce, close, flip

Liquidations GET /v1/liquidations HyperCore
Perp liquidations, newest first, one row per account, coin and block.
Liquidations stream WS hc.liquidations HyperCore
Each liquidation fill, the block it happens.
Liquidation stats GET /v1/liquidations/stats HyperCore
Totals, per coin, per time bucket and the largest, over a window.
Positions GET /v1/positions HyperCore
Open positions of one perp with leverage and liquidation price.
Open interest GET /v1/positions/overview HyperCore
Open interest, accounts and unrealized PnL per perp.
Liquidation map GET /v1/positions/liqmap HyperCore
Notional that would be liquidated at each price around the mark.