Skip to main content
Glama

Forced closes (liquidations)

liquidations
Read-onlyIdempotent

Forced closes. scope: coin (recorded long vs short closes for one coin, the default when a coin is named), market (the whole market, long/short split, the default otherwise), lending (on-chain lending liquidations with both wallets, never added to perp), projected (modelled levels, not trades), heat (where closes hit by price band). A long is force-closed by selling.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
coinNoCoin symbol, e.g. BTC. A pair like ETH/USD works too.
chainNoethereum, base or arbitrum. Omit for all.
hoursNoHow many hours back to read.
limitNoRows to return (usually up to 1000; more is clamped and said).
scopeNoWhich lane; see the description.
cursorNoNext page: the cursor from the previous answer.
detailNobrief (default): the answer, key numbers and top rows. full: every row, paged with cursor.
since_msNoOnly rows newer than this Unix-ms time (polling cursor).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
as_ofNoData time, ISO.
caveatNoA real limit, when non-null.
cursorNoNext page (detail full).
delayedNoSet when not live.
summaryNoThe answer in one sentence.
as_of_msNoData time, Unix ms.
availableNoFalse: no data; note says why.
truncatedNoRows held back; see trimmed.
next_toolsNoFollow-up calls {tool,args,why}.
access_noteNoWhat this connection could not return.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed49 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • addedInput schema / additionalProperties
      Added value: +{}
    • addedInput schema / properties / chain
      Added value: +{
      +  "description": "ethereum, base or arbitrum. Omit for all.",
      +  "type": "string"
      +}
    • changedInput schema / properties / coin / description
      Previous value: -"Alias for pair."New value: +"Coin symbol, e.g. BTC. A pair like ETH/USD works too."
    • addedInput schema / properties / cursor
      Added value: +{
      +  "description": "Next page: the cursor from the previous answer.",
      +  "type": "string"
      +}
    • addedInput schema / properties / detail
      Added value: +{
      +  "description": "brief (default): the answer, key numbers and top rows. full: every row, paged with cursor.",
      +  "enum": [
      +    "brief",
      +    "full"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / hours / description
      Previous value: -"Look back this many hours, up to 720. Omit for the most recent events."New value: +"How many hours back to read."
    • changedInput schema / properties / hours / type
      Previous value: -"number"New value: +"integer"
    • changedInput schema / properties / limit / description
      Previous value: -"Max rows returned. Capped at 25 on the free plans and 1000 on a paid plan; asking for more returns the cap, and the payload says so in `capped`. count and the *_usd totals always cover the whole window regardless."New value: +"Rows to return (usually up to 1000; more is clamped and said)."
    • removedInput schema / properties / limit / maximum
      Removed value: -9007199254740991
    • removedInput schema / properties / limit / minimum
      Removed value: --9007199254740991
    • removedInput schema / properties / pair
      Removed value: -{
      -  "description": "e.g. ETH/USD. A bare symbol like ETH also works.",
      -  "type": "string"
      -}
    • addedInput schema / properties / scope
      Added value: +{
      +  "description": "Which lane; see the description.",
      +  "enum": [
      +    "coin",
      +    "market",
      +    "lending",
      +    "projected",
      +    "heat"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / since_ms / description
      Previous value: -"Polling cursor: only rows newer than this Unix-ms timestamp, applied before the row cap. Pass back the next_since_ms from the previous answer so a timer never re-reads the same rows."New value: +"Only rows newer than this Unix-ms time (polling cursor)."
    • removedInput schema / properties / since_ms / maximum
      Removed value: -9007199254740991
    • removedInput schema / properties / since_ms / minimum
      Removed value: --9007199254740991
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • removedOutput schema / properties / access_note / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • changedOutput schema / properties / access_note / description
      Previous value: -"What this connection could not return and what lifts it. Always pass this on to the user: it is the only place that information appears."New value: +"What this connection could not return."
    • addedOutput schema / properties / as_of
      Added value: +{
      +  "description": "Data time, ISO."
      +}
    • addedOutput schema / properties / as_of_ms
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "number"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Data time, Unix ms."
      +}
    • removedOutput schema / properties / available / anyOf
      Removed value: -[
      -  {
      -    "type": "boolean"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • changedOutput schema / properties / available / description
      Previous value: -"False when this lane could not answer: a producer is dark, the pair sits outside this plan, or the argument named something we do not carry. Absent or true means the numbers are a real reading, not a guess."New value: +"False: no data; note says why."
    • addedOutput schema / properties / available / type
      Added value: +"boolean"
    • removedOutput schema / properties / capped
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "additionalProperties": false,
      -      "properties": {
      -        "applied": {
      -          "description": "The value actually used.",
      -          "type": "number"
      -        },
      -        "argument": {
      -          "description": "Which argument was cut down, for example limit or hours.",
      -          "type": "string"
      -        },
      -        "by": {
      -          "description": "Why it was cut: keyless for the free ceiling, plan_max for a paid ceiling, tool_max for a ceiling no plan raises.",
      -          "type": "string"
      -        },
      -        "max": {
      -          "description": "The ceiling that applied.",
      -          "type": "number"
      -        },
      -        "requested": {
      -          "description": "The value the caller asked for.",
      -          "type": "number"
      -        }
      -      },
      -      "required": [
      -        "argument",
      -        "requested",
      -        "applied",
      -        "max",
      -        "by"
      -      ],
      -      "type": "object"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "Present only when an argument was cut down to a ceiling. Absent means nothing was clamped, so a smaller number than you asked for is the data and not a limit."
      -}
    • addedOutput schema / properties / caveat
      Added value: +{
      +  "description": "A real limit, when non-null."
      +}
    • removedOutput schema / properties / count
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "number"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "How many events fired in the whole window, not how many rows came back."
      -}
    • addedOutput schema / properties / cursor
      Added value: +{
      +  "description": "Next page (detail full)."
      +}
    • addedOutput schema / properties / delayed
      Added value: +{
      +  "description": "Set when not live."
      +}
    • removedOutput schema / properties / history_included
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "boolean"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "True when the recorded series was merged in, so a restart has not erased earlier events."
      -}
    • removedOutput schema / properties / liquidations
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "items": {},
      -      "type": "array"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "The events themselves, newest first: price, size in base and quote, side (long_liquidated or short_liquidated), exchange and time. A sample of the window when truncated is true."
      -}
    • removedOutput schema / properties / long_liquidations
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "number"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "COUNT of longs force-closed. For dollars read long_usd."
      -}
    • removedOutput schema / properties / long_usd
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "number"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "Dollars of longs force-closed across the window."
      -}
    • addedOutput schema / properties / next_tools
      Added value: +{
      +  "description": "Follow-up calls {tool,args,why}.",
      +  "items": {
      +    "additionalProperties": {},
      +    "properties": {},
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • removedOutput schema / properties / note
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "One line saying what the numbers cover, or why there are none. Read it before reporting any zero as a market reading."
      -}
    • removedOutput schema / properties / pair
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "The pair these events belong to."
      -}
    • removedOutput schema / properties / requested_hours
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "number"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "The period asked for, so a page can be told apart from a period."
      -}
    • removedOutput schema / properties / rows_returned
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "number"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "How many event rows are actually in this reply."
      -}
    • removedOutput schema / properties / rows_span_minutes
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "number"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "How far back the returned rows themselves reach."
      -}
    • removedOutput schema / properties / short_liquidations
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "number"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "COUNT of shorts force-closed. For dollars read short_usd."
      -}
    • removedOutput schema / properties / short_usd
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "number"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "Dollars of shorts force-closed across the window."
      -}
    • removedOutput schema / properties / sources
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "additionalProperties": {},
      -      "propertyNames": {
      -        "type": "string"
      -      },
      -      "type": "object"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "How the events split between the streamed exchanges and Hyperliquid, and whether the Hyperliquid part is a sample."
      -}
    • addedOutput schema / properties / summary
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "The answer in one sentence."
      +}
    • removedOutput schema / properties / total_in_window
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "number"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "How many events the window holds in total."
      -}
    • removedOutput schema / properties / total_volume_usd
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "number"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "Dollars forced out across the whole window."
      -}
    • removedOutput schema / properties / truncated / anyOf
      Removed value: -[
      -  {
      -    "type": "boolean"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • changedOutput schema / properties / truncated / description
      Previous value: -"True when more rows matched than were returned, so what you have is a page and not the whole set."New value: +"Rows held back; see trimmed."
    • removedOutput schema / properties / window_hours
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "number"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "The period the totals cover, in hours."
      -}
    • removedOutput schema / properties / window_minutes
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "number"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "The same period in minutes."
      -}
  2. Changed1 schema field changed
    • changedInput schema / properties / limit / description
      Previous value: -"Max rows returned. Capped at 25 keyless and 1000 on a paid plan; asking for more returns the cap, and the payload says so in `capped`. count and the *_usd totals always cover the whole window regardless."New value: +"Max rows returned. Capped at 25 on the free plans and 1000 on a paid plan; asking for more returns the cap, and the payload says so in `capped`. count and the *_usd totals always cover the whole window regardless."
  3. Changed1 schema field changed
    • addedInput schema / properties / since_ms
      Added value: +{
      +  "description": "Polling cursor: only rows newer than this Unix-ms timestamp, applied before the row cap. Pass back the next_since_ms from the previous answer so a timer never re-reads the same rows.",
      +  "maximum": 9007199254740991,
      +  "minimum": -9007199254740991,
      +  "type": "integer"
      +}
  4. Changed1 schema field changed
    • changedInput schema / properties / limit / description
      Previous value: -"Max rows returned. Capped at 25 keyless and 1000 on a developer plan; asking for more returns the cap, and the payload says so in `capped`. count and the *_usd totals always cover the whole window regardless."New value: +"Max rows returned. Capped at 25 keyless and 1000 on a paid plan; asking for more returns the cap, and the payload says so in `capped`. count and the *_usd totals always cover the whole window regardless."
  5. Changed1 schema field changed
    • changedInput schema / properties / limit / description
      Previous value: -"Max rows returned. Capped at 50 keyless and 1000 on a developer plan; asking for more returns the cap, and the payload says so in `capped`. count and the *_usd totals always cover the whole window regardless."New value: +"Max rows returned. Capped at 25 keyless and 1000 on a developer plan; asking for more returns the cap, and the payload says so in `capped`. count and the *_usd totals always cover the whole window regardless."
  6. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": {},
      +  "properties": {
      +    "access_note": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "What this connection could not return and what lifts it. Always pass this on to the user: it is the only place that information appears."
      +    },
      +    "available": {
      +      "anyOf": [
      +        {
      +          "type": "boolean"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "False when this lane could not answer: a producer is dark, the pair sits outside this plan, or the argument named something we do not carry. Absent or true means the numbers are a real reading, not a guess."
      +    },
      +    "capped": {
      +      "anyOf": [
      +        {
      +          "additionalProperties": false,
      +          "properties": {
      +            "applied": {
      +              "description": "The value actually used.",
      +              "type": "number"
      +            },
      +            "argument": {
      +              "description": "Which argument was cut down, for example limit or hours.",
      +              "type": "string"
      +            },
      +            "by": {
      +              "description": "Why it was cut: keyless for the free ceiling, plan_max for a paid ceiling, tool_max for a ceiling no plan raises.",
      +              "type": "string"
      +            },
      +            "max": {
      +              "description": "The ceiling that applied.",
      +              "type": "number"
      +            },
      +            "requested": {
      +              "description": "The value the caller asked for.",
      +              "type": "number"
      +            }
      +          },
      +          "required": [
      +            "argument",
      +            "requested",
      +            "applied",
      +            "max",
      +            "by"
      +          ],
      +          "type": "object"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Present only when an argument was cut down to a ceiling. Absent means nothing was clamped, so a smaller number than you asked for is the data and not a limit."
      +    },
      +    "count": {
      +      "anyOf": [
      +        {
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "How many events fired in the whole window, not how many rows came back."
      +    },
      +    "history_included": {
      +      "anyOf": [
      +        {
      +          "type": "boolean"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "True when the recorded series was merged in, so a restart has not erased earlier events."
      +    },
      +    "liquidations": {
      +      "anyOf": [
      +        {
      +          "items": {},
      +          "type": "array"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "The events themselves, newest first: price, size in base and quote, side (long_liquidated or short_liquidated), exchange and time. A sample of the window when truncated is true."
      +    },
      +    "long_liquidations": {
      +      "anyOf": [
      +        {
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "COUNT of longs force-closed. For dollars read long_usd."
      +    },
      +    "long_usd": {
      +      "anyOf": [
      +        {
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Dollars of longs force-closed across the window."
      +    },
      +    "note": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "One line saying what the numbers cover, or why there are none. Read it before reporting any zero as a market reading."
      +    },
      +    "pair": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "The pair these events belong to."
      +    },
      +    "requested_hours": {
      +      "anyOf": [
      +        {
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "The period asked for, so a page can be told apart from a period."
      +    },
      +    "rows_returned": {
      +      "anyOf": [
      +        {
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "How many event rows are actually in this reply."
      +    },
      +    "rows_span_minutes": {
      +      "anyOf": [
      +        {
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "How far back the returned rows themselves reach."
      +    },
      +    "short_liquidations": {
      +      "anyOf": [
      +        {
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "COUNT of shorts force-closed. For dollars read short_usd."
      +    },
      +    "short_usd": {
      +      "anyOf": [
      +        {
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Dollars of shorts force-closed across the window."
      +    },
      +    "sources": {
      +      "anyOf": [
      +        {
      +          "additionalProperties": {},
      +          "propertyNames": {
      +            "type": "string"
      +          },
      +          "type": "object"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "How the events split between the streamed exchanges and Hyperliquid, and whether the Hyperliquid part is a sample."
      +    },
      +    "total_in_window": {
      +      "anyOf": [
      +        {
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "How many events the window holds in total."
      +    },
      +    "total_volume_usd": {
      +      "anyOf": [
      +        {
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Dollars forced out across the whole window."
      +    },
      +    "truncated": {
      +      "anyOf": [
      +        {
      +          "type": "boolean"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "True when more rows matched than were returned, so what you have is a page and not the whole set."
      +    },
      +    "window_hours": {
      +      "anyOf": [
      +        {
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "The period the totals cover, in hours."
      +    },
      +    "window_minutes": {
      +      "anyOf": [
      +        {
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "The same period in minutes."
      +    }
      +  },
      +  "type": "object"
      +}
  7. First observed

TDQS

A4.1/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already cover read-only, idempotent, and non-destructive behavior. The description adds useful behavioral context beyond that: lending closes are on-chain and excluded from perp, projected levels are modelled rather than actual trades, and long closes are executed by selling. No contradiction with annotations exists.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is dense and efficient: a two-word subject followed by a compact scope legend, with a final clarifying sentence about long liquidations. Every clause adds information, and there is no repetition of schema content or annotations.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a read-only query tool with eight optional parameters and an output schema, the description covers the meaning of every scope lane and the relevant defaults. It does not discuss pagination or polling parameters, but those are fully documented in the schema, so the description is sufficiently complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning for the scope parameter, which the schema explicitly defers to the description ('see the description'). It also explains default behavior per scope, going beyond the property names and enum values.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly identifies the resource as forced closes/liquidations and enumerates the distinct scope lanes. It is unambiguous about what the tool exposes, though it does not explicitly contrast itself with sibling tools like history or market_now.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear selection context within the tool: which scope is the default when a coin is named versus otherwise, and that lending liquidations are never added to perp. It does not mention alternative tools, but the internal scope guidance is concrete and actionable.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources