builderLiquidations

Stream live liquidation fills of your users. Based on last touch attribution, if the last non-liquidation fill for that coin had your builder code, the liquidation will be broadcast to your channel.

Note: TWAP fills do not carry builder codes. If a user's last fill before liquidation was a TWAP fill, no builder liquidation notification will be sent.

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

Subscribe

{ 
  "type": "subscribe", 
  "subscription": { 
    "type": "builderLiquidations", 
    "builder": "0x..", // your builder address
    "aggregateByTime": true
  }
}

Parameters

Parameter	Type	Required	Default	Description
builder	string	Yes	-	Your builder address
dex	string	No	null	Filter by DEX: "xyz", "main" ( for fills only on first dex)
aggregateByTime	boolean	No	true	Aggregate multi-fill liquidations by (user, time, order_id)

Unsubscribe

note: make sure to use exactly the same message as subscription message.

{ 
  "type": "unsubscribe", 
  "subscription": { 
    "type": "builderLiquidations", 
    "builder": "0x..",
    "aggregateByTime": true
  } 
}

Liquidation data format

Reconnection Note: When reconnecting with a session, replay and live events may overlap. Deduplicate using (time, txIndex) - skip liquidation fills where this tuple is at or before your last processed fill. See Session Management for details.

Each message contains an array of liquidation fills. Each fill is a tuple of [user_address, fill_data].

{ 
  "type": "builderLiquidations", 
  "seq": 1,
  "cursor": "500:1704067200000:3",
  "liquidations": [ 
    [ 
      "0x742d35cc6634c0532925a3b844bc9e7595f7f2e2", 
      { 
        "coin": "ETH", 
        "px": "2150.50", 
        "sz": "1.5", 
        "side": "A", 
        "time": 1704067200000, 
        "startPosition": "1.5", 
        "dir": "Close Long", 
        "closedPnl": "-125.50", 
        "hash": "0xabc...def", 
        "oid": 12345678, 
        "crossed": true, 
        "fee": "2.50", 
        "tid": 87654321, 
        "cloid": null, 
        "builderFee": null,
        "deployerFee": null,
        "feeToken": "USDC",
        "builder": "0x..", // my builder address
        "twapId": null, 
        "txIndex": 1, 
        "liquidation": { 
          "liquidatedUser": "0x742d35cc6634c0532925a3b844bc9e7595f7f2e2", 
          "markPx": "2148.00", 
          "method": "market"
         }, 
         "user": "0x742d35cc6634c0532925a3b844bc9e7595f7f2e2" 
       } 
     ] 
   ] 
 }

Examples

JavaScript

const WebSocket = require('ws');

const ws = new WebSocket(`wss://api.hydromancer.xyz/ws?token=${process.env.HYDROMANCER_API_KEY}`);

ws.on('message', (data) => {
    const msg = JSON.parse(data);

    if (msg.type === 'connected') {
        // Subscribe to builder liquidations
        ws.send(JSON.stringify({
            type: 'subscribe',
            subscription: {
                type: 'builderLiquidations',
                builder: 'YOUR_BUILDER_CODE'
            }
        }));
    } else if (msg.type === 'ping') {
        ws.send(JSON.stringify({ type: 'pong' }));
    } else if (msg.type === 'builderLiquidations') {
        console.log(`Received ${msg.liquidations.length} liquidation fills`);
        for (const [user, fill] of msg.liquidations) {
            console.log(`User ${user} liquidated: ${fill.sz} ${fill.coin} @ ${fill.px}`);
            if (fill.liquidation) {
                console.log(`  Liquidated user: ${fill.liquidation.liquidatedUser}`);
                console.log(`  Mark price: ${fill.liquidation.markPx}`);
            }
        }
    }
});

Python

Error messages:

{
    "type": "error",
    "message": "Invalid API key"
}

Common errors

1. Connection timeout - Respond to ping messages

2. Too many subscriptions - Maximum builder subscriptions per API key

3. Invalid builder code

4. Invalid API key