Skip to main content
Glama
bykarantelicom

bykaranteli-mcp

by bykarantelicom
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Recorded series: bars or points of one metric for one perpetual (price, OI, funding, CVD, liquidations, long/short, RSI and more)

get_series
Read-only

Retrieve historical time-series data for a perpetual metric such as price, volume, funding, OI, liquidations or RSI for charting, backtesting and period analysis.

Instructions

Call this when the user wants the history of one recorded metric for one perpetual as a time series: price candles, volume, perp or spot CVD, open interest, funding (one venue, or OI-weighted across every venue as funding_agg), liquidations, long/short ratios, RSI, the Coinbase premium, US spot ETF flows, borrow rates or Hyperliquid whale net flow, for charting, backtesting or "what did X do over the last N days". Returns the /api/series answer (points as [t, v], or [t, o, h, l, c, v] for price, with unit, kind, source and source_kind, the bars served and whether member depth applied) plus provenance. metric is one of: price, volume, cvd_perp, cvd_spot, oi, funding, funding_agg, liquidations, long_short, top_traders, rsi, premium, etf_flow, borrow, whale_net (unit, finest period and venue support of each: https://bykaranteli.com/api/series/metrics). The Free plan gets public depth: fewer bars and no bars under 15 minutes (1m, 3m, 5m, 10m); Builder and higher plans get member depth; the bar limits are in the same list. The answer names the venue it was read from (venue) and every venue a market-wide series sums (venues). Without from or limit, the newest 300 bars; pass limit for more of the newest bars, or from and to (ISO) for a window. The public window is the newest 300 bars of the period: a to before it needs member depth (Builder and higher plans) and answers 403 history_member_only otherwise, except daily and coarser price bars, which stay open to every plan.

Input Schema

NameRequiredDescriptionDefault
toNostring, optional ISO end (default now); a to before the newest 300 bars of the period needs member depth, except daily and coarser price bars
fromNostring, optional ISO start, e.g. 2026-09-01T00:00:00Z
limitNonumber, optional newest bars, 10..5000; the plan's depth caps it (default 300 without from)
venueNostring, optional venue id for price, oi, funding or borrow, e.g. okx (default binance)
metricYesstring, metric key, e.g. price, oi, funding, liquidations (list: /api/series/metrics)
periodNostring, optional bar period: 1m | 3m | 5m | 10m | 15m | 30m | 1h | 2h | 4h | 6h | 8h | 12h | 1d | 3d | 1w | 1M (default 1h; each metric has a finest period)
symbolNostring, optional Binance USDT-M perp or coin, e.g. BTCUSDT or BTC (default BTCUSDT)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.1.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. Changed1 schema field changedv0.36.1
    • changedInput schema / properties / to / description
      Previous value: -"string, optional ISO end (default now)"New value: +"string, optional ISO end (default now); a to before the newest 300 bars of the period needs member depth, except daily and coarser price bars"
  3. Changed3 schema fields changedv0.36.0
    • changedInput schema / properties / limit / description
      Previous value: -"number, optional newest bars, 10..5000; the key's depth caps it"New value: +"number, optional newest bars, 10..5000; the plan's depth caps it (default 300 without from)"
    • changedInput schema / properties / period / description
      Previous value: -"string, optional bar period: 5m | 15m | 1h | 4h | 1d (default 1h; each metric has a finest period)"New value: +"string, optional bar period: 1m | 3m | 5m | 10m | 15m | 30m | 1h | 2h | 4h | 6h | 8h | 12h | 1d | 3d | 1w | 1M (default 1h; each metric has a finest period)"
    • changedInput schema / properties / period / enum
      Previous value: -[
-  "5m",
-  "15m",
-  "1h",
-  "4h",
-  "1d"
-]New value: +[
+  "1m",
+  "3m",
+  "5m",
+  "10m",
+  "15m",
+  "30m",
+  "1h",
+  "2h",
+  "4h",
+  "6h",
+  "8h",
+  "12h",
+  "1d",
+  "3d",
+  "1w",
+  "1M"
+]
  4. Addedv0.31.0

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the readOnly and openWorld annotations, the description discloses the response shape, provenance fields, plan-based depth restrictions, the 403 history_member_only error, and the daily-price exception. This is unusually rich behavioral context for an agent.

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 front-loaded with the core when-to-use guidance and remains information-dense throughout. It is long and somewhat repetitive about plan-based depth and the public 300-bar window, but most sentences carry necessary operational detail.

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 seven-parameter tool with no output schema, the description is highly complete: it covers return format, metric enumeration, defaults, pagination/window semantics, venue behavior, and plan-gated errors. An agent has enough information to invoke it correctly in normal and edge cases.

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?

Although schema coverage is already 100%, the description adds substantial meaning: it lists all supported metric values, explains venue and period behavior, and clarifies how from, to, and limit interact with the default 300-bar window and plan caps.

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 states a specific action and resource: retrieving the history of one recorded metric for one perpetual as a time series. It enumerates the supported metrics and clarifies the time-series scope, which distinguishes it from snapshot-oriented sibling tools.

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?

It clearly says when to call the tool, including charting, backtesting, and 'what did X do over the last N days' use cases. It also explains defaults and plan-based limits, but does not explicitly name alternative sibling tools or when not to use this one.

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

Deploy Server

Other Tools