Crypto derivatives data: funding, OI, liquidations, options, ETF flows. Free account key required.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Account key bk_... (free at https://bykaranteli.com/dashboard/api)
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Call this when the user asks to follow, track or get alerts for a Hyperliquid address (0x followed by 40 hex characters). Every later position change of the address (opened, closed, increased, reduced, flipped) reaches the user's alert channels; the first sight is the baseline and sends nothing. Counted against the plan's address limit; the route answers terminal_required or limit_reached when it cannot add.
string, 0x followed by 40 hex characters
string, optional name for the address, up to 40 characters
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Tool list last changed Oct 25, 2026.
Call this when the user asks to follow, track or get alerts for a Hyperliquid address (0x followed by 40 hex characters). Every later position change of the address (opened, closed, increased, reduced, flipped) reaches the user's alert channels; the first sight is the baseline and sends nothing. Counted against the plan's address limit; the route answers terminal_required or limit_reached when it cannot add.
| Argument | Type | Description |
|---|---|---|
| label | string | string, optional name for the address, up to 40 characters |
| address* | string | string, 0x followed by 40 hex characters |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"address"
],
"properties": {
"label": {
"type": "string",
"description": "string, optional name for the address, up to 40 characters"
},
"address": {
"type": "string",
"description": "string, 0x followed by 40 hex characters"
}
}
}Call this when the user asks to watch, follow or add a coin to their watchlist. Adds the symbol to the list named by watchlist_id, else to the default list (or the only list the account has); a symbol already on the list stays once. Returns the list's symbols after the change. Writes are rate limited per connection (sign-in or key) and each one is recorded on the account.
| Argument | Type | Description |
|---|---|---|
| symbol* | string | string, a Binance USDT-M perp or coin, e.g. SOLUSDT or SOL |
| watchlist_id | string | string, optional list id from list_watchlists (default: the default list) |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"symbol"
],
"properties": {
"symbol": {
"type": "string",
"description": "string, a Binance USDT-M perp or coin, e.g. SOLUSDT or SOL"
},
"watchlist_id": {
"type": "string",
"description": "string, optional list id from list_watchlists (default: the default list)"
}
}
}Call this when the user asks to be alerted when a metric crosses a threshold and has agreed to the exact condition (parse_alert_text turns their words into one). Saves an alert recipe on the account: it fires when every condition holds, delivers by Telegram first with email as fallback unless channels says otherwise, and waits cooldown_hours before it fires again for the same symbol. field is one of: mark_price, pressure_score, funding_rate_pct, oi24h_pct, basis_pct, price_change_24h_pct, liq_cluster_distance_pct, usdt_peg_min_usd, usdc_peg_min_usd, liq_1h_usd, rsi_4h, ls_ratio_global, book_imbalance_2pct_pct, withdrawal_paused_venues, max_leverage_min, borrow_apr_pct, hl_whale_long_share_pct; op is one of >= > <= < ==; percent fields take percent values (0.05 means 0.05%). Pass field, op and threshold for one condition, or conditions for up to 6. scope: watchlist (default), any, or symbols with symbols. The plan sets how many recipes an account keeps; past it the tool answers with the limit. Writes are rate limited per connection (sign-in or key) and each one is recorded on the account.
| Argument | Type | Description |
|---|---|---|
| op | string | string, one condition's comparison: >= | > | <= | < | == |
| name | string | string, optional name; default describes the condition |
| field | string | string, one condition's metric, e.g. funding_rate_pct |
| scope | string | string, optional: watchlist (default), any, symbols |
| symbols | array | array, optional up to 20 symbols, e.g. ["BTCUSDT", "ETH"]; implies scope symbols |
| channels |
Call this when the user asks to remove an alert. Deletes the alert recipe with this id from the account (list_alert_recipes shows the ids); an id that is not one of the account's recipes changes nothing and says so. Writes are rate limited per connection (sign-in or key) and each one is recorded on the account.
| Argument | Type | Description |
|---|---|---|
| id* | string | string, the recipe id from list_alert_recipes |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "string, the recipe id from list_alert_recipes"
}
}
}Call this when the user asks whether it is altseason, how altcoins are doing against Bitcoin, or about market rotation. Returns the live Altcoin Season Index (share of the top 50 Binance perpetual altcoins beating BTC over the trailing 90 days; >=75 altseason, <=25 bitcoin season), the strongest and weakest large alts, and the recorded daily history (never reconstructed).
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Call this when the user asks what it costs to borrow USDT, USDC, BTC, ETH or a major alt on an exchange, which venue has the cheapest borrow, whether stablecoin borrow cost is spiking, or what the carry of a basis trade is on a venue (funding minus borrow). Returns the latest annualised rate per venue and asset, 30 days of hourly series for the stablecoins and majors, and the carry table. Recorded hourly by ByKaranteli (Binance and OKX today). The series hold the last 24 hours unless hours (up to 720) or asset is passed.
| Argument | Type | Description |
|---|---|---|
| asset | string | Optional. One asset, e.g. USDT: its rates, carry and full 30-day series. |
| hours | integer | Optional. Hours of hourly series to return (default 24, or the full 720 with asset). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"asset": {
"type": "string",
"pattern": "^[A-Z0-9]{2,12}$",
"description": "Optional. One asset, e.g. USDT: its rates, carry and full 30-day series."
},
"hours": {
"type": "integer",
"maximum": 720,
"minimum": 1,
"description": "Optional. Hours of hourly series to return (default 24, or the full 720 with asset)."
}
}
}Call this when the user asks whether US investors are buying or selling Bitcoin or Ethereum, about the Coinbase Premium, or what the cash-and-carry basis trade pays. Returns the latest daily premium in percent, 7-day average, same-sign streak, the last 30 days, and annualized quarterly carry yields. History since 2017; positive premium = US buying pressure. The kimchi and Turkey premium daily rows cover the last 7 days; pass days (up to 90) for more.
| Argument | Type | Description |
|---|---|---|
| days | integer | Optional. Days of kimchi and Turkey premium daily rows, newest first (default 7, up to 90). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"days": {
"type": "integer",
"maximum": 90,
"minimum": 1,
"description": "Optional. Days of kimchi and Turkey premium daily rows, newest first (default 7, up to 90)."
}
}
}Call this when the user asks how correlated two coins are, for decorrelated pairs, or how tightly alts track BTC. Returns the 30-day rolling Pearson correlation matrix of daily returns across the top perpetuals. Pass detail "compact" for a shorter page or "full" for the whole answer.
| Argument | Type | Description |
|---|---|---|
| detail | any | Optional. "compact": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). "full" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"detail": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"compact",
"full"
],
"type": "string"
}
],
"description": "Optional. \"compact\": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). \"full\" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page."
}
}
}Call this when the user asks how hedge funds or institutions are positioned in Bitcoin or Ethereum, or about the CFTC Commitments of Traders report. Returns net positions in contracts, week-over-week changes, open interest and notable extremes/streaks, from official CFTC data updated every Friday. Note: a large share of hedge fund shorts is the market-neutral basis trade, so the weekly change carries more signal than the level.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Call this when the user asks which exchanges sit behind a ByKaranteli number, whether a feed is complete or sampled, since when a venue is collected, or how fresh the data is. Returns the live coverage registry: liquidation feeds per venue with kind and last record, snapshot feeds per venue and market, funding arbitrage legs, positioning sources, whale tape, spot minutes and the Hyperliquid whale scan with freshness. snapshots[].country is the jurisdiction only when the venue states one; it is null for most venues, so do not read null as unknown risk. By default the first 30 snapshot feeds, English notes only and no per-venue matrix cells; pass detail "full" for the full registry. Pass detail "compact" for a shorter page or "full" for the whole answer.
| Argument | Type | Description |
|---|---|---|
| detail | any | Optional. "compact": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). "full" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"detail": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"compact",
"full"
],
"type": "string"
}
],
"description": "Optional. \"compact\": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). \"full\" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page."
}
}
}Call this when the user asks whether Bitcoin is near a cycle top or bottom by the classic indicators, about the Pi Cycle Top, Mayer Multiple, 200-week moving average, 2-year MA multiplier, golden ratio multiple, profitable days, stock-to-flow, Puell Multiple or Bitfinex margin positioning. Returns the latest readings, the Pi Cycle cross dates on record, and optionally the daily series (recomputed nightly from a first-party close record since 2012). Levels, not forecasts.
| Argument | Type | Description |
|---|---|---|
| days | integer | Window in days for the series (default 730) |
| include_points | boolean | Include the daily series (large). Default false: latest values and cross dates only. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"days": {
"type": "integer",
"maximum": 10000,
"minimum": 30,
"description": "Window in days for the series (default 730)"
},
"include_points": {
"type": "boolean",
"description": "Include the daily series (large). Default false: latest values and cross dates only."
}
}
}Call this when the user asks whether ByKaranteli data can be verified or was changed afterwards, about the BYK Data Layer, on-chain proofs of market data, or wants the proof behind one sealed number. Every 5 minutes a catalog of derived feeds (funding composite, aggregate open interest, liquidations, depth within 2%, pressure scores, Kimchi and Turkey premiums) is sealed into one Merkle root, signed and written to Solana mainnet, and attested on Base once a day. With no arguments returns the stream overview: network, epochs and records sealed, final anchors and the newest epochs with explorer links. Pass feed and asset for one record's proof (value, 104-byte leaf, Merkle path, signed manifest, signature, Solana and Base anchors) at the newest epoch or at sequence; sequence alone for one epoch; catalog for the feed list. result ANCHORED means ByKaranteli signed it and an anchor is final; the protocol verdict is reached from the chains alone at https://bykaranteli.com/proof.
| Argument | Type | Description |
|---|---|---|
| feed | string | Feed id from the catalog, e.g. BYK.FUNDING.COMPOSITE.B |
| asset | string | Asset of the feed: BTC, ETH, SOL, XRP, DOGE, BNB, USDT or ALL |
| catalog | boolean | true: list every sealed feed with its unit and methodology |
| sequence | integer | Epoch sequence; omit for the newest |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"feed": {
"type": "string",
"pattern": "^BYK\\.[A-Z0-9_.]{3,60}$",
"description": "Feed id from the catalog, e.g. BYK.FUNDING.COMPOSITE.B"
},
"asset": {
"type": "string",
"pattern": "^[A-Z0-9]{2,10}$",
"description": "Asset of the feed: BTC, ETH, SOL, XRP, DOGE, BNB, USDT or ALL"
},
"catalog": {
"type": "boolean",
"description": "true: list every sealed feed with its unit and methodology"
},
"sequence": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Epoch sequence; omit for the newest"
}
}
}Call this when the user asks what happened in crypto derivatives today or on a date, what the desk observed, what moved in funding, open interest, liquidations, options, ETF flows or exchange premiums, or wants a dated, quotable sentence with its number and time. Returns the desk's notes newest first: each is one observation written by the desk writer (an AI model) from the platform's own recorded data and checked against it before publishing, with its publish time in UTC, the card's data time, the desk's 0 to 10 news value, the board it read from, the coins it names and its permanent URL. Information about the data, never advice. Default the newest 25 notes of the last 24 hours (count says how many came back; limit up to 100 for more); pass day for one UTC day, since for a window up to 7 days back (50 notes unless limit says otherwise), type for one card type (funding-arb, liqmap-btc, event-liq-burst, ...), lang for zh, ru or ko text. Pass detail "compact" for a shorter page or "full" for the whole answer.
| Argument | Type | Description |
|---|---|---|
| day | string | One UTC day, YYYY-MM-DD |
| lang | string | Text language (default en); a note without that translation comes back in English |
| type | string | One card type, e.g. funding-arb, liqmap-btc, event-liq-burst |
| limit | integer | Notes to return, 1..100 (default 25 for the last 24 hours, 50 with day or since) |
| since | string | ISO time; notes published at or after it, at most 7 days back (ignored with day) |
Call this when the user asks about Bitcoin, Ethereum, Solana or XRP spot ETF flows: daily net inflows or outflows, cumulative flow since launch, or total net assets of the US spot ETFs (IBIT, FBTC, ETHA, XRPC and the rest). Returns one row per finalized US trading day and asset with net inflow, total net assets, cumulative inflow since launch and value traded, all in USD. History by asset: BTC and ETH since 2025-05-20, SOL since 2025-10-28, XRP since 2026-09-08.
| Argument | Type | Description |
|---|---|---|
| days | integer | How many most recent trading days to return (default 10). |
| asset | string | Filter to one asset (BTC, ETH, SOL or XRP). Omit for all. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"days": {
"type": "integer",
"maximum": 400,
"minimum": 1,
"description": "How many most recent trading days to return (default 10)."
},
"asset": {
"enum": [
"BTC",
"ETH",
"SOL",
"XRP"
],
"type": "string",
"description": "Filter to one asset (BTC, ETH, SOL or XRP). Omit for all."
}
}
}Call this when the user asks which indicators currently sit in an unusual band, whether a metric's current level historically preceded BTC moves, or for a cross-metric conditional overview. Returns every recorded metric in its historical band with the median 7-day BTC move that followed versus the base rate, with an n >= 30 gate; distributions, not forecasts. Without limit the first 40 rows in the board's own order (rows_total counts every row, trimmed names the cut); pass limit up to 400 for the whole board. Pass detail "compact" for a shorter page or "full" for the whole answer.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Optional. Rows to return, 1..400 (default 40) |
| detail | any | Optional. "compact": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). "full" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 400,
"minimum": 1,
"description": "Optional. Rows to return, 1..400 (default 40)"
},
"detail": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"compact",
"full"
],
"type": "string"
}
],
"description": "Optional. \"compact\": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). \"full\" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page."
}
}
}Call this when the user asks what an exchange charges to trade, how maker and taker fees compare across venues, whether a venue changed its fees, or what a round trip costs on a given notional. Returns base tier maker and taker per venue and market type (median across pairs where the venue prices per pair) and the fee change log, read daily by ByKaranteli from each venue's own fee endpoint.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Call this when the user asks whether informed or toxic order flow is building, about VPIN, or whether market makers are under pressure in Bitcoin, Ethereum or Solana. Returns the current VPIN (0 = balanced, 1 = fully one-sided), its 90-day percentile, the danger threshold and the 24h average. Elevated readings historically precede volatility; VPIN says nothing about direction.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Call this when the user asks what Bitcoin does on Fed days, how FOMC statements move crypto, or when the next FOMC meeting is. Returns per-statement 5/30/60-minute BTC reactions measured from a minute-resolution record, the average move versus a normal half hour, the up/down split (near a coin flip), and the next meeting date. Description, not prediction.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Call this when the user asks about funding arbitrage, funding rate differences between exchanges, or delta-neutral carry trades. Compares funding across every venue on the board, from Binance, OKX and Bybit to Hyperliquid, dYdX and the smaller perp venues fed by the venue snapshot, for 12 major perps and returns the best long/short venue per symbol with gross and net annualized APR (net of taker fees and weekly rebalance cost). Each row lists its first 5 venue legs; pass symbol for every leg of one perp. Pass detail "compact" for a shorter page or "full" for the whole answer.
| Argument | Type | Description |
|---|---|---|
| detail | any | Optional. "compact": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). "full" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page. |
| symbol | string | Optional. One perp, e.g. BTCUSDT or BTC: its row with every venue leg. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"detail": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"compact",
"full"
],
"type": "string"
}
],
"description": "Optional. \"compact\": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). \"full\" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page."
},
"symbol": {
"type": "string",
"description": "Optional. One perp, e.g. BTCUSDT or BTC: its row with every venue leg."
}
}
}Call this when the user asks for the full current funding table across the ~30 most traded Binance perps (28-30 rows; contracts without a live funding print are skipped), or the funding rate of one specific coin. For a pre-ranked top-10 of the most extreme funding rates, use get_top_movers instead. Returns per-symbol funding rate (per settlement interval), 24h open interest change and 24h price change for the most traded Binance USDT-M perpetuals. Positive funding means longs pay shorts.
| Argument | Type | Description |
|---|---|---|
| symbol | string | Optional. Filter to one symbol, e.g. BTCUSDT or just BTC. Omit to get all 30 rows. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"symbol": {
"type": "string",
"description": "Optional. Filter to one symbol, e.g. BTCUSDT or just BTC. Omit to get all 30 rows."
}
}
}Call this when the user asks where Hyperliquid whales would be liquidated, how much tracked notional sits at each price, how the largest accounts lean on a coin, or how their liquidation prices compare with the LiqMap model. The universe is the largest accounts by equity on Hyperliquid's public leaderboard, scanned every five minutes; the levels are their own liquidation prices bucketed around the mark. hours returns the hourly archive of level totals.
| Argument | Type | Description |
|---|---|---|
| coin | string | Coin as Hyperliquid names it, e.g. BTC, ETH, SOL (default BTC) |
| hours | integer | Hours of archive to return, 1..720 (default 24) |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"coin": {
"type": "string",
"pattern": "^[A-Z0-9]{1,24}$",
"description": "Coin as Hyperliquid names it, e.g. BTC, ETH, SOL (default BTC)"
},
"hours": {
"type": "integer",
"maximum": 720,
"minimum": 1,
"description": "Hours of archive to return, 1..720 (default 24)"
}
}
}Call this when the user asks what Hyperliquid whales are doing, whether the biggest Hyperliquid accounts are net long or short a coin, for the largest open positions with liquidation prices, or what large accounts just opened, closed or flipped. Returns the live board of the 300 largest accounts by equity (scanned every 5 minutes, addresses only) and with events the last 200 position changes. Without coin, the 30 largest coins and positions; pass coin, or limit (up to 200) for more. Pass detail "compact" for a shorter page or "full" for the whole answer.
| Argument | Type | Description |
|---|---|---|
| coin | string | One coin, e.g. BTC |
| limit | integer | Optional. Coins and positions without coin, largest first (default 30). |
| detail | any | Optional. "compact": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). "full" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page. |
| events | boolean | Include the last 200 position change events |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"coin": {
"type": "string",
"pattern": "^[A-Z0-9]{1,24}$",
"description": "One coin, e.g. BTC"
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Optional. Coins and positions without coin, largest first (default 30)."
},
"detail": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"compact",
"full"
],
"type": "string"
}
],
"description": "Optional. \"compact\": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). \"full\" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page."
},
"events": {
"type": "boolean",
"description": "Include the last 200 position change events"
}
}
}Call this when the user asks how big an exchange's insurance fund is, whether a fund is shrinking or was used after a crash, how much exchanges hold to absorb bankrupt liquidations, or how a fund compares with the venue's open interest. Returns the latest hourly reading per covered venue (every exchange the insurance fund board lists): the fund in USD (OKX's own published total, the sum of priced pools elsewhere), per asset, 24h and 7d change, the fund as a percent of the venue's perpetual open interest on the coins ByKaranteli tracks, and daily closes per venue. Set pools to include every pool row (the contracts it covers, asset, balance, USD). A fund is a balance the venue reports, not an audit of its reserves.
| Argument | Type | Description |
|---|---|---|
| pools | boolean | Include every pool row (large for Binance and Bybit). Default false. |
| venue | string | One venue; omit for every covered venue. |
| history_days | integer | Days of daily closes (default 30, max 366). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"pools": {
"type": "boolean",
"description": "Include every pool row (large for Binance and Bybit). Default false."
},
"venue": {
"enum": [
"binance",
"bybit",
"okx",
"gate"
],
"type": "string",
"description": "One venue; omit for every covered venue."
},
"history_days": {
"type": "integer",
"maximum": 366,
"minimum": 1,
"description": "Days of daily closes (default 30, max 366)."
}
}
}Call this when the user asks about implied volatility by strike or expiry, skew, put versus call IV, term structure of IV, or whether downside protection is expensive. Returns the IV surface (expiry x moneyness), per-expiry ATM / 25-delta put and call IV, skew and butterfly, and the constant-30d history, from the daily Deribit chain.
| Argument | Type | Description |
|---|---|---|
| currency | string | BTC or ETH, default BTC |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"currency": {
"enum": [
"BTC",
"ETH"
],
"type": "string",
"description": "BTC or ETH, default BTC"
}
}
}Call this when the user asks about Jupiter perpetuals on Solana: long versus short open interest per market (SOL, ETH, BTC) read from the on-chain custody state, pool utilization and hourly borrow rates, JLP pool AUM and APR, 24h volume, or the week's top traders by realized PnL. Pass base and history_days for the hourly OI history.
| Argument | Type | Description |
|---|---|---|
| base | string | Market base: SOL, ETH or BTC |
| history_days | integer | Include hourly OI history for the base, 1..30 days |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"base": {
"type": "string",
"pattern": "^(SOL|ETH|BTC)$",
"description": "Market base: SOL, ETH or BTC"
},
"history_days": {
"type": "integer",
"maximum": 30,
"minimum": 1,
"description": "Include hourly OI history for the base, 1..30 days"
}
}
}Call this when the user asks which exchange leads price discovery or whether spot or perp moves first. Returns per-pair daily cross-correlations of one-minute returns at lags -3..+3 and the lead asymmetry, with the share of days each venue led. Each pair's daily rows cover the last 7 days (its summary covers the whole window); pass days (up to 30) for more.
| Argument | Type | Description |
|---|---|---|
| days | integer | Optional. Daily rows per pair, newest kept (default 7, up to 30). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"days": {
"type": "integer",
"maximum": 30,
"minimum": 1,
"description": "Optional. Daily rows per pair, newest kept (default 7, up to 30)."
}
}
}Call this when the user asks how much leverage an exchange allows on a coin, what the maintenance margin or risk limit ladder is, which venue offers the highest leverage for a symbol, or whether an exchange recently cut leverage. Returns the current ladder per venue (tier, notional floor and cap, max leverage, maintenance margin rate) recorded daily by ByKaranteli, plus a change log. Pass symbol for one base asset (e.g. SOL) and venue for one exchange (bybit, okx, gate, htx, bitget, mexc). Without symbol, the first 30 rows of each list and the first 5 tiers of each ladder; pass symbol for every tier, or limit (up to 300).
| Argument | Type | Description |
|---|---|---|
| limit | integer | Optional. Rows per list without symbol (default 30). |
| venue | string | string, optional venue id, e.g. bybit |
| symbol | string | string, optional base asset, e.g. BTC |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 300,
"minimum": 1,
"description": "Optional. Rows per list without symbol (default 30)."
},
"venue": {
"type": "string",
"description": "string, optional venue id, e.g. bybit"
},
"symbol": {
"type": "string",
"description": "string, optional base asset, e.g. BTC"
}
}
}Call this when the user asks where liquidation clusters or liquidity pools sit for a perpetual, where leveraged longs/shorts would get liquidated, or for a liquidation heatmap reading. Returns the LiqMap snapshot for one symbol: modeled liquidation levels by price, zone aggregates and real liquidation prints from every liquidation venue ByKaranteli counts (listed on bykaranteli.com/coverage). On the Free plan the 24h view; on Builder and higher plans every timeframe from 1h to 30d. By default the 30 real levels nearest the price and the 30 largest real prints; pass detail "full" for all of them. Pass detail "compact" for a shorter page or "full" for the whole answer.
| Argument | Type | Description |
|---|---|---|
| detail | any | Optional. "compact": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). "full" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page. |
| symbol | string | Symbol like BTCUSDT (bare BTC accepted). Default BTCUSDT. |
| timeframe | string | Model window. Default 24h, the only one on the Free plan; Builder and higher plans get every window. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"detail": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"compact",
"full"
],
"type": "string"
}
],
"description": "Optional. \"compact\": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). \"full\" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page."
},
"symbol": {
"type": "string",
"pattern": "^[A-Z0-9]{2,20}$",
"description": "Symbol like BTCUSDT (bare BTC accepted). Default BTCUSDT."
},
"timeframe": {
"enum": [
"1h",
"4h",
"12h",
"24h",
"3d",
"1w",
"30d"
],
"type": "string",
"description": "Model window. Default 24h, the only one on the Free plan; Builder and higher plans get every window."
}
}
}Call this when the user asks what caused a recent crash or flush, about liquidation cascades, or who got liquidated. Returns auto-detected cascade incidents: when, total notional flushed, long/short split, which coins led, and BTC's move during the window. Totals are an honestly-labeled lower bound from a real liquidation tape.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Call this when the user asks for the biggest liquidation today or this week, who got liquidated for the most, the largest single liquidation print, or when in the day or week liquidations cluster (Asia, Europe or US hours, weekday by UTC hour). Returns the largest single liquidation prints of the last 24h, 7d or 30d (rank, symbol, venue, side where SELL means a long was liquidated, price, quantity, notional, millisecond time) recorded from the counted venues' public feeds, plus a 30-day weekday by UTC hour heatmap with hour, weekday and session totals. Binance publishes at most one print per second per symbol, so its rows are a floor.
| Argument | Type | Description |
|---|---|---|
| days | integer | Days folded into the session heatmap (default 30). |
| limit | integer | Rows to return (default 25, max 100). |
| window | string | Ranking window: 24h (default), 7d or 30d. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"days": {
"type": "integer",
"maximum": 90,
"minimum": 7,
"description": "Days folded into the session heatmap (default 30)."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Rows to return (default 25, max 100)."
},
"window": {
"enum": [
"24h",
"7d",
"30d"
],
"type": "string",
"description": "Ranking window: 24h (default), 7d or 30d."
}
}
}Call this when the user asks how much was liquidated in crypto futures, whether longs or shorts got flushed, or for liquidation history. Returns daily long and short liquidation totals in USD per symbol and exchange, recorded from ByKaranteli's own stream collectors on every liquidation venue it counts, listed on bykaranteli.com/coverage (recorded events, a floor, not estimates). One row per finalized UTC day, symbol and exchange; history begins 2026-07-30 and grows daily. Without symbol, rows holds the first 30 rows (newest day, largest first) while summary covers every matching row; pass symbol or limit (up to 400) for more rows.
| Argument | Type | Description |
|---|---|---|
| days | integer | How many most recent days to return (default 7). |
| limit | integer | Optional. Rows to return, newest day first and largest first within a day (default 30 without symbol, 400 with one). |
| symbol | string | Optional symbol filter like BTCUSDT or ETHUSDT. Omit for all symbols. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"days": {
"type": "integer",
"maximum": 90,
"minimum": 1,
"description": "How many most recent days to return (default 7)."
},
"limit": {
"type": "integer",
"maximum": 400,
"minimum": 1,
"description": "Optional. Rows to return, newest day first and largest first within a day (default 30 without symbol, 400 with one)."
},
"symbol": {
"type": "string",
"pattern": "^[A-Z0-9]{2,20}$",
"description": "Optional symbol filter like BTCUSDT or ETHUSDT. Omit for all symbols."
}
}
}Call this when the user asks about macro liquidity, the Fed balance sheet, reverse repo, rates or stablecoin supply in relation to crypto. Returns the recorded daily series and latest values. Without days, each series holds its newest 7 points; pass days for the daily series, and series for one key over a long window.
| Argument | Type | Description |
|---|---|---|
| days | integer | Window in days, 30-4000; the route clamps to that range. Omit for the newest 7 points of each series. |
| series | string | Optional. One series key from the answer's series field, e.g. fred_walcl_busd. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"days": {
"type": "integer",
"maximum": 4000,
"minimum": 30,
"description": "Window in days, 30-4000; the route clamps to that range. Omit for the newest 7 points of each series."
},
"series": {
"type": "string",
"pattern": "^[a-z0-9_]{2,60}$",
"description": "Optional. One series key from the answer's series field, e.g. fred_walcl_busd."
}
}
}Call this when the user asks about overall crypto market sentiment or macro state: the Fear & Greed index (today and yesterday), Bitcoin dominance percentage, total market cap, or the Retail Euphoria composite. Live values refreshed about every 30 minutes.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Call this when the user asks about a perpetual's Market Profile, TPO profile, point of control (POC), value area (VAH, VAL), initial balance or naked (untested) points of control. Returns one row per closed UTC day from ByKaranteli's own one-minute bars of the Binance USDT-M perpetual (30-minute TPO periods, buckets of 0.05% of the day's open, 70% value area, first-hour initial balance, volume point of control), the naked points of control of the last 60 recorded days and the latest day's profile per price bucket. Symbols without recorded minute bars return no_profile.
| Argument | Type | Description |
|---|---|---|
| days | integer | Closed UTC days, newest first, 1..30 (default 7) |
| symbol | string | Ticker such as BTC or BTCUSDT (default BTC) |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"days": {
"type": "integer",
"maximum": 30,
"minimum": 1,
"description": "Closed UTC days, newest first, 1..30 (default 7)"
},
"symbol": {
"type": "string",
"pattern": "^[A-Z0-9]{2,20}$",
"description": "Ticker such as BTC or BTCUSDT (default BTC)"
}
}
}Call this when the user asks whether a metric's current reading is high or low, or what happened after similar readings. Buckets today's value against the metric's own recorded daily history and returns the median forward BTC return and up-share per bucket at +1/+3/+7 days, with the all-days base rate alongside. Honesty rules: buckets under 30 days are suppressed, and most metrics do NOT separate from the base rate; the interpretation says so plainly. History, not a forecast. Metrics include coinbase_premium_pct, kraken_btc_premium_pct, dvol_btc, fear_greed, funding_btc_daily_pct, etf_btc_net_flow_usd, vpin_btc, altseason_index, stablecoin_total_mcap_busd, fred_dff, fred_dgs10, fred_walcl_busd, fred_rrp_busd and the btc_* network series.
| Argument | Type | Description |
|---|---|---|
| metric* | string | Metric key, e.g. coinbase_premium_pct, fear_greed, altseason_index, stablecoin_total_mcap_busd. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"metric"
],
"properties": {
"metric": {
"type": "string",
"pattern": "^[a-z0-9_]{2,50}$",
"description": "Metric key, e.g. coinbase_premium_pct, fear_greed, altseason_index, stablecoin_total_mcap_busd."
}
}
}Call this when the user asks about Bitcoin hashrate, difficulty or block fees (our node runs blocksonly, so there is no mempool series). Returns the recorded daily series and latest values measured on ByKaranteli's own node. Without days, each series holds its newest 7 points; pass days for the daily series, and series for one key over a long window.
| Argument | Type | Description |
|---|---|---|
| days | integer | Window in days, 30-4000; the route clamps to that range. Omit for the newest 7 points of each series. |
| series | string | Optional. One series key from the answer's series field, e.g. btc_hashrate_ehs. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"days": {
"type": "integer",
"maximum": 4000,
"minimum": 30,
"description": "Window in days, 30-4000; the route clamps to that range. Omit for the newest 7 points of each series."
},
"series": {
"type": "string",
"pattern": "^[a-z0-9_]{2,60}$",
"description": "Optional. One series key from the answer's series field, e.g. btc_hashrate_ehs."
}
}
}Call this when the user asks what new perpetuals were listed, which exchange listed a coin first, or about delistings. Returns listings and delistings across every exchange the hourly scan covers. Pass detail "compact" for a shorter page or "full" for the whole answer.
| Argument | Type | Description |
|---|---|---|
| days | integer | Window in days, 1-30 (default 30). Longer listing history is the listings dataset at bykaranteli.com/data. |
| detail | any | Optional. "compact": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). "full" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"days": {
"type": "integer",
"maximum": 30,
"minimum": 1,
"description": "Window in days, 1-30 (default 30). Longer listing history is the listings dataset at bykaranteli.com/data."
},
"detail": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"compact",
"full"
],
"type": "string"
}
],
"description": "Optional. \"compact\": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). \"full\" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page."
}
}
}Call this when the user asks whether leverage is entering or leaving the market, about open interest changes, or whether longs or shorts are building in a major coin. Returns 5-minute-resolution OI with 24h OI and price deltas and a four-regime read per symbol: longs building, shorts building, long squeeze, short squeeze, or quiet.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Call this when the user asks how the BTC or ETH option chain moved today or over the last day: open interest and mark IV per expiry and strike from ByKaranteli's own hourly capture of every listed venue, the change over the last hour and the last 24 hours, and the front expiry's ATM IV hour by hour. The Free plan lists the largest strikes; Builder and higher plans list every strike. Recorded from 2026-09-30, so the first days carry a short history.
| Argument | Type | Description |
|---|---|---|
| venue | string | One venue or all (default all) |
| expiry | string | Expiry as DDMONYY, e.g. 31OCT26 (default: every expiry) |
| strikes | string | top (largest strikes) or all (Builder and higher plans) |
| currency | string | BTC or ETH (default BTC) |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"venue": {
"enum": [
"all",
"deribit",
"bybit",
"binance",
"okx",
"delta"
],
"type": "string",
"description": "One venue or all (default all)"
},
"expiry": {
"type": "string",
"pattern": "^\\d{1,2}[A-Z]{3}\\d{2}$",
"description": "Expiry as DDMONYY, e.g. 31OCT26 (default: every expiry)"
},
"strikes": {
"enum": [
"top",
"all"
],
"type": "string",
"description": "top (largest strikes) or all (Builder and higher plans)"
},
"currency": {
"enum": [
"BTC",
"ETH"
],
"type": "string",
"description": "BTC or ETH (default BTC)"
}
}
}Call this when the user asks what big options players are buying, about block trades, or whether call or put premium dominates today. Returns 24h call vs put premium bought (net of the sold legs of the same multi-leg block or combo, so a spread counts its net premium), the block-trade share, the multi-leg structure count, and the largest prints of the last 48 hours with strikes, premium, IV, structure id and venue (Deribit or OKX). Updated every 15 minutes. Pass detail "compact" for a shorter page or "full" for the whole answer.
| Argument | Type | Description |
|---|---|---|
| detail | any | Optional. "compact": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). "full" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"detail": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"compact",
"full"
],
"type": "string"
}
],
"description": "Optional. \"compact\": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). \"full\" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page."
}
}
}Call this when the user asks where the big options bets sit, about call/put walls, gamma exposure (GEX), the zero-gamma level, implied volatility (DVOL) or the IV term structure for Bitcoin or Ethereum, across options venues or on one venue. Daily snapshot of the listed option chains of every options venue we record, summed by default or one venue with venue: the call wall (largest call open interest above spot) and put wall (largest put open interest below spot), the largest bars on the whole axis, top strikes by open interest, put/call ratio, dealer hedging map, ATM IV by expiry (calls and puts interpolated at the money, iv_source names the venue whose quotes price the chain), each venue's open interest (venues_included), and per expiry the open interest by side, the max pain strike (where the open contracts as a group pay out the least at settlement, not a price target) and the one-sigma implied move the ATM IV prices (expiries). DVOL is Deribit's index whatever the venue.
| Argument | Type | Description |
|---|---|---|
| venue | string | all (default) sums every options venue; or one venue id: deribit, bybit, binance, okx or delta (Delta Exchange India). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"venue": {
"enum": [
"all",
"deribit",
"bybit",
"binance",
"okx",
"delta"
],
"type": "string",
"description": "all (default) sums every options venue; or one venue id: deribit, bybit, binance, okx or delta (Delta Exchange India)."
}
}
}Call this when the user asks where the bid or ask walls are, how deep the spot order book is, whether buyers or sellers have more resting orders near price, or for an order book heatmap. Returns the books of every spot venue with a public book that the coverage page lists, binned into 0.1% buckets within 20% of mid (USD notional), the largest walls with venue split, 2% depth and book reach per venue, and optionally the summed 5-minute history; coins: BTC, ETH, SOL, XRP, DOGE, ADA, LINK, AVAX, LTC, BNB. Books whose size is not corroborated are recorded and returned per venue with in_aggregate false (listed in held_out) but not summed into the walls, 2% depth or history.
| Argument | Type | Description |
|---|---|---|
| hours | integer | Include the summed 5-minute history for this many hours |
| symbol | string | One coin, e.g. BTC (default BTC) |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"hours": {
"type": "integer",
"maximum": 24,
"minimum": 1,
"description": "Include the summed 5-minute history for this many hours"
},
"symbol": {
"type": "string",
"pattern": "^[A-Z0-9]{2,12}$",
"description": "One coin, e.g. BTC (default BTC)"
}
}
}Call this when the user asks about the long/short ratio, whether retail or top traders are net long or short, the taker buy/sell ratio, or CVD (cumulative volume delta) for a perpetual. Returns exchange-published statistics for the 30 most traded Binance USDT perps on every perpetual venue the positioning board records (Binance global and top-trader ratios, Bybit share long, OKX ratios and taker volume, Gate account and top-trader ratios, HTX elite ratios, Bitget account and position ratios) and CVD series for BTC, ETH and SOL; refreshed every 15 minutes. Without symbol, the 10 most traded perps and the newest 24 points of each CVD series; pass symbol, limit or cvd_points for more. Pass detail "compact" for a shorter page or "full" for the whole answer.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Optional. Perps without symbol, most traded first (default 10, up to 30). |
| detail | any | Optional. "compact": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). "full" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page. |
| symbol | string | One Binance symbol, e.g. BTCUSDT |
| cvd_points | integer | Optional. Newest points per CVD series (1h and 5m); default 24 without symbol, every point with one. |
Call this when the user asks which coins are crowded or over-leveraged, or asks for the pressure/derivatives-stress score of specific coins. For a quick top-10 ranking of the highest-stress coins right now, use get_top_movers instead. Each symbol gets a 0-100 composite score built from funding rate, 1h/4h/24h open interest deltas and basis, with a LONG/SHORT/NEUTRAL direction and a plain-language regime label.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Optional. Max rows to return when no symbol filter is set (default 20, sorted by score). |
| symbol | string | Optional. Return only this symbol, e.g. BTCUSDT or BTC. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "Optional. Max rows to return when no symbol filter is set (default 20, sorted by score)."
},
"symbol": {
"type": "string",
"description": "Optional. Return only this symbol, e.g. BTCUSDT or BTC."
}
}
}Call this when the user asks about the market's hidden liquidity state, PsiCharge, or whether parked money is deploying or stress is unwinding. Returns the current Psi score (0-100), state (superposition = charge building, collapse = low-stress discharge, purge = high-stress discharge and historically the most consistent risk-off state, ground = ordinary), stress locality, recent alarms and the year-split measured scorecard. Inputs are proprietary; outcomes are always published. Not a trade signal, not a crash predictor.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Call this when the user asks how much Bitcoin is vulnerable to a quantum computer, about quantum-exposed supply, P2PK coins, or Satoshi-era exposure. Returns the latest daily measurement from ByKaranteli's own Bitcoin Core node: exposed BTC and its share of held value and UTXO count, composition by script family, dormancy cohorts, the dormant-P2PK watch set, and provenance hashes (base_height, base_hash, txoutset_hash) so any figure can be re-verified against any node.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Call this when the user asks which coins are overbought or oversold, for a crypto RSI heatmap, multi-timeframe RSI, or one contract's RSI on 15m, 1h, 4h, 12h, 1d, 3d, 1w or 1M. Returns the live board for the top-400 Binance crypto perps by volume plus every TradFi perp, with overbought/oversold counts per interval. Filter by symbol or kind (crypto|tradfi), sort by an interval. Without symbol, the first 30 rows (by volume, or by the sort interval); pass limit (up to 400) for more, or order asc with sort for the most oversold first.
| Argument | Type | Description |
|---|---|---|
| kind | string | crypto | tradfi |
| sort | string | Interval to sort by, descending |
| limit | integer | Optional. Rows without symbol (default 30). |
| order | string | Optional. With sort: desc (default, most overbought first) or asc (most oversold first). |
| symbol | string | One Binance symbol, e.g. BTCUSDT |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"kind": {
"enum": [
"crypto",
"tradfi"
],
"type": "string",
"description": "crypto | tradfi"
},
"sort": {
"enum": [
"15m",
"1h",
"4h",
"12h",
"1d",
"3d",
"1w",
"1M"
],
"type": "string",
"description": "Interval to sort by, descending"
},
"limit": {
"type": "integer",
"maximum": 400,
"minimum": 1,
"description": "Optional. Rows without symbol (default 30)."
},
"order": {
"enum": [
"desc",
"asc"
],
"type": "string",
"description": "Optional. With sort: desc (default, most overbought first) or asc (most oversold first)."
},
"symbol": {
"type": "string",
"pattern": "^[A-Z0-9]{2,24}$",
"description": "One Binance symbol, e.g. BTCUSDT"
}
}
}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.
| Argument | Type | Description |
|---|---|---|
| to | string | 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 |
| from | string | string, optional ISO start, e.g. 2026-09-01T00:00:00Z |
| limit | number | number, optional newest bars, 10..5000; the plan's depth caps it (default 300 without from) |
Call this when the user asks what futures or options expire soon, when the next quarterly expiry is on an exchange, how many contracts settle this week, or at what price a dated future settled. Returns the next 60 days of dated future and option expiries grouped by date, venue and underlying from 54 venues' market lists, plus the settlement prices recorded as dated futures deliver. Without base, the first 30 expiry rows and the 30 newest settlement prices; pass base for one asset's full lists, or limit (up to 300).
| Argument | Type | Description |
|---|---|---|
| base | string | Optional. One underlying, e.g. BTC: every expiry row and settlement price of that asset. |
| limit | integer | Optional. Rows per list without base (default 30): expiries soonest first, settlements newest first. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"base": {
"type": "string",
"pattern": "^[A-Z0-9]{1,16}$",
"description": "Optional. One underlying, e.g. BTC: every expiry row and settlement price of that asset."
},
"limit": {
"type": "integer",
"maximum": 300,
"minimum": 1,
"description": "Optional. Rows per list without base (default 30): expiries soonest first, settlements newest first."
}
}
}Call this when the user asks how much slippage a trade of a given size would face, how thick the books are, or which major perp market is thinnest right now. Returns live cost ladders in basis points for $10K to $5M market orders across 8 major perpetuals, both sides, from the full visible order book. Excludes fees; null = the book cannot absorb that size.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Call this when the user asks about perpetuals on Solana as a whole, which Solana perp DEX has the most open interest or volume, a market on Pacifica, Phoenix, GM Trade (GMX on Solana), Velocity (the Drift relaunch) or Bullet (funding, open interest, 24h volume, mark), or how Jupiter compares with the order-book venues. Returns the board read every 10 minutes: per-venue totals (one-sided open interest, both sides on pool venues, 24h volume, market count, median hourly rate, as_of), every market of every venue largest first with instrument type (perpetual, equity, index, commodity, fx), and optional hourly history of one market on any venue but Jupiter (7 days on the Free plan, 30 on Builder and higher plans; Jupiter history is get_jupiter_perps). Without venue, the 30 largest markets; pass venue, or limit (up to 300) for more.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Optional. Markets without venue, largest first (default 30). |
| venue | string | Venue filter: jupiter, pacifica, phoenix, gmtrade, velocity or bullet |
| symbol | string | Market symbol on the chosen venue (Pacifica when venue is not given) for hourly history, as the board lists it, e.g. SOL, SOL-PERP, SOL-USD, kBONK |
| history_days | integer | Hourly history for the symbol, 1..30 days |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 300,
"minimum": 1,
"description": "Optional. Markets without venue, largest first (default 30)."
},
"venue": {
"type": "string",
"pattern": "^(jupiter|pacifica|phoenix|gmtrade|velocity|bullet)$",
"description": "Venue filter: jupiter, pacifica, phoenix, gmtrade, velocity or bullet"
},
"symbol": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]{1,24}$",
"description": "Market symbol on the chosen venue (Pacifica when venue is not given) for hourly history, as the board lists it, e.g. SOL, SOL-PERP, SOL-USD, kBONK"
},
"history_days": {
"type": "integer",
"maximum": 30,
"minimum": 1,
"description": "Hourly history for the symbol, 1..30 days"
}
}
}Call this when the user asks which crypto narrative or sector is leading, about rotation between AI, RWA, DePIN, memecoins, layer 1, layer 2, DeFi or quantum coins, or for a theme index. Returns eight equal-weight fixed-basket indices rebased to 100 on 2025-01-01 with 1d/7d/30d/90d/YTD returns, vs BTC, and the member lists; daily points are omitted unless include_points is true.
| Argument | Type | Description |
|---|---|---|
| include_points | boolean | boolean, optional: include the daily index points (large) |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"include_points": {
"type": "boolean",
"description": "boolean, optional: include the daily index points (large)"
}
}
}Call this when the user asks about tokenized stocks or stock tokens (xStocks, Ondo, Robinhood stock tokens, Coinbase tokenized stocks on Base, Binance bStocks, Backpack, Gate gStocks, Reality, Superstate, Figure, Dinari dShares, Securitize): how much of a stock exists onchain, which issuer or chain holds the most, whether a wrapper trades above or below the real share, which DEX pools or exchanges trade it. Returns the board ByKaranteli refreshes every 10 minutes: per underlying the reference share price and its session, each wrapper (issuer, chain, price, premium_pct against a fresh reference, DEX liquidity and 24h volume from admitted pools, supply in shares and dollars, holders, status), tokenized spot pairs on the exchanges the board lists, the perpetual futures cross, and totals (supply by issuer and chain, DEX volume, median premium). Each wrapper's price_source names the price that valued its supply dollars (reference: the share's reference price; issuer_oracle: the issuer's own price for the token; wrapper: its own pool or exchange price; null: no dollars), and totals.priced_by counts the counted wrappers per level, unpriced included. Wrappers come from issuer sources only, never from a name search. Without underlying, each stock lists its first 3 wrappers and 3 exchange pairs; pass underlying for all of them. Pass detail "compact" for a shorter page or "full" for the whole answer.
| Argument | Type | Description |
|---|---|---|
| top | integer | Rows by supply (default 10, max 200). |
| chain | string | One chain, e.g. solana, base, bnb, robinhood, ethereum, ton, all (xStocks circulating) or cex (exchange pairs). |
| detail | any | Optional. "compact": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). "full" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page. |
Call this when the user asks what is moving in crypto derivatives right now, which coins have the biggest open interest changes, the most extreme funding, the widest basis, or the highest derivatives stress. Returns four top-10 lists in one call.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Call this when the user asks about stock perpetuals (TSLA, NVDA, AAPL, gold, S&P 500...), tokenized-equity perps, TradFi perp funding rates, open interest, liquidations, which exchanges list a stock perp, or whether the equity session is open. Returns Binance's TradFi perpetual board: per contract mark, index, basis, funding, 24h change and volume, open interest, 24h recorded liquidations, other venues listing the same underlying, and the trading-session state per market. Filter by market (EQUITY, HK_EQUITY, KR_EQUITY, CN_EQUITY, COMMODITY, INDEX, PREMARKET) or one symbol. Without symbol, the first 30 contracts by open interest; pass symbol, or limit (up to 150) for more.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Optional. Contracts without symbol, largest open interest first (default 30). |
| market | string | Market filter: EQUITY | HK_EQUITY | KR_EQUITY | CN_EQUITY | COMMODITY | INDEX | PREMARKET |
| symbol | string | One Binance TradFi symbol, e.g. TSLAUSDT |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 150,
"minimum": 1,
"description": "Optional. Contracts without symbol, largest open interest first (default 30)."
},
"market": {
"type": "string",
"pattern": "^[A-Z_]{3,16}$",
"description": "Market filter: EQUITY | HK_EQUITY | KR_EQUITY | CN_EQUITY | COMMODITY | INDEX | PREMARKET"
},
"symbol": {
"type": "string",
"pattern": "^[A-Z0-9]{2,24}$",
"description": "One Binance TradFi symbol, e.g. TSLAUSDT"
}
}
}Call this when the user asks what a stock, index or commodity perpetual did over the weekend or overnight while the cash market was closed, how far it sat from the last cash close at each checkpoint, how the venues disagreed, and what gap the next open then realised. From ByKaranteli's own ten-minute venue record; window weekend or night; one symbol or the whole board. Without symbol, the first 15 underlyings of the summary and of the latest window; pass symbol, or limit (up to 60) for more.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Optional. Underlyings without symbol, in the board's order, for the summary and the latest window (default 15, up to 60). |
| symbol | string | One underlying, e.g. TSLA or XAU (default: the whole board) |
| window | string | weekend (Friday close to Monday open) or night (cash close to next open); default weekend |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 60,
"minimum": 1,
"description": "Optional. Underlyings without symbol, in the board's order, for the summary and the latest window (default 15, up to 60)."
},
"symbol": {
"type": "string",
"pattern": "^[A-Z0-9.]{1,24}$",
"description": "One underlying, e.g. TSLA or XAU (default: the whole board)"
},
"window": {
"enum": [
"weekend",
"night"
],
"type": "string",
"description": "weekend (Friday close to Monday open) or night (cash close to next open); default weekend"
}
}
}Call this when the user asks about Bitcoin, Ether or USDT prices in Turkish lira, the Turkey premium, the USDT/TRY rate or dollar premium in Turkey, or which Turkish exchanges (BtcTurk, Bitlo, CoinTR, OKX TR, Binance TR, Bybit TR, Bitexen; KuCoin TR contributes the USDT pairs only) trade above or below the global price. Returns the live board: the Turkey Premium Index (what a lira buyer pays for bitcoin against the global dollar price at the official exchange rate, in bps) with its dollar leg and crypto leg, a 0-100 score (50 = world price) and regime, 24h and 7d averages and the same-sign streak; then five reference prices (median of eligible order books), per-venue book status, spread, depth and each venue's implied premium. Pass pair and history_days for 15-minute history of one pair. Without pair, the daily rows cover the last 7 days; pass pair, or daily_days (up to 30) for more. Pass detail "compact" for a shorter page or "full" for the whole answer.
| Argument | Type | Description |
|---|---|---|
| pair | string | Pair: BTC-TRY, ETH-TRY, USDT-TRY, BTC-USDT or ETH-USDT |
| detail | any | Optional. "compact": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). "full" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page. |
| daily_days | integer | Optional. Days of daily rows, newest first (default 7 without pair, every recorded day with one). |
| history_days | integer |
Call this when the user asks about total open interest across exchanges, which venues hold the most OI, DEX versus CEX share, funding dispersion between venues, or stablecoin pegs. Returns the latest 10-minute snapshot aggregates across every perpetual and spot feed we poll (the coverage field lists them); pass symbol for one coin's per-venue rows. Without symbol, rows holds the 30 venue markets with the largest open interest; pass symbol, or limit (up to 250) for more. Pass detail "compact" for a shorter page or "full" for the whole answer.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Optional. Venue market rows without symbol, largest open interest first (default 30). |
| detail | any | Optional. "compact": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). "full" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page. |
| symbol | string | string, optional base asset, e.g. BTC |
| history_days | integer | Return the hourly multi-venue open interest history (total, DEX share, OI-weighted funding) for this many days instead of the snapshot |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 250,
"minimum": 1,
"description": "Optional. Venue market rows without symbol, largest open interest first (default 30)."
},
"detail": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"compact",
"full"
],
"type": "string"
}
],
"description": "Optional. \"compact\": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). \"full\" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page."
},
"symbol": {
"type": "string",
"description": "string, optional base asset, e.g. BTC"
},
"history_days": {
"type": "integer",
"maximum": 90,
"minimum": 1,
"description": "Return the hourly multi-venue open interest history (total, DEX share, OI-weighted funding) for this many days instead of the snapshot"
}
}
}Call this when the user asks about a specific exchange (Bybit, OKX, Gate, KuCoin, HTX, Bitget, MEXC, BitMEX, Hyperliquid ...): how many contracts it lists, its perp open interest and average funding, its leverage ladders, deposit and withdrawal networks and how many are paused, its base fee schedule, its status uptime and the recent event log (listings, delistings, leverage cuts, withdrawal pauses, incidents). Without venue returns the list of recorded venues.
| Argument | Type | Description |
|---|---|---|
| venue | string | string, optional venue id, e.g. bybit |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"venue": {
"type": "string",
"description": "string, optional venue id, e.g. bybit"
}
}
}Call this when the user asks which exchange sees the most liquidations, how that share moved this week or this month, or how perpetual open interest splits between venues. Shares over one, seven or thirty days from ByKaranteli's own hourly liquidation record (counted venues only, each with the day its record started) and the hourly open interest record.
| Argument | Type | Description |
|---|---|---|
| days | integer | Window in days: 1, 7 or 30 (default 7) |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"days": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Window in days: 1, 7 or 30 (default 7)"
}
}
}Call this when the user asks about whale trades, large market orders, or whether big players are buying or selling right now. Returns recent $1M+ aggressive prints recorded live from our own sockets and 24h aggregates with the buy share.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Call this when the user asks whether an exchange has paused withdrawals or deposits, which networks are open for an asset, what the withdrawal fee or minimum is on each venue, or which venue is cheapest to withdraw from. Without arguments returns the overview (withdrawals paused right now, ranked, plus recent suspension and resumption events). Pass asset (e.g. USDT) for every venue and network of that asset, and venue (e.g. kucoin) to narrow. Recorded daily by ByKaranteli from 20+ venues' public currency lists. The overview lists the first 30 paused networks and the 30 newest events; pass asset, or limit (up to 400) for more.
| Argument | Type | Description |
|---|---|---|
| asset | string | string, optional asset code, e.g. USDT |
| limit | integer | Optional. Rows of the overview lists (paused networks, events) without asset (default 30). |
| venue | string | string, optional venue id, e.g. kucoin |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"asset": {
"type": "string",
"description": "string, optional asset code, e.g. USDT"
},
"limit": {
"type": "integer",
"maximum": 400,
"minimum": 1,
"description": "Optional. Rows of the overview lists (paused networks, events) without asset (default 30)."
},
"venue": {
"type": "string",
"description": "string, optional venue id, e.g. kucoin"
}
}
}Call this when the user asks which alerts they have, whether an alert fired, or before deleting or changing one. Returns the account's alert recipes (id, name, scope, symbols, conditions, cooldown in hours, enabled, last fired, fire count, channels, reachable: whether a delivery channel is set up for it) and channels_available (the delivery channels the account has connected). Needs a signed-in account (OAuth sign-in or account key); reads nothing but this account.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Call this when the user asks which Hyperliquid addresses they follow, or what those addresses hold right now. Returns every followed address with its label, the positions last seen on it and the plan's address limit; following addresses is part of Terminal and the plans above it.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Call this when the user asks what is on their watchlist, which lists they have, or before adding or removing a symbol. Returns the account's watchlists (id, name, symbol count) and, unless include_symbols is false, the symbols on each list in order. Needs a signed-in account (OAuth sign-in or account key); reads nothing but this account.
| Argument | Type | Description |
|---|---|---|
| include_symbols | boolean | boolean, optional: include each list's symbols (default true) |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"include_symbols": {
"type": "boolean",
"description": "boolean, optional: include each list's symbols (default true)"
}
}
}Call this when the user describes an alert in words ("tell me when ETH drops 5% in a day", "BTC funding above 5 bps", "liquidations over $20M in an hour") and you want the exact recipe before creating it. Rule based, nothing is saved: returns recipe (name, scope, symbols, conditions of field, op, value, cooldownHours, channels) or null, confidence 0..1, a one-line summary to confirm with the user, and unresolved (what the text left open or what was assumed; timing words are not part of a recipe). A threshold the text does not state is never invented. English and tickers; at most 500 characters. Pass the returned conditions, scope, symbols and channels to create_alert_recipe once the user agrees.
| Argument | Type | Description |
|---|---|---|
| text* | string | string, the alert in plain English, e.g. "SOL funding below -0.01% or OI up 10%" |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"description": "string, the alert in plain English, e.g. \"SOL funding below -0.01% or OI up 10%\""
}
}
}Call this when the user asks to stop following or tracking a Hyperliquid address. Takes the id from list_tracked_addresses; the address's alerts stop, its recorded events stay.
| Argument | Type | Description |
|---|---|---|
| id* | string | string, the id from list_tracked_addresses |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "string, the id from list_tracked_addresses"
}
}
}Call this when the user asks to stop watching a coin or remove it from their watchlist. Removes the symbol from the list named by watchlist_id, else from the default list (or the only list the account has); a symbol that is not on the list changes nothing. Returns the list's symbols after the change. Writes are rate limited per connection (sign-in or key) and each one is recorded on the account.
| Argument | Type | Description |
|---|---|---|
| symbol* | string | string, the symbol to remove, e.g. SOLUSDT or SOL |
| watchlist_id | string | string, optional list id from list_watchlists (default: the default list) |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"symbol"
],
"properties": {
"symbol": {
"type": "string",
"description": "string, the symbol to remove, e.g. SOLUSDT or SOL"
},
"watchlist_id": {
"type": "string",
"description": "string, optional list id from list_watchlists (default: the default list)"
}
}
}| array |
| array, optional delivery channels: telegram | email | push | webhook; empty means Telegram first, email as fallback |
| threshold | number | number, one condition's threshold, e.g. 0.05 |
| conditions | array | array, optional up to 6 conditions {field, op, value}, all must hold (instead of field, op, threshold) |
| cooldown_hours | number | number, optional 1..168 hours before it fires again (default 24) |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"op": {
"enum": [
">=",
">",
"<=",
"<",
"=="
],
"type": "string",
"description": "string, one condition's comparison: >= | > | <= | < | =="
},
"name": {
"type": "string",
"description": "string, optional name; default describes the condition"
},
"field": {
"type": "string",
"description": "string, one condition's metric, e.g. funding_rate_pct"
},
"scope": {
"enum": [
"watchlist",
"any",
"symbols"
],
"type": "string",
"description": "string, optional: watchlist (default), any, symbols"
},
"symbols": {
"type": "array",
"items": {
"type": "string"
},
"description": "array, optional up to 20 symbols, e.g. [\"BTCUSDT\", \"ETH\"]; implies scope symbols"
},
"channels": {
"type": "array",
"items": {
"enum": [
"telegram",
"email",
"push",
"webhook"
],
"type": "string"
},
"description": "array, optional delivery channels: telegram | email | push | webhook; empty means Telegram first, email as fallback"
},
"threshold": {
"type": "number",
"description": "number, one condition's threshold, e.g. 0.05"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
">=",
">",
"<=",
"<",
"=="
],
"type": "string"
},
"field": {
"type": "string"
},
"value": {
"type": "number"
}
}
},
"description": "array, optional up to 6 conditions {field, op, value}, all must hold (instead of field, op, threshold)"
},
"cooldown_hours": {
"type": "number",
"description": "number, optional 1..168 hours before it fires again (default 24)"
}
}
}| detail | any | Optional. "compact": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). "full" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"day": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "One UTC day, YYYY-MM-DD"
},
"lang": {
"enum": [
"en",
"zh",
"ru",
"ko"
],
"type": "string",
"description": "Text language (default en); a note without that translation comes back in English"
},
"type": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]{0,60}$",
"description": "One card type, e.g. funding-arb, liqmap-btc, event-liq-burst"
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Notes to return, 1..100 (default 25 for the last 24 hours, 50 with day or since)"
},
"since": {
"type": "string",
"maxLength": 40,
"description": "ISO time; notes published at or after it, at most 7 days back (ignored with day)"
},
"detail": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"compact",
"full"
],
"type": "string"
}
],
"description": "Optional. \"compact\": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). \"full\" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 30,
"minimum": 1,
"description": "Optional. Perps without symbol, most traded first (default 10, up to 30)."
},
"detail": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"compact",
"full"
],
"type": "string"
}
],
"description": "Optional. \"compact\": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). \"full\" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page."
},
"symbol": {
"type": "string",
"pattern": "^[A-Z0-9]{2,24}$",
"description": "One Binance symbol, e.g. BTCUSDT"
},
"cvd_points": {
"type": "integer",
"maximum": 288,
"minimum": 1,
"description": "Optional. Newest points per CVD series (1h and 5m); default 24 without symbol, every point with one."
}
}
}| venue | string | string, optional venue id for price, oi, funding or borrow, e.g. okx (default binance) |
| metric* | string | string, metric key, e.g. price, oi, funding, liquidations (list: /api/series/metrics) |
| period | string | 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) |
| symbol | string | string, optional Binance USDT-M perp or coin, e.g. BTCUSDT or BTC (default BTCUSDT) |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"metric"
],
"properties": {
"to": {
"type": "string",
"description": "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"
},
"from": {
"type": "string",
"description": "string, optional ISO start, e.g. 2026-09-01T00:00:00Z"
},
"limit": {
"type": "number",
"description": "number, optional newest bars, 10..5000; the plan's depth caps it (default 300 without from)"
},
"venue": {
"type": "string",
"description": "string, optional venue id for price, oi, funding or borrow, e.g. okx (default binance)"
},
"metric": {
"type": "string",
"description": "string, metric key, e.g. price, oi, funding, liquidations (list: /api/series/metrics)"
},
"period": {
"enum": [
"1m",
"3m",
"5m",
"10m",
"15m",
"30m",
"1h",
"2h",
"4h",
"6h",
"8h",
"12h",
"1d",
"3d",
"1w",
"1M"
],
"type": "string",
"description": "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)"
},
"symbol": {
"type": "string",
"description": "string, optional Binance USDT-M perp or coin, e.g. BTCUSDT or BTC (default BTCUSDT)"
}
}
}| issuer | string | One issuer: xstocks, robinhood, coinbase, bstocks, ondo, backpack, gstocks, reality, superstate, figure, dinari or securitize; omit for every issuer. |
| underlying | string | Stock ticker, e.g. TSLA; omit for the whole board. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"top": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Rows by supply (default 10, max 200)."
},
"chain": {
"type": "string",
"pattern": "^[a-z]{2,12}$",
"description": "One chain, e.g. solana, base, bnb, robinhood, ethereum, ton, all (xStocks circulating) or cex (exchange pairs)."
},
"detail": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"compact",
"full"
],
"type": "string"
}
],
"description": "Optional. \"compact\": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). \"full\" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page."
},
"issuer": {
"enum": [
"xstocks",
"robinhood",
"coinbase",
"bstocks",
"ondo",
"backpack",
"gstocks",
"reality",
"superstate",
"figure",
"dinari",
"securitize"
],
"type": "string",
"description": "One issuer: xstocks, robinhood, coinbase, bstocks, ondo, backpack, gstocks, reality, superstate, figure, dinari or securitize; omit for every issuer."
},
"underlying": {
"type": "string",
"pattern": "^[A-Za-z0-9.]{1,16}$",
"description": "Stock ticker, e.g. TSLA; omit for the whole board."
}
}
}| Include 15-minute index history for the pair, 1..30 days |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"pair": {
"type": "string",
"pattern": "^(BTC-TRY|ETH-TRY|USDT-TRY|BTC-USDT|ETH-USDT)$",
"description": "Pair: BTC-TRY, ETH-TRY, USDT-TRY, BTC-USDT or ETH-USDT"
},
"detail": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"compact",
"full"
],
"type": "string"
}
],
"description": "Optional. \"compact\": a shorter page than the default (fewer rows, newest points kept, rounded figures, long text cut, grids left out; every cut named in trimmed). \"full\" or true: the whole route answer, still under the 100,000 character ceiling (the largest boards answer the ceiling note then: narrow them with symbol, limit or days instead). Omitted or false: the default first page."
},
"daily_days": {
"type": "integer",
"maximum": 30,
"minimum": 1,
"description": "Optional. Days of daily rows, newest first (default 7 without pair, every recorded day with one)."
},
"history_days": {
"type": "integer",
"maximum": 30,
"minimum": 1,
"description": "Include 15-minute index history for the pair, 1..30 days"
}
}
}