live_liquidation_summary
Get aggregated liquidation summaries over a time window, including event counts, penalty fees, closed PnL, per-coin rollups, and a liquidation timeline for trend analysis.
Instructions
Get an aggregated liquidation summary over a time window. This is the best liquidation tool for summaries, rankings, and trend analysis. Returns event count, penalty fees, closed PnL, per-coin rollups, and a liquidation timeline.
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) |
Implementation Reference
- src/index.ts:676-681 (handler)Handler for live_liquidation_summary: calls API endpoint /live/risk/liquidations/summary with optional 'since' and 'coin' parameters.
async ({ useToonFormat, since, coin }) => { const params: Record<string, string> = { since }; if (coin) params.coin = normalizeCoin(coin); return toolResult(await callAPI(useToonFormat, "/live/risk/liquidations/summary", params)); } ); - src/index.ts:667-675 (schema)Input schema for live_liquidation_summary: accepts useToonFormat (bool, default true), since (time window, default '7d'), and optional coin filter.
"live_liquidation_summary", { description: "Get an aggregated liquidation summary over a time window. This is the best liquidation tool for summaries, rankings, and trend analysis. Returns event count, penalty fees, closed PnL, per-coin rollups, and a liquidation timeline.", 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)"), }, }, - src/index.ts:666-681 (registration)Registration of the live_liquidation_summary tool using server.registerTool(). The tool is conditionally registered based on API key (not in FREE_TIER_TOOLS).
if (shouldRegister("live_liquidation_summary")) server.registerTool( "live_liquidation_summary", { description: "Get an aggregated liquidation summary over a time window. This is the best liquidation tool for summaries, rankings, and trend analysis. Returns event count, penalty fees, closed PnL, per-coin rollups, and a liquidation timeline.", 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)"), }, }, async ({ useToonFormat, since, coin }) => { const params: Record<string, string> = { since }; if (coin) params.coin = normalizeCoin(coin); return toolResult(await callAPI(useToonFormat, "/live/risk/liquidations/summary", params)); } );