Skip to main content
Glama

Orderbook imbalance

get_orderbook_imbalance
Read-onlyIdempotent

Orderbook imbalance for any Hyperliquid perp: resting bid and ask liquidity in USD within ±N bps of mid, the ratio between the two sides, and a skew read. Costs 0.01 USDC per call (x402, USDC on Solana, Base, Polygon, Arbitrum or Arc).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bpsNowindow ±bps around mid, 5-500, default 50
symbolNoUSDT perp symbol e.g. SOLUSDT, BTCUSDT (default SOLUSDT)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYesthe get_orderbook_imbalance payload; a real captured example is free at https://x402.ochinimus.app/api/sample/get_orderbook_imbalance
toolYesthe tool that produced this payload

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / symbol / description
      Previous value: -"USDT perp symbol e.g. SOLUSDT"New value: +"USDT perp symbol e.g. SOLUSDT, BTCUSDT (default SOLUSDT)"
    • removedInput schema / required
      Removed value: -[
      -  "symbol"
      -]
  2. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "data": {
      +      "additionalProperties": {},
      +      "description": "the get_orderbook_imbalance payload; a real captured example is free at https://x402.ochinimus.app/api/sample/get_orderbook_imbalance",
      +      "propertyNames": {
      +        "type": "string"
      +      },
      +      "type": "object"
      +    },
      +    "tool": {
      +      "const": "get_orderbook_imbalance",
      +      "description": "the tool that produced this payload",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "tool",
      +    "data"
      +  ],
      +  "type": "object"
      +}
  3. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, open-world access, so the safety profile is covered. The description adds genuinely new behavioral context the annotations cannot express: a paid endpoint at 0.01 USDC per call via x402, with the accepted settlement chains enumerated. It does not mention rate limits or failure behavior, but the payment requirement is the key operational fact.

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

Conciseness4/5

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

Front-loaded with the core measurement, then a compact second sentence for the cost and payment rails. Information-dense with no filler; the first sentence is long but each clause contributes a distinct output field.

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?

An output schema exists, so return-field documentation is not required, and the description covers what is measured, the venue scope, the default symbol, and the cost model. The notable remaining gap is routing relative to the many overlapping market-data siblings.

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

Parameters3/5

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

Schema description coverage is 100% with only two params, both already documented with ranges and defaults, so the schema does the heavy lifting. The description's '±N bps of mid' framing reinforces the bps semantics but adds no syntax, units, or edge-case detail beyond what the schema states.

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

Purpose5/5

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

States a specific metric (orderbook imbalance), the underlying computation (resting bid/ask liquidity in USD within ±N bps of mid), and the derived outputs (ratio and skew read) for a named venue universe (Hyperliquid perps). An agent can distinguish this from sibling get_orderbook_walls without opening either schema.

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

Usage Guidelines2/5

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

No when-to-use or when-not-to-use guidance, and no alternatives named despite many closely related siblings (get_orderbook_walls, get_perp, get_market_snapshot). The only decision-relevant fact offered is the per-call cost, which is pricing rather than routing guidance.

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.