@sperax/tool-liquidations

Monitor DeFi liquidation events, at-risk positions, and protocol liquidation stats.

Liquidations is an agent tool from SperaxOS, packaged headless so you can call it from any agent framework. It ships two things: the manifest — a JSON-Schema function definition a model can call — and the executor that runs the call against the real API.

There is no UI layer and no framework lock-in. It works anywhere TypeScript runs.

Install

npm install @sperax/tool-liquidations

Usage

Call it directly

import { liquidationsExecutor } from '@sperax/tool-liquidations';

const result = await liquidationsExecutor.invoke('getRecentLiquidations', {"chain":"<chain>","limit":1}, {
  messageId: 'msg-1',
});

console.log(result.content); // prose summary written for the model to read
console.log(result.state);   // typed data payload for your own UI

Give it to a model

import Anthropic from '@anthropic-ai/sdk';
import { LiquidationsManifest, liquidationsExecutor } from '@sperax/tool-liquidations';

const client = new Anthropic();

const response = await client.messages.create({
  model: 'claude-opus-4-8',
  max_tokens: 1024,
  messages: [{ role: 'user', content: 'Ask something this tool can answer' }],
  tools: LiquidationsManifest.api.map((api) => ({
    name: api.name,
    description: api.description,
    input_schema: api.parameters,
  })),
});

for (const block of response.content) {
  if (block.type !== 'tool_use') continue;
  const result = await liquidationsExecutor.invoke(block.name, block.input, { messageId: response.id });
  console.log(result.content);
}

LiquidationsManifest.api is already in JSON-Schema form, so it maps onto any tool-calling API — Anthropic, OpenAI, the Vercel AI SDK, or an MCP server — without translation.

Every executor returns a BuiltinToolResult — { success, content, state }. content is prose written for the model to read; state is the typed data payload for your own code. Executors never throw: a failed call comes back as { success: false, content: '<reason>' }, so a network blip degrades the answer instead of crashing the agent loop.

Configuration

None. This tool calls a public API directly and needs no key or origin configuration.

Tool identifier

sperax-liquidations

API reference

getRecentLiquidations

Get the most recent DeFi lending liquidation events across protocols. Shows collateral seized, debt repaid, and protocol details.

| Parameter | Type | Required | Description | | --- | --- | --- | --- | | chain | string | no | Filter by chain (e.g. "Ethereum", "Arbitrum") | | limit | number | no | Max events to return (default 20) |

getLiquidationsByProtocol

Get liquidation stats and recent events for a specific DeFi lending protocol.

| Parameter | Type | Required | Description | | --- | --- | --- | --- | | protocol | string | yes | Protocol name (e.g. "aave-v3", "compound-v3", "maker") |

getLiquidationSummary

Get a summary of DeFi liquidation activity: 24h/7d totals, top protocols by liquidation volume, and chain breakdown.

Takes no parameters.

Types

Shared types come from @sperax/agent-tools-core: BuiltinToolManifest, BuiltinToolResult, BuiltinToolContext, and the BaseExecutor class every tool executor extends.

Related

• @sperax/agent-tools-core — the tool contract
• All SperaxOS agent tools — tool-liquidations is one of many
• SperaxOS — the agent workspace these tools were built for

License

Apache-2.0