live_recent_liquidations
Retrieve real liquidation events with wallet, coin, penalty fee, and closed PnL. Filter by time window, coin, and limit for precise analysis of forced unwind activity.
Instructions
Get real liquidation events from the syncer. Best for questions like 'where did forced unwind activity actually hit?' or 'show me BTC liquidations over the last 30 days'. Returns wallet, coin, penalty fee, and closed PnL.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| useToonFormat | No | Return data in compact toon format (default: true). Set to false for standard JSON. | |
| since | No | Time window: e.g. '10m' (minutes), '1h' (hours), '1d' (days) | 7d |
| coin | No | Optional coin filter (e.g. BTC, ETH, SOL or builder dex prefix:COIN) | |
| limit | No | Number of liquidation events to return |
Implementation Reference
- src/index.ts:656-661 (handler)Handler function for live_recent_liquidations tool. Takes useToonFormat, since, coin, and limit params. Builds query params and calls the API at /live/risk/liquidations/recent. The normalized coin filter is conditionally added.
async ({ useToonFormat, since, coin, limit }) => { const params: Record<string, string> = { since, limit: String(limit) }; if (coin) params.coin = normalizeCoin(coin); return toolResult(await callAPI(useToonFormat, "/live/risk/liquidations/recent", params)); } ); - src/index.ts:647-655 (schema)Input schema for live_recent_liquidations. Defines useToonFormat (boolean, default true), since (time window string like '7d'), coin (optional string for filtering), and limit (number 1-200, default 50).
{ description: "Get real liquidation events from the syncer. Best for questions like 'where did forced unwind activity actually hit?' or 'show me BTC liquidations over the last 30 days'. Returns wallet, coin, penalty fee, and closed PnL.", inputSchema: { useToonFormat: useToonFormatSchema, since: sinceSchema.default("7d"), coin: z.string().optional().describe("Optional coin filter (e.g. BTC, ETH, SOL or builder dex prefix:COIN)"), limit: z.number().min(1).max(200).default(50).describe("Number of liquidation events to return"), }, }, - src/index.ts:645-661 (registration)Registration of the live_recent_liquidations tool via server.registerTool(). Conditionally registered based on shouldRegister() guard. The tool is NOT in the FREE_TIER_TOOLS set so it requires an API key.
if (shouldRegister("live_recent_liquidations")) server.registerTool( "live_recent_liquidations", { description: "Get real liquidation events from the syncer. Best for questions like 'where did forced unwind activity actually hit?' or 'show me BTC liquidations over the last 30 days'. Returns wallet, coin, penalty fee, and closed PnL.", inputSchema: { useToonFormat: useToonFormatSchema, since: sinceSchema.default("7d"), coin: z.string().optional().describe("Optional coin filter (e.g. BTC, ETH, SOL or builder dex prefix:COIN)"), limit: z.number().min(1).max(200).default(50).describe("Number of liquidation events to return"), }, }, async ({ useToonFormat, since, coin, limit }) => { const params: Record<string, string> = { since, limit: String(limit) }; if (coin) params.coin = normalizeCoin(coin); return toolResult(await callAPI(useToonFormat, "/live/risk/liquidations/recent", params)); } );