Skip to main content
Glama
bybit-exchange

Bybit MCP Server

Official

getSpreadOrderbook

Read-only

Retrieve current bid/ask depth for a spread symbol to assess liquidity before placing orders. Returns up to 25 price levels per side with sequence for WebSocket correlation.

Instructions

Retrieve spread orderbook depth data for a specific spread combination symbol. Returns a snapshot of bid and ask price levels, along with sequence and timestamp fields for correlation with WebSocket streams.

Use this endpoint when you need to:

  • Inspect current bid/ask depth before placing a spread order

  • Fetch the best bid/ask price and available size at each level

  • Correlate with the WebSocket orderbook stream using the u (update ID) field

Returns up to 25 price levels per side. Use limit=1 (default) for best bid/ask only; increase limit for deeper analysis.

Do not use this endpoint for 24h stats or last traded price — use getSpreadTickers instead.

Notes:

  • Bids are sorted in descending order by price

  • Asks are sorted in ascending order by price

  • The u field correlates with the WebSocket orderbook stream update ID

  • No authentication required

Agent hint: Use this endpoint to get current bid/ask depth for a spread symbol. The symbol must be a valid spread combination — obtain it from getSpreadInstrumentsInfo if unknown. Use limit=1 (default) for best bid/ask only; increase limit for deeper order book analysis. Do not use this for 24h stats or last price — use getSpreadTickers for that.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
symbolYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.1.11

TDQS

A4.9/5.0
Behavior5/5

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

Beyond the readOnlyHint annotation, the description discloses bid/ask sort order, up to 25 levels per side, the `u` field correlation with WebSocket streams, and that no authentication is required. These details give the agent a clear behavioral model without contradicting any annotation.

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?

The description is well-structured with a lead sentence, bulleted use cases, notes, and an agent hint. However, the agent hint largely repeats the limit guidance and the getSpreadTickers exclusion already stated above, adding redundancy that costs a point.

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

Completeness5/5

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

For a two-parameter read-only market data call with no output schema, the description covers the full context: what is returned, ordering rules, correlation field, authentication status, symbol source, and the alternative for excluded use cases. Nothing essential is missing.

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

Parameters5/5

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

The input schema has 0% description coverage, so the description fully compensates: `symbol` is explained as a valid spread combination obtainable from getSpreadInstrumentsInfo, and `limit` is explained as defaulting to 1 for best bid/ask with increase for deeper analysis. This adds real meaning beyond the schema's type and range.

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?

The description opens with a specific verb+resource: 'Retrieve spread orderbook depth data for a specific spread combination symbol.' It clearly distinguishes this REST snapshot tool from sibling tools like getSpreadTickers and subscribeSpreadOrderbook by specifying depth, snapshot semantics, and correlation to WebSocket streams.

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

Usage Guidelines5/5

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

Provides explicit 'Use this endpoint when you need to' bullets plus a 'Do not use' exclusion directing agents to getSpreadTickers for 24h stats or last price. It also tells the agent to obtain the symbol from getSpreadInstrumentsInfo if unknown, leaving no ambiguity about when to invoke this tool.

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

Install Server

Other Tools