Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ekiden.fi/llms.txt

Use this file to discover all available pages before exploring further.

Subscribe to liquidation events for a symbol.
  • Topic: all_liquidations.<symbol> (e.g., all_liquidations.BTC-USDC)
  • Stream: Public (wss://api.ekiden.fi/ws/public)

Subscribe

{ "op": "subscribe", "args": ["all_liquidations.BTC-USDC"], "req_id": "105001" }
Ack:
{ "op": "subscribed", "args": ["all_liquidations.BTC-USDC"], "req_id": "105001" }

Events

Messages arrive with op: "event", topic: "all_liquidations.<symbol>", and data containing an array of Liquidation. Example:
{
	"op": "event",
	"topic": "all_liquidations.BTC-USDC",
	"server_ts_ms": 1731541800000,
	"data": [
		{
			"symbol": "BTC-USDC",
			"side": "Sell",
			"exec_size": "0.25",
			"bust_price": "98450.5",
			"timestamp": 1731541800000,
			"reason": "liquidation"
		}
	]
}
Field notes:
  • exec_size and bust_price are strings to preserve precision.
  • timestamp and server_ts_ms are Unix milliseconds.
  • reason may be omitted.
See schema details in AsyncAPI: Liquidation.