Skip to main content
Glama

Get orderbook file link (GET /orderbook)

get_orderbook_file
Read-onlyIdempotent

Return a time-limited download URL for a single orderbook file. Use list_market_data first to get the exact slug filename. Set md_type to bbo for best-bid/offer files.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dateYesDate in YYYY-MM-DD format.
slugYesExact filename from list_market_data, including extension.
tickerYesTicker, e.g. btc.
expiresNoURL lifetime in seconds (default 900).
md_typeNoOverrides the prefix; use `bbo` for best-bid/offer files.
exchangeYesVenue: kalshi, polymarket, predict, limitless, deribit, binance.
timeframeNoTimeframe, e.g. 15 or 1h (omitted for some venues).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyNo
slugNo
expires_inNo
download_urlNo

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.9/5.0
Behavior5/5

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

The description reveals that the URL is time-limited, adding behavioral context beyond the readOnlyHint annotation. It correctly implies a read-only operation (returning a URL) and is consistent with the idempotent and open-world hints. No contradictions.

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 two concise sentences, front-loading the core purpose and then providing essential operational steps. No redundant or filler content.

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?

Given the presence of an output schema and the simple nature of the tool (return a URL), the description covers all necessary operational context: the prerequisite call, the key parameter override, and the result type. It is complete for an agent to use correctly.

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?

The schema fully describes all parameters, and the description adds meaningful usage semantics for 'slug' (from list_market_data) and 'md_type' (overrides prefix for bbo). It enhances understanding without conflicting with the schema.

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 clearly states the tool returns a time-limited URL for a single orderbook file, and the directive to use list_market_data first distinguishes it from other file-getter siblings like get_trades_file or get_surface_file. The verb 'Return' is specific and unambiguous.

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?

It explicitly instructs to call list_market_data first to obtain the exact slug, and provides a conditional hint for md_type ('Set md_type to `bbo` for best-bid/offer files'). This gives clear when-to-use and how-to-use 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.

TDQS

A4.7/5.0
Disambiguation5/5

Each tool targets a distinct purpose: four file download tools are differentiated by data type (candles, orderbook, surface, trades), with a generic fallback for exact keys. list_market_data handles browsing, and profile/subscription tools are clearly separate.

Naming Consistency5/5

All tools follow a consistent verb_noun pattern: get_* for retrieval actions and list_* for browsing. The naming is uniform and predictable, with no mixing of conventions.

Tool Count5/5

8 tools is well-scoped for a market data server covering file downloads, catalog browsing, and user account details. Each tool serves a clear role without redundancy or bloat.

Completeness5/5

The tool surface fully covers the domain: users can browse the entire catalog hierarchically and download every file type via dedicated tools, with a generic fallback. Account and subscription info are also included. No obvious gaps exist for the stated purpose.

Resources