Live crypto derivatives data: funding rates, open interest, basis, arbitrage and listings
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Your Sharpe API key, from https://www.sharpe.ai/dashboard/api-keys; leave it out to sign in with your Sharpe account
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.
Single-coin analysis in one view: funding rates, futures OI, and a deterministic directional score. Requires an API key (SHARPE_API_KEY).
Coin ticker (e.g. BTC, ETH, SOL)
Pick your client. Values in capitals, like YOUR_TOKEN, are yours to fill in.
Run in a terminal
claude mcp add --transport http mcp https://www.sharpe.ai/api/mcp
Headers
X-API-Key (optional, not in the config above): Your Sharpe API key, from https://www.sharpe.ai/dashboard/api-keys; leave it out to sign in with your Sharpe accountSingle-coin analysis in one view: funding rates, futures OI, and a deterministic directional score. Requires an API key (SHARPE_API_KEY).
| Argument | Type | Description |
|---|---|---|
| coin* | string | Coin ticker (e.g. BTC, ETH, SOL) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"coin"
],
"properties": {
"coin": {
"type": "string",
"description": "Coin ticker (e.g. BTC, ETH, SOL)"
}
},
"additionalProperties": false
}Scan all exchanges for the best funding rate arbitrage opportunities across spot-perp basis trades and cross-exchange funding arb. Requires an API key (SHARPE_API_KEY).
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Get public metadata about what data is available across all Sharpe Terminal products, including supported exchanges, coins, timeframes, and chart types.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Get spot-margin borrow rates per coin across Binance, OKX, Bybit and Gate.io (the venues that publish them without an account), for pricing a short spot leg (reverse cash-and-carry: sell spot, long perp) or a leveraged long. Each row is one coin with every venue's quote cheapest first: hourlyRate (fraction per hour) and annualRate (hourlyRate × 8,760, simple, fraction per year: 0.05 = 5%), the source endpoint and its time, plus lowest/highest venue. A venue that does not price a coin is absent, never 0; Gate.io covers its 100 most-traded loan currencies. `venues` says which venues answered (ok / stale / failed / unsupported). KuCoin, Bitget, MEXC, BingX and HTX publish no keyless rate. Filter with coin and exchanges.
| Argument | Type | Description |
|---|---|---|
| coin | string | Borrowed asset, case-insensitive (BTC, USDT, PEPE). |
| exchanges | string | Comma-separated venues, case-insensitive: Binance, OKX, Bybit, Gate.io (KuCoin, Bitget, MEXC, BingX and HTX are accepted and reported unsupported). Default: all. |
{
"type": "object",
"properties": {
"coin": {
"type": "string",
"minLength": 1,
"description": "Borrowed asset, case-insensitive (BTC, USDT, PEPE)."
},
"exchanges": {
"type": "string",
"description": "Comma-separated venues, case-insensitive: Binance, OKX, Bybit, Gate.io (KuCoin, Bitget, MEXC, BingX and HTX are accepted and reported unsupported). Default: all."
}
},
"additionalProperties": false
}Get live CEX spot-transfer arbitrage routes (buy on one exchange, withdraw, deposit and sell on another) after exact network matching (ambiguous network names refused), token-contract matching, withdrawal/deposit status and minimums, withdrawal fees, per-venue taker fees (buyTakerFee, sellTakerFee), depth and slippage. netReturn is the net per trip as a fraction of the notional (0.001 is 0.1%), like every spread, fee and slippage figure; minNet filters it as a fraction. Routes netting above zero come first (executionStatus executable); up to 50 near-miss routes follow as indicative with indicativeReason below_fees (or stale_quote / stale_network). Books are judged on 60 s, networks on 10 minutes. transferConfirmations is the sell venue's deposit confirmation count (transferEta is its deprecated label); meta.transferScan counts coins scanned, venues answering, routes evaluated and profitable, and the best net (bestNetReturn).
| Argument | Type | Description |
|---|---|---|
| coin | string | Optional base coin ticker, for example BTC, ETH, or SOL. |
| limit | integer | Maximum number of rows returned. |
| cursor | string | Opaque cursor from the previous page. |
| minNet | number | Minimum of the board's net figure, as a fraction (0.05 is 5%): `netApr` on the dated basis board, `netRollApy` on the calendar board, `netCarryApr` (the fee-adjusted annualized net carry, not the edge to expiry) on the perp-dated carry board, `netReturn` (per trip, not annualized) on the CEX transfer board. |
| notional |
Get cross-exchange funding arbitrage across every funding venue and asset class (crypto plus RWA perps: equity, commodity, FX, index — pairs never cross classes; lot spellings such as 1000PEPE and kPEPE pair as one asset), one row per coin (its best executable pair, else its best no_depth pair, else its largest gross differential), ranked with executable rows first by netApr, then no_depth rows, then the other indicative rows, by netApr or gross apr. Executable = book-priced spread, legs within 5%, fresh quotes, top-of-book depth reported by both venues and ≥ $10,000; otherwise indicativeReason says why (no_depth: a venue reports no size; reference_only, price_gap, thin_book, oi_below_notional, stale_quote, unpriced). netApr nets both venues' taker fees and the adverse entry spread (a favourable spread is never credited) and is present only on book-priced rows; unknown spread/OI/volume are null, never zero. Rows carry pairStatus, breakEvenDays, roundTripFeeRate, the legs' contract symbols, fundingAsOf and per-leg price times; limit / cursor page the board.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Return at most this many rows, the first in board order (executable rows first by netApr, then `no_depth` rows, then the rest, each by netApr or apr). Default: every row. On v1 a limited answer carries `pagination`. |
| cursor | string | Opaque cursor from the previous page's `pagination.cursor` (100 rows a page when `limit` is omitted). |
| sector | string | Narrative filter: only crypto coins in that narrative's CoinGecko category (the constituents /api/narratives/data lists). Omit or "all" for every coin. A coin the category does not list, and every RWA perp, is left out when a sector is set. |
Get cash-and-carry arbitrage rows for buying spot and selling dated futures (Binance, OKX, Bybit), ranked by net annualized basis after fees (netApr: basis at spot ask / futures bid less 2 spot + 2 futures taker fills, × 365 / days to expiry recomputed per request; a fraction per year, 0.05 is 5%, and minNet filters it as one). Rows at least 3 days out rank first (nearExpiry rows last); executable rows first, then snapshot_quote rows (executable on a live read), then the rest, each with indicativeReason (stale_snapshot, no_depth, depth_below_notional, depth_beyond_top_of_book, oi_below_notional, no_volume, backwardation_needs_borrow, snapshot_quote). basis, annualizedBasis and fees (the round-trip fee at each venue's standard rate) are fractions too.
| Argument | Type | Description |
|---|---|---|
| coin | string | Optional base coin ticker, for example BTC, ETH, or SOL. |
| limit | integer | Maximum number of rows returned. |
| cursor | string | Opaque cursor from the previous page. |
| minNet | number | Minimum of the board's net figure, as a fraction (0.05 is 5%): `netApr` on the dated basis board, `netRollApy` on the calendar board, `netCarryApr` (the fee-adjusted annualized net carry, not the edge to expiry) on the perp-dated carry board, `netReturn` (per trip, not annualized) on the CEX transfer board. |
| minOiUsd | number | Minimum open interest in USD. |
Compare Pendle Boros fixed funding rates with realised floating funding. For every live Boros market (a venue's perp to a maturity: Binance, OKX, Bybit, Gate, KuCoin, Hyperliquid incl. xyz, Lighter) returns impliedApr (Boros's fixed rate), floatingApr (the venue's current funding as Boros reports it), realised7dApr and realised30dApr (Sharpe's stored funding for the same contract, annualised as acc × 365 / days), and spread7dApr / spread30dApr = implied − realised. A positive spread means locking the fixed rate (sell yield on Boros, receive fixed) beats what the floating leg has paid; negative means the fixed rate is cheap to pay. All rates are fractions per year (0.05 = 5%), gross of fees. Realised figures are null with realised7dNullReason / realised30dNullReason when the contract is not covered or its history is incomplete, never 0. Also serves bestBidApr / bestAskApr, daysToMaturity, openInterestUsd (one side) and a Boros trade link. Filter with coin and venue.
| Argument | Type | Description |
|---|---|---|
| coin | string | Underlying asset, case-insensitive (BTC, ETH, HYPE, BRENTOIL). |
| venue | string | Filter to one venue, case-insensitive: Boros's name (Binance, OKX, Hyperliquid, Gate, Kucoin, Lighter, Bybit) or our funding store's (Gate.io, KuCoin, tradeXYZ). |
{
"type": "object",
"properties": {
"coin": {
"type": "string",
"minLength": 1,
"description": "Underlying asset, case-insensitive (BTC, ETH, HYPE, BRENTOIL)."
},
"venue": {
"type": "string",
"maxLength": 32,
"minLength": 1,
"description": "Filter to one venue, case-insensitive: Boros's name (Binance, OKX, Hyperliquid, Gate, Kucoin, Lighter, Bybit) or our funding store's (Gate.io, KuCoin, tradeXYZ)."
}
},
"additionalProperties": false
}Get a pair's historical funding spread and carry backtest from stored settlements. mode=spot-perp takes venue (+ optional contract) and direction (short = buy spot, short perp; long = sell spot, long perp, charged the venue's current borrow APR where published: borrowApr, borrowCostIncluded); mode=cross-exchange takes longVenue and shortVenue (+ optional longContract / shortContract). Legs are aligned by settlement time with each contract's real interval (never an assumed 8h). Returns series (spreadApr and legAprs annualized, cashflow and cumulativeCarry as fractions of one leg's notional) and backtests for 1/7/14/30/60 days and the requested days (1-90): fundingCollected, fees (each venue's entry+exit taker fees), netReturn, grossApr, netApr, negativeCarryDays, maxDrawdown, breakEvenDays, coverageRatio, complete and estimatedSettlements (settlements that are still pre-settlement estimates; series points carry estimated). Fractions: multiply by 100 for percent.
| Argument | Type | Description |
|---|---|---|
| coin* | string | Base coin, for example BTC. |
| days | integer | Backtest window in days (1-90): the series covers it, and `backtests` lists it after the shorter standard windows. |
| mode | string | `spot-perp`: one venue's spot and perp (needs `venue`). `cross-exchange`: a long perp and a short perp (needs `longVenue` and `shortVenue`). |
| venue | string | Spot-perp venue: Binance, OKX, Bybit, Bitget, Gate.io, KuCoin, MEXC, BingX or HTX. Required in the default `spot-perp` mode: a call without it answers 400. |
Get near-versus-far dated futures calendar spread rows (adjacent pairs plus monthly/quarterly pairs at least 7 days apart) with executable forward yield (forwardYield), the mark-or-mid reference forward yield that sets curve and direction (referenceForwardYield, priceReference), and lock-in net roll APY after 4 futures + 2 spot taker fills (netRollApy, fees). Yields and APYs are fractions per year (0.05 is 5%), fees and nearBasis / farBasis fractions; minNet filters netRollApy as a fraction. Pairs with a near leg under 3 days or a gap under 7 days are belowTenorFloor and rank last; within the rest, executable pairs that clear their fees come first, then snapshot_quote pairs, then the rest. Rows carry nearDays, gapDays and indicativeReason when not executable.
| Argument | Type | Description |
|---|---|---|
| coin | string | Optional base coin ticker, for example BTC, ETH, or SOL. |
| limit | integer | Maximum number of rows returned. |
| cursor | string | Opaque cursor from the previous page. |
| minNet | number | Minimum of the board's net figure, as a fraction (0.05 is 5%): `netApr` on the dated basis board, `netRollApy` on the calendar board, `netCarryApr` (the fee-adjusted annualized net carry, not the edge to expiry) on the perp-dated carry board, `netReturn` (per trip, not annualized) on the CEX transfer board. |
| minOiUsd | number | Minimum open interest in USD. |
Get perp funding versus dated futures carry rows: the dated contract's basis against the PERP (not spot) at the chosen trade's executable sides (datedBasis), against the funding the perp is expected to pay to expiry (expectedFundingToExpiry: the 7-day realised average over the settlements left, the current print under 3 days; fundingProjection says which), ranked by fee-adjusted annualized net carry (netCarryApr, which minNet filters as a fraction). Every rate is a fraction: APRs per year (0.05 is 5%); the basis, edges and expected funding to expiry, and fees, of the notional. Rows carry direction (Long perp / Short dated or Short perp / Long dated), crossVenue (the legs are usually on two venues: separate accounts and collateral), perpFundingApr, funding7dApr, funding7dCumulative, fundingIntervalHours, fundingSettlementsToExpiry, datedLegPrice / perpLegPrice, fees, nearExpiry (under 3 days: ranked last) and indicativeReason when not executable (snapshot_quote = executable only on a live read).
| Argument | Type | Description |
|---|---|---|
| coin | string | Optional base coin ticker, for example BTC, ETH, or SOL. |
| limit | integer | Maximum number of rows returned. |
| cursor | string | Opaque cursor from the previous page. |
| minNet | number | Minimum of the board's net figure, as a fraction (0.05 is 5%): `netApr` on the dated basis board, `netRollApy` on the calendar board, `netCarryApr` (the fee-adjusted annualized net carry, not the edge to expiry) on the perp-dated carry board, `netReturn` (per trip, not annualized) on the CEX transfer board. |
Get spot-perpetual funding-capture rows with live funding, verified spot or margin availability, diagnostic basis, gross APR, and net APR after the venue's taker fees, the adverse entry basis and a known borrow cost, in the board's order (executable rows first by net APR, then no_spot_depth rows, then the rest, by net APR or gross APR). No row is executable today: spot prices are last trades with no book, so a row passing every other check is indicative no_spot_depth. Each row carries perpSymbol, perpOpenInterestUsd, fundingIsStale, executionStatus with indicativeReason (no_spot_depth, unpriced, price_gap, identity_mismatch, stale_quote, borrow_unpriced, borrow_limit, thin_book, oi_below_notional), pairStatus, breakEvenDays, requiresBorrow / borrowCostIncluded, apr7d / carrySignFlip7d (the 7-day carry against the current direction), fundingAsOf and per-leg price times. minOiUsd floors the perp leg's open interest (unknown fails a positive floor); limit / cursor page the board (the MCP tools ask for a 25-row page unless given either: the whole board is ~2.4 MB).
| Argument | Type | Description |
|---|---|---|
| limit | integer | Rows per page (1-1000), in board order. Omitted with no `cursor`: every row. On v1 a paged answer carries `pagination`. |
| cursor | string | Opaque cursor from the previous page's `pagination.cursor` (100 rows a page when `limit` is omitted). |
| exchange | string | Filter by exchange name, or "all" for all exchanges. |
| minOiUsd | number | Minimum open interest in USD on the perpetual leg (`perpOpenInterestUsd`). Default 0 (no floor). A row whose open interest is unknown fails a positive floor, and so does a row on a venue left out of the API's open-interest totals (MEXC: `openInterestExcludedVenues` elsewhere), whose stored value is kept on the row. |
Get a price correlation matrix for crypto and supported TradFi assets over a specified calendar period. Useful for portfolio analysis and diversification.
| Argument | Type | Description |
|---|---|---|
| ids | string | Comma-separated asset ids: CoinGecko ids for crypto (e.g. bitcoin) and short ids for TradFi (e.g. sp500, gold). Maximum 10. If omitted, returns the default set. Ids no source recognises are listed in an optional `unresolved` array (partial success); a selection none of whose ids is recognised returns 404 resource_not_found naming them. |
| period | string | Lookback period for correlation calculation. |
{
"type": "object",
"properties": {
"ids": {
"type": "string",
"description": "Comma-separated asset ids: CoinGecko ids for crypto (e.g. bitcoin) and short ids for TradFi (e.g. sp500, gold). Maximum 10. If omitted, returns the default set. Ids no source recognises are listed in an optional `unresolved` array (partial success); a selection none of whose ids is recognised returns 404 resource_not_found naming them."
},
"period": {
"enum": [
"30d",
"90d",
"1y",
"3y"
],
"type": "string",
"default": "30d",
"description": "Lookback period for correlation calculation."
}
},
"additionalProperties": false
}Get a derivatives market overview including aggregated open interest, 8-hour-equivalent funding rates, top coins by open interest (each top_coins_oi entry is an asset, its lot spellings included), and exchange/coin counts.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Get ecosystem-level market data (Ethereum, Solana, BNB, Arbitrum, Base, etc.) including market cap, volume, TVL, and performance metrics.
| Argument | Type | Description |
|---|---|---|
| ecosystem | string | Ecosystem to return detail for: the config id (e.g. bnb) or the URL slug (e.g. bnb-chain, ethereum, solana). An unknown value returns 400 invalid_parameter listing the valid values. |
| timeframe | string | Timeframe for correlation data. |
| correlation | string | Set to "true" to include correlation data. |
| excludeNative | string | Set to "true" to exclude the native token from aggregated metrics. |
{
"type": "object",
"properties": {
"ecosystem": {
"type": "string",
"description": "Ecosystem to return detail for: the config id (e.g. bnb) or the URL slug (e.g. bnb-chain, ethereum, solana). An unknown value returns 400 invalid_parameter listing the valid values."
},
"timeframe": {
"type": "string",
"description": "Timeframe for correlation data."
},
"correlation": {
"type": "string",
"description": "Set to \"true\" to include correlation data."
},
"excludeNative": {
"type": "string",
"description": "Set to \"true\" to exclude the native token from aggregated metrics."
}
},
"additionalProperties": false
}Get the New Listings hub payload: weekly + monthly aggregated counts by narrative and exchange, plus the last-90-day recent listings. Optionally filter by narrative slug or single exchange. Counts only resolved spot listings (CoinGecko id + mapped narrative); new tokens awaiting resolution are missing, so use get_listing_events for a complete count of the newest listings.
| Argument | Type | Description |
|---|---|---|
| exchange | string | Filter to a single exchange. |
| narrative | string | Filter to a single narrative slug (e.g. `ai-agents`, `memes`, `layer-1`). |
{
"type": "object",
"properties": {
"exchange": {
"enum": [
"binance",
"okx",
"bybit",
"gateio",
"mexc"
],
"type": "string",
"description": "Filter to a single exchange."
},
"narrative": {
"type": "string",
"description": "Filter to a single narrative slug (e.g. `ai-agents`, `memes`, `layer-1`)."
}
},
"additionalProperties": false
}Get perpetual funding rates across every supported venue (see sharpe://exchanges for the current list). Returns current snapshots, accumulated rates over multiple windows, or per-coin historical rates. Units: `rate` is a decimal fraction settled over that row's own `interval_hours` (1h, 2h, 4h, 8h or 24h depending on venue and market). It is not a percent and never implicitly 8h. On most venues `rate` is the in-progress estimate for the coming settlement, not what was last charged; `rate_kind` says which (`estimate`, `last_settled` on Kraken/Crypto.com/Bitfinex, `trailing_8h` on Deribit), and type=history serves the settled rates. Compare or rank venues on the served rate_8h (rate × 8 / interval_hours) or apr (rate × 8760 / interval_hours), both null when the row has no usable interval. Accumulated rows carry realized sums (acc_1d/acc_7d/acc_30d/acc_90d/acc_1y) instead of a per-interval rate, each annualised over the history behind it (acc_apr_1d … acc_apr_1y), and per window a `coverage` entry (coverage_ratio, complete, listed_within_window, halted_within_window): compare acc_* across contracts only on complete windows where listed_within_window and halted_within_window are both false. Filter with coin, exchange, margin (linear/inverse) and asset_class; asset_class is unfiltered by default, so tokenized-equity, commodity, index and FX perps are included alongside crypto. `coin` names an asset: PEPE returns every PEPE contract, the 1000PEPE and KPEPE lot contracts included. Current and accumulated rows carry asset_id, asset_symbol, lot_multiplier (asset units per contract unit, e.g. 1000 on 1000PEPEUSDT), instrument_status (the venue's own status) and is_live (null = unknown). Page the full book with limit and cursor, or order it by open interest with sort. For type=current the API also answers with aggregates instead of rows: extremes (the highest and lowest markets by rate_8h above an optional min_oi_usd floor), stats (the whole book's mean and OI-weighted funding APR, the positive/negative counts, and venue_count/live_venues) and summary (with coin: the coin's average and median funding across venues, the funding grid's Avg Rate, its open interest over every contract and its next settlement). With type=accumulated, coin and summary=1 it answers per window the median realised funding and median APR over the venues whose history covers the window, and the carry spread APR (best short venue minus best long venue).
Get the dollar value of funding actually paid at each settlement -- not just the rate -- and which side, longs or shorts, paid it. Every response carries both the per-coin row breakdown and a totals block (net/long_paid/short_paid) for the requested window and class, so 'who paid funding today' is read directly from totals rather than summed from a page of rows; totals always reflects the full requested class regardless of any coin/exchange filter on the rows. window=current (the default) is the next 24 hours of funding at current rates -- each contract's forward rate x 24 / its own interval hours, priced live off open interest -- always estimated, never realised. 1d/3d/7d are realised windows; one whose coverage is below 90% carries partial: true (complete: false) because its history is still accruing, not a completed total, and halted_within_window says a contract stopped settling inside the window (listed_within_window is always null: no listing time is known). Sign convention: a window's net = long_paid - short_paid; positive means longs paid more than they received (a cost to longs), negative means shorts paid more. Both long_paid and short_paid are always non-negative magnitudes. Missing is null, never 0. class scopes to one category as on the funding board (crypto, equity, commodity, fx, index), or rwa = every non-crypto class; the five classes' totals, and crypto + rwa, always equal the all totals.
| Argument | Type | Description |
|---|---|---|
| coin | string | Comma-separated coins, for example BTC,ETH. Each names an asset as on /funding/rates: full names resolve (bitcoin -> BTC) and a ticker brings its lot spellings (PEPE -> PEPE, 1000PEPE, KPEPE), each still its own row. Unfiltered by default. |
| sort | string | Sort field for the selected `window`, optionally prefixed with "-" for descending. Rows with no value for the sort field (an unpriced coin) always sort last, regardless of direction. |
Get up to 1,000 coins with futures data, including funding, open-interest, liquidation, long/short, CVD, and dated-basis capability flags plus observed venue coverage and market-cap rank.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Get futures chart data including open interest, volume, funding rate history, liquidations, long/short ratios, basis, term structure, and OHLCV. Time series are oldest-first; when one exceeds the response cap its newest rows are kept (truncated_fields marks kept: latest). Without limit, oi-snapshot returns each exchange's latest reading; pass limit/cursor to page raw rows oldest-first. chart=cvd returns candle rows with `cvd_delta_usd` and the running `cvd_usd` (CVD = running sum of (2 * taker_buy_volume - volume) * close; only Binance candles carry taker volume). Liquidation quantity is already USD notional (never multiply by price). Composite charts return their raw input legs tagged `_type`; returns-* return raw 1h candles.
| Argument | Type | Description |
|---|---|---|
| coin | string | Base coin ticker. |
| chart* | string | Futures chart identifier. |
| limit | integer | Maximum number of data points per page. |
| cursor | string | Opaque pagination cursor from a previous response. |
| exchanges | string | Comma-separated list of exchanges to include (e.g. Binance,Bybit). |
| timeframe | string | Lookback window for the data. |
Get market-ranked token rows, optionally scoped to one chain (chain=solana, base, ...), with market cap, volume, price and market-cap change, circulating supply, ATH and ATL history, nullable FDV/MCap, the home chain (chainSlug, what chain filters on) plus every supported chain the asset is deployed on including bridged copies (chainSlugs), observed exchange availability, quote freshness, and enrichment coverage. Delisted or halted markets whose upstream quote is over 24 hours old are excluded rather than reporting a weeks-old price change as current. Ambiguous same-ticker assets do not receive symbol-only exchange attribution. No wallet signal or proprietary score is returned.
| Argument | Type | Description |
|---|---|---|
| chain | string | Keep only assets whose home chain (chainSlug) is this chain. A token bridged to the chain (chainSlugs) does not match: Chainlink is an Ethereum asset, not a Solana one. A chain's own coin is homed on that chain (SOL under solana, BNB under bsc); a coin or token whose home chain is unsupported (BTC, ICP) matches none. An unknown chain is a 400. |
| limit | integer | Maximum number of tokens to return per page. |
| cursor | string | Opaque, snapshot-bound pagination cursor from a previous response. Cursors expire when the cache refreshes; restart without a cursor after an expiry error. |
{
"type": "object",
"properties": {
"chain": {
"enum": [
"ethereum",
"solana",
"base",
"arbitrum",
"bsc",
"avalanche",
"polygon",
"optimism",
"fantom",
"blast",
"linea",
"mantle",
"scroll",
"zksync",
"tron",
"cronos",
"celo",
"berachain"
],
"type": "string",
"description": "Keep only assets whose home chain (chainSlug) is this chain. A token bridged to the chain (chainSlugs) does not match: Chainlink is an Ethereum asset, not a Solana one. A chain's own coin is homed on that chain (SOL under solana, BNB under bsc); a coin or token whose home chain is unsupported (BTC, ICP) matches none. An unknown chain is a 400."
},
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Maximum number of tokens to return per page."
},
"cursor": {
"type": "string",
"description": "Opaque, snapshot-bound pagination cursor from a previous response. Cursors expire when the cache refreshes; restart without a cursor after an expiry error."
}
},
"additionalProperties": false
}Get the whole-market derivatives board in one call: total open interest with its crypto-versus-RWA split (the headline includes RWA perps: equities, commodities, ETFs, indices, FX), 24h liquidations on Binance, Bybit and Deribit only (a lower bound, not the market total: OKX, Hyperliquid, Gate, Bitget and other venues are not in it), average Wilder RSI(14) across the top 100 crypto perps by market cap, the Altcoin Season Index (share of the top 50 by market cap beating BTC over 90 days, excluding stablecoins and wrapped/staked derivatives), open interest broken down by asset class, and a ranked per-asset row table. The tab parameter selects the universe: crypto, equity, preipo, etf, index, commodity or fx. Rows carry price, 24h return, funding rate (interval-true, never assumed 8h), 24h volume, market cap, open interest with 1h and 24h changes (returns and changes are fractions: 0.01 is 1%), plus liquidations on crypto or a venue count on RWA tabs. Ranks are by open interest descending. Liquidations are crypto-only because no RWA venue publishes a liquidation feed. Use this for 'what is the market doing' questions; use get_funding_rates for per-venue crypto funding detail and get_rwa_perp_funding for RWA carry and cross-venue spreads.
| Argument | Type | Description |
|---|---|---|
| tab | string | Universe to return rows for. The metric block is identical on every tab. |
| limit | integer | Maximum rows per page (1-1000). Enables cursor pagination. |
| cursor | string | Opaque pagination cursor from a previous response. |
{
"type": "object",
"properties": {
"tab": {
"enum": [
"crypto",
"equity",
"preipo",
"etf",
"index",
"commodity",
"fx"
],
"type": "string",
"default": "crypto",
"description": "Universe to return rows for. The metric block is identical on every tab."
},
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Maximum rows per page (1-1000). Enables cursor pagination."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor from a previous response."
}
},
"additionalProperties": false
}Get the market heatmap: coins (top10, top20, top30 or top50 by market cap, or one narrative's or ecosystem's members) or one tile per narrative or ecosystem, with price return (returns: 1h, 4h, 24h, 7d, 30d, 1y), funding APR (avgFundingApr), RSI(14), RVOL, open interest and OI value change (USD, oiChange24h); returns, funding and OI change are fractions (0.054 is 5.4%). Only eligible coins count: at least $1M market cap and $100K plausible volume, CoinGecko data under 48 hours old, and no stablecoins, wrapped or staked copies, LP tokens, funds or tokenized stocks and ETFs. Tiles are weighted baskets of every eligible member, with member coverage in `constituents` and the median member in `median`. Pass `ex` (CoinGecko ids, e.g. bitcoin,ethereum) to leave coins out; aggregate tiles are rebuilt without them. Refreshed every 3 hours, stale after 6 hours; candle and funding times are in `as_of`.
| Argument | Type | Description |
|---|---|---|
| ex | string | Comma-separated CoinGecko coin ids to leave out, lower case (e.g. `bitcoin,ethereum`). Coins mode: removed after the Top N cut and never refilled, so `top10` with two member ids answers 8 coins. Aggregate modes: every tile is rebuilt from its members without them; a tile left with no member is dropped and counted in `omitted`. `excluded` lists the ids that were applied; the others are ignored and named in `meta.warnings`. |
| mode | string | Heatmap grouping mode. |
| category | string | Coins-mode universe. `top10`, `top20`, `top30` and `top50` (the default) are the N largest eligible coins by market cap; the legacy `top-100` is an alias of `top50`. Otherwise one of the 15 narrative ids or 20 ecosystem ids (e.g. `layer-1`, `solana-ecosystem`), an alias such as `defi` or `sol`, or a /heatmap/<slug> page slug: the category's eligible members, of which the 50 largest are served; an ecosystem's members are the coins whose home chain it is. Ignored in the aggregate modes. Eligible coins: a 24h price change, market cap at least $1M, plausible 24h spot volume (at most 50x market cap) at least $100K, CoinGecko data under 48 hours old, and not a stablecoin, wrapped, bridged or staked copy, LP token, tokenized metal, fund, stock, ETF or pre-IPO token. |
Get insider selling pressure signals across crypto assets. Scores require cross-venue negative funding and combine OI, basis, CVD (basis and CVD exist for futures-covered majors only), sell-side flow, and supporting wallet/supply context; oi_change_24h, return_24h and the other shares and changes are fractions (0.054 = 5.4%); read score_interpretation: a score missing funding, price or derivatives inputs is a conservative lower bound, while missing on-chain inputs are re-weighted and listed in incomplete_signal_groups. coin returns one coin's row as the scorer wrote it, dated by its own updated_at (score null and stale once it stopped qualifying).
| Argument | Type | Description |
|---|---|---|
| coin | string | One coin by its CoinGecko id (e.g. pepe): its row exactly as the scorer wrote it, whatever its score, and the answer is dated by that row's own `updated_at`. A coin that stopped qualifying answers `score: null` with its sub-scores and phase cleared, keeps the other inputs of its last qualifying run, and reads stale with a warning; an id with no row answers an empty list. `limit`, `min_score` and `phase` do not apply. |
| limit | integer | Maximum number of coins to return. |
| min_score | number | Filter to coins scoring at or above this value. |
{
"type": "object",
"properties": {
"coin": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "One coin by its CoinGecko id (e.g. pepe): its row exactly as the scorer wrote it, whatever its score, and the answer is dated by that row's own `updated_at`. A coin that stopped qualifying answers `score: null` with its sub-scores and phase cleared, keeps the other inputs of its last qualifying run, and reads stale with a warning; an id with no row answers an empty list. `limit`, `min_score` and `phase` do not apply."
},
"limit": {
"type": "integer",
"default": 100,
"maximum": 500,
"minimum": 1,
"description": "Maximum number of coins to return."
},
"min_score": {
"type": "number",
"default": 0,
"maximum": 10,
"minimum": 0,
"description": "Filter to coins scoring at or above this value."
}
},
"additionalProperties": false
}Get canonical listing lifecycle events across CEXs and Perp DEXs, including source URLs, confidence, source-observation freshness (for official overlays, the newest listing the venue reports), partial status, and per-provider coverage. Pass the opaque cursor through unchanged.
| Argument | Type | Description |
|---|---|---|
| to | string | ISO date or datetime upper bound. |
| days | integer | Lookback window in days. |
| from | string | ISO date or datetime lower bound. |
| limit | integer | Max rows returned. |
| cursor | string | Opaque two-stream cursor returned by the previous page. Pass it through unchanged. |
| status | string | Filter by event status. |
| exchange | string | Filter to a single exchange or perp DEX. |
| narrative | string | Filter by Sharpe narrative slug. |
| confidence | string | Filter by source confidence. |
Get the typed listing connector registry, including supported exchanges, venue types, market coverage, source documentation URLs, enabled status, polling group, and parser confidence.
| Argument | Type | Description |
|---|---|---|
| enabled | string | Filter to enabled or disabled connectors. |
| venue_type | string | Filter exchange coverage by venue type. |
| market_type | string | Filter exchange coverage by supported market type. |
{
"type": "object",
"properties": {
"enabled": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "Filter to enabled or disabled connectors."
},
"venue_type": {
"enum": [
"cex",
"perp_dex",
"dex"
],
"type": "string",
"description": "Filter exchange coverage by venue type."
},
"market_type": {
"enum": [
"spot",
"perp",
"futures",
"options",
"margin"
],
"type": "string",
"description": "Filter exchange coverage by supported market type."
}
},
"additionalProperties": false
}Get BTC and ETH price and 24h return (return_24h), total crypto market cap and 24h volume, BTC dominance (btc_market_share), the market cap's 24h return (market_cap_return_24h), and the Fear & Greed Index. Returns and shares are fractions (0.573 is 57.3%). Auxiliary source fields may be null when unavailable.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Get recently launched tokens from recognized memecoin launchpads, screened by age, liquidity, volume, and transactions. Generic new DEX pairs are excluded; response includes complete/partial chain coverage.
| Argument | Type | Description |
|---|---|---|
| days | integer | Launch lookback window in days, from 1 to 30. |
| limit | integer | Maximum launch rows to return, from 1 to 200. |
| chains | string | Comma-separated chain IDs. Default `solana,bsc`: the chains with a recognised meme launchpad (Pump.fun on Solana; Four.meme and Flap on BNB Chain). Other chains are scanned but return no rows until a launchpad signal exists for them. |
| profile | string | Screening profile for liquidity, volume, and transaction thresholds. |
{
"type": "object",
"properties": {
"days": {
"type": "integer",
"default": 7,
"maximum": 30,
"minimum": 1,
"description": "Launch lookback window in days, from 1 to 30."
},
"limit": {
"type": "integer",
"default": 80,
"maximum": 200,
"minimum": 1,
"description": "Maximum launch rows to return, from 1 to 200."
},
"chains": {
"type": "string",
"description": "Comma-separated chain IDs. Default `solana,bsc`: the chains with a recognised meme launchpad (Pump.fun on Solana; Four.meme and Flap on BNB Chain). Other chains are scanned but return no rows until a launchpad signal exists for them."
},
"profile": {
"enum": [
"discovery",
"balanced",
"strict"
],
"type": "string",
"default": "balanced",
"description": "Screening profile for liquidity, volume, and transaction thresholds."
}
},
"additionalProperties": false
}Get memecoin narrative data across grouped categories (Dog, Cat, Frog, AI, Solana, Base, Pump.fun, etc.) with market cap, market share, volume, performance, and freshness fields.
| Argument | Type | Description |
|---|---|---|
| narrative | string | Memecoin narrative slug to filter by (e.g. dog-coins, cat-coins, frog-coins, ai-memes, trump-coins). |
| historical | string | Include historical time-series data for the specified window. |
| coinHistory | string | Include per-coin price history where retained. Enum: 24h, 7d, 1m, 1y. |
{
"type": "object",
"properties": {
"narrative": {
"type": "string",
"description": "Memecoin narrative slug to filter by (e.g. dog-coins, cat-coins, frog-coins, ai-memes, trump-coins)."
},
"historical": {
"enum": [
"24h",
"7d",
"30d",
"1y"
],
"type": "string",
"description": "Include historical time-series data for the specified window."
},
"coinHistory": {
"enum": [
"24h",
"7d",
"1m",
"1y"
],
"type": "string",
"description": "Include per-coin price history where retained. Enum: 24h, 7d, 1m, 1y."
}
},
"additionalProperties": false
}Get narrative mindshare (each narrative's share of CoinGecko watchlist users, not social-media posts) rankings, token-level watchlist-share rows, rolling windows, or historical mindshare snapshots.
| Argument | Type | Description |
|---|---|---|
| tokens | string | Set to true for token rows. |
| window | string | Rolling snapshot window. |
| narrative | string | Optional narrative slug. |
| timeframe | string | Historical timeframe. |
| historical | string | Set to true for historical snapshots. |
{
"type": "object",
"properties": {
"tokens": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "Set to true for token rows."
},
"window": {
"enum": [
"now",
"24h",
"7d",
"30d"
],
"type": "string",
"description": "Rolling snapshot window."
},
"narrative": {
"type": "string",
"description": "Optional narrative slug."
},
"timeframe": {
"enum": [
"1W",
"1M",
"3M",
"6M",
"1Y",
"3Y"
],
"type": "string",
"description": "Historical timeframe."
},
"historical": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "Set to true for historical snapshots."
}
},
"additionalProperties": false
}Get narrative-level market data (L1, L2, DeFi, AI Agents, DePIN, RWA, Gaming, etc.) including market cap, volume, performance, and social metrics. sort orders the list by return24h and top/bottom add the N highest and lowest narratives by return24h (a narrative without one is never ranked).
| Argument | Type | Description |
|---|---|---|
| top | integer | List only: add `top`, the N narratives with the highest 24h change. |
| sort | string | List only: order `narratives` by 24h return, highest (`-return24h`) or lowest (`return24h`) first; a narrative without a 24h return is last either way. |
| bottom | integer | List only: add `bottom`, the N narratives with the lowest 24h change. |
| narrative | string | Narrative to return detail for: the config id (e.g. dex) or the URL slug (e.g. dex-tokens, layer-1, ai-agents). An unknown value returns 400 invalid_parameter listing the valid values. |
| timeframe | string | Timeframe for correlation data. |
| correlation | string | Set to "true" to include correlation data. |
{
"type": "object",
"properties": {
"top": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "List only: add `top`, the N narratives with the highest 24h change."
},
"sort": {
"enum": [
"-return24h",
"return24h"
],
"type": "string",
"description": "List only: order `narratives` by 24h return, highest (`-return24h`) or lowest (`return24h`) first; a narrative without a 24h return is last either way."
},
"bottom": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "List only: add `bottom`, the N narratives with the lowest 24h change."
},
"narrative": {
"type": "string",
"description": "Narrative to return detail for: the config id (e.g. dex) or the URL slug (e.g. dex-tokens, layer-1, ai-agents). An unknown value returns 400 invalid_parameter listing the valid values."
},
"timeframe": {
"type": "string",
"description": "Timeframe for correlation data."
},
"correlation": {
"type": "string",
"description": "Set to \"true\" to include correlation data."
}
},
"additionalProperties": false
}Get aggregated crypto news articles from multiple sources, with optional title search and filtering by category or coin. Articles are deduplicated so only the best source per story is shown.
| Argument | Type | Description |
|---|---|---|
| q | string | Search article titles across the stored news corpus. |
| coin | string | Filter by coin ticker. |
| limit | integer | Maximum number of articles to return. |
| since | string | ISO 8601 timestamp. Only return articles published after this time. |
| offset | integer | Number of articles to skip for pagination. |
| category | string | Filter by news category. |
{
"type": "object",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Search article titles across the stored news corpus."
},
"coin": {
"type": "string",
"minLength": 1,
"description": "Filter by coin ticker."
},
"limit": {
"type": "integer",
"default": 200,
"maximum": 500,
"minimum": 1,
"description": "Maximum number of articles to return."
},
"since": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 timestamp. Only return articles published after this time."
},
"offset": {
"type": "integer",
"default": 0,
"minimum": 0,
"description": "Number of articles to skip for pagination."
},
"category": {
"enum": [
"all",
"crypto",
"tradfi",
"macro",
"research",
"ai",
"geopolitics"
],
"type": "string",
"description": "Filter by news category."
}
},
"additionalProperties": false
}Get deterministic directional scores and sub-signal breakdowns for a coin. Optional 7D/30D values are volatility-scaled heuristic scenarios, not calibrated targets or probabilities.
| Argument | Type | Description |
|---|---|---|
| coin | string | Ticker, canonical coin slug, or CoinGecko ID to get predictions for (for example, `BTC` or `bitcoin`). A curated coin's ticker resolves to its slug. |
{
"type": "object",
"properties": {
"coin": {
"type": "string",
"description": "Ticker, canonical coin slug, or CoinGecko ID to get predictions for (for example, `BTC` or `bitcoin`). A curated coin's ticker resolves to its slug."
}
},
"additionalProperties": false
}Get pump-and-dump manipulation risk signals across crypto assets. Scores combine derivatives pressure, holder concentration, liquidity quality, DEX flow, and price behavior; read score_interpretation: a score missing funding, price or derivatives inputs is a conservative lower bound, while missing on-chain inputs are re-weighted and listed in incomplete_signal_groups. oi_change_24h, return_24h and the other shares and changes are fractions (0.054 = 5.4%). coin returns one coin's row as the scorer wrote it, dated by its own updated_at (score null and stale once it stopped qualifying).
| Argument | Type | Description |
|---|---|---|
| coin | string | One coin by its CoinGecko id (e.g. pepe): its row exactly as the scorer wrote it, whatever its score, and the answer is dated by that row's own `updated_at`. A coin that stopped qualifying answers `score: null` with its sub-scores and phase cleared, keeps the other inputs of its last qualifying run, and reads stale with a warning; an id with no row answers an empty list. `limit`, `min_score` and `phase` do not apply. |
| limit | integer | Maximum number of coins to return. |
| phase | string | Filter to one manipulation phase label. |
| min_score | number | Filter to coins scoring at or above this value. |
{
"type": "object",
"properties": {
"coin": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "One coin by its CoinGecko id (e.g. pepe): its row exactly as the scorer wrote it, whatever its score, and the answer is dated by that row's own `updated_at`. A coin that stopped qualifying answers `score: null` with its sub-scores and phase cleared, keeps the other inputs of its last qualifying run, and reads stale with a warning; an id with no row answers an empty list. `limit`, `min_score` and `phase` do not apply."
},
"limit": {
"type": "integer",
"default": 100,
"maximum": 500,
"minimum": 1,
"description": "Maximum number of coins to return."
},
"phase": {
"enum": [
"setup",
"markup",
"distribution",
"dump",
"dumping"
],
"type": "string",
"description": "Filter to one manipulation phase label."
},
"min_score": {
"type": "number",
"default": 0,
"maximum": 10,
"minimum": 0,
"description": "Filter to coins scoring at or above this value."
}
},
"additionalProperties": false
}Get a flat feed of recent token listings. Defaults remain backward-compatible with the legacy spot listing feed, which holds only resolved spot listings (CoinGecko id + mapped narrative), so the newest tokens and perps are missing and `limit` truncates it without a cursor; pass an event filter or `from` for the complete event feed. Event filters add source-observation freshness, partial status, and provider coverage so agents can reject incomplete opportunity scans.
| Argument | Type | Description |
|---|---|---|
| to | string | ISO date or datetime upper bound. |
| days | integer | How many days back to include. Default 90. |
| from | string | ISO date or datetime lower bound. |
| limit | integer | Max rows returned. |
| cursor | string | Cursor returned by previous page. |
| status | string | Optional event status filter. |
| exchange | string | Filter to a single exchange. |
| narrative | string | Filter to a single narrative slug. |
Get rug-check token contract security and liquidity risk signals, and the Rug Check score the /rug-check page shows, computed by the API: score.value (0-100, higher is safer; null only when no pillar had a scorable figure), score.verdict, score.data_completeness and score.engine_version, with the checks[] behind it.
| Argument | Type | Description |
|---|---|---|
| address* | string | Token contract address. |
| chainId* | integer | EVM chain ID (1 Ethereum, 56 BNB Smart Chain, 8453 Base, 42161 Arbitrum, 137 Polygon, 10 Optimism, 43114 Avalanche, 146 Sonic, 80094 Berachain, and 29 more), or 1399811149 for Solana and 728126428 for Tron. An unsupported chain returns 400. |
{
"type": "object",
"required": [
"address",
"chainId"
],
"properties": {
"address": {
"type": "string",
"minLength": 1,
"description": "Token contract address."
},
"chainId": {
"type": "integer",
"minimum": 1,
"description": "EVM chain ID (1 Ethereum, 56 BNB Smart Chain, 8453 Base, 42161 Arbitrum, 137 Polygon, 10 Optimism, 43114 Avalanche, 146 Sonic, 80094 Berachain, and 29 more), or 1399811149 for Solana and 728126428 for Tron. An unsupported chain returns 400."
}
},
"additionalProperties": false
}Get trending tokens suitable for rug-check review.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum tokens to return. |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"default": 50,
"maximum": 100,
"minimum": 1,
"description": "Maximum tokens to return."
}
},
"additionalProperties": false
}Get funding and carry for real-world-asset perpetuals (RWA perps: stocks, pre-IPO, ETFs, indices, commodities, FX) across 13 venues: CEXs (Binance, Bybit, OKX, Bitget, Gate, Kraken xStocks), perp DEXs (Aster, Lighter, Extended, GRVT, ApeX, Pacifica) and Hyperliquid HIP-3 builder markets. Rates are interval-true and mechanism-true: funding_apr annualizes each venue's own settlement interval (never an assumed 8h), and a both-sides rollover is reported separately as borrow_apr_annual (a cost, never mixed into funding spreads). Marks more than 2% off the cross-venue median are flagged is_price_suspect and excluded from stats and spreads. type=history returns stored session-tagged settlements (market/after_hours/weekend/holiday) for Hyperliquid and Kraken only, since 2026-07-28; type=stats returns best carry (trailing-24h realised), top cross-venue spread (comparable funding only), weekend premium, and open interest. funding_status separates a real 0 from a venue's off-hours pause or a market that never funds.
| Argument | Type | Description |
|---|---|---|
| days | integer | Days of settlement history to retrieve (type=history only). |
| type | string | Type of rwa-perp data to retrieve. |
| limit | integer | Maximum number of records to return per page. |
| venue | string | Filter to a single venue, case-insensitive (e.g. Binance, Bybit, OKX, Kraken, Aster, Lighter, Pacifica, or the Hyperliquid HIP-3 builder venue: Hyperliquid). The venue list is registry-driven and grows over time; an unknown venue is a 400 that names the valid ones. |
Get stablecoin overview, detail, or yield data including nominal supply at peg, marked value, nullable peg metrics, mechanism mix, chain supply, velocity coverage, freshness, and APY risk flags. Shares, supply changes, peg deviation and APYs are fractions (0.054 = 5.4%).
| Argument | Type | Description |
|---|---|---|
| slug | string | Stablecoin slug. Required when type=detail. |
| type | string | Payload type. |
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"description": "Stablecoin slug. Required when type=detail."
},
"type": {
"enum": [
"overview",
"detail",
"yields"
],
"type": "string",
"default": "overview",
"description": "Payload type."
}
},
"additionalProperties": false
}Get CoinGecko watchlist rankings and snapshots, or market-level signals, for coins and narratives, plus CoinGecko trust-score rankings for exchanges. Measures no site visits or web traffic.
| Argument | Type | Description |
|---|---|---|
| tf | string | Requested history lookback for snapshots. The route clamps to available history when the requested range is unavailable. |
| sub | string | Market dataset to return. Required when mode=market; ignored by other modes. |
| mode | string | Payload mode. |
| type | string | Entity type. |
| entities | string | Comma-separated entity IDs for snapshots. |
{
"type": "object",
"properties": {
"tf": {
"enum": [
"7d",
"30d",
"90d",
"1y",
"3y",
"all"
],
"type": "string",
"default": "30d",
"description": "Requested history lookback for snapshots. The route clamps to available history when the requested range is unavailable."
},
"sub": {
"enum": [
"trending",
"categories",
"global"
],
"type": "string",
"description": "Market dataset to return. Required when mode=market; ignored by other modes."
},
"mode": {
"enum": [
"rankings",
"snapshots",
"market"
],
"type": "string",
"default": "rankings",
"description": "Payload mode."
},
"type": {
"enum": [
"exchange",
"coin",
"narrative"
],
"type": "string",
"default": "exchange",
"description": "Entity type."
},
"entities": {
"type": "string",
"description": "Comma-separated entity IDs for snapshots."
}
},
"additionalProperties": false
}Market briefing with market overview, top narratives, and a funding rate summary. Requires an API key (SHARPE_API_KEY).
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Search crypto and supported TradFi assets by name or ticker. Returns matching assets with asset class, market cap, and nullable price, day return, FDV, ATH, and estimated ATH market cap fields.
| Argument | Type | Description |
|---|---|---|
| q* | string | Search query (2-100 characters). |
{
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"maxLength": 100,
"minLength": 2,
"description": "Search query (2-100 characters)."
}
},
"additionalProperties": false
}We read every tool's name, description and inputs the way the model will, looking for instructions hidden from you. A clean result means no warning signs, not a guarantee. Scanned Nov 16, 2026.
| number |
| Position notional in USD. On the dated-futures basis, calendar-spread and perp-dated carry scanners a row is executable only when its book depth (level 1 on the stored snapshot; on a live read a top-20 walk where level 1 is thin, the side then priced at that walk's VWAP), any reported open interest and its 24h volume are at least this notional (and its quotes are at most 10 minutes old). The CEX spot transfer scanner sizes its order-book fills with it. |
| exchanges | string | Comma-separated exchange filter, for example Binance,Bybit,OKX. |
| minDepthUsd | number | Minimum executable depth in USD when available. |
{
"type": "object",
"properties": {
"coin": {
"type": "string",
"minLength": 1,
"description": "Optional base coin ticker, for example BTC, ETH, or SOL."
},
"limit": {
"type": "integer",
"default": 100,
"maximum": 1000,
"minimum": 1,
"description": "Maximum number of rows returned."
},
"cursor": {
"type": "string",
"description": "Opaque cursor from the previous page."
},
"minNet": {
"type": "number",
"description": "Minimum of the board's net figure, as a fraction (0.05 is 5%): `netApr` on the dated basis board, `netRollApy` on the calendar board, `netCarryApr` (the fee-adjusted annualized net carry, not the edge to expiry) on the perp-dated carry board, `netReturn` (per trip, not annualized) on the CEX transfer board."
},
"notional": {
"type": "number",
"default": 10000,
"maximum": 1000000000,
"description": "Position notional in USD. On the dated-futures basis, calendar-spread and perp-dated carry scanners a row is executable only when its book depth (level 1 on the stored snapshot; on a live read a top-20 walk where level 1 is thin, the side then priced at that walk's VWAP), any reported open interest and its 24h volume are at least this notional (and its quotes are at most 10 minutes old). The CEX spot transfer scanner sizes its order-book fills with it.",
"exclusiveMinimum": 0
},
"exchanges": {
"type": "string",
"description": "Comma-separated exchange filter, for example Binance,Bybit,OKX."
},
"minDepthUsd": {
"type": "number",
"minimum": 0,
"description": "Minimum executable depth in USD when available."
}
},
"additionalProperties": false
}| minOiUsd |
| number |
| Minimum open interest in USD on the smaller leg. Default 0 (no floor). Legs with unknown OI fail a positive floor, and so does a leg on a venue left out of the API's open-interest totals (MEXC). |
| exchanges | string | Comma-separated list of venues to compare. Omit for every funding venue in the funding tracker's registry that the instrument master does not mark not live (`X-Data-Venues` lists them). |
| minVolUsd | number | Minimum 24h perp volume in USD on the smaller leg. Default 0 (no floor). Legs with unknown volume fail a positive floor. |
| assetClass | string | Underlying filter: "all" (default), "crypto", or "rwa" (equity, commodity, FX and index perps). |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"description": "Return at most this many rows, the first in board order (executable rows first by netApr, then `no_depth` rows, then the rest, each by netApr or apr). Default: every row. On v1 a limited answer carries `pagination`."
},
"cursor": {
"type": "string",
"description": "Opaque cursor from the previous page's `pagination.cursor` (100 rows a page when `limit` is omitted)."
},
"sector": {
"enum": [
"all",
"memes",
"ai-agents",
"layer-1",
"defi"
],
"type": "string",
"description": "Narrative filter: only crypto coins in that narrative's CoinGecko category (the constituents /api/narratives/data lists). Omit or \"all\" for every coin. A coin the category does not list, and every RWA perp, is left out when a sector is set."
},
"minOiUsd": {
"type": "number",
"default": 0,
"minimum": 0,
"description": "Minimum open interest in USD on the smaller leg. Default 0 (no floor). Legs with unknown OI fail a positive floor, and so does a leg on a venue left out of the API's open-interest totals (MEXC)."
},
"exchanges": {
"type": "string",
"description": "Comma-separated list of venues to compare. Omit for every funding venue in the funding tracker's registry that the instrument master does not mark not live (`X-Data-Venues` lists them)."
},
"minVolUsd": {
"type": "number",
"default": 0,
"minimum": 0,
"description": "Minimum 24h perp volume in USD on the smaller leg. Default 0 (no floor). Legs with unknown volume fail a positive floor."
},
"assetClass": {
"enum": [
"all",
"crypto",
"rwa"
],
"type": "string",
"default": "all",
"description": "Underlying filter: \"all\" (default), \"crypto\", or \"rwa\" (equity, commodity, FX and index perps)."
}
},
"additionalProperties": false
}| notional |
| number |
| Position notional in USD. On the dated-futures basis, calendar-spread and perp-dated carry scanners a row is executable only when its book depth (level 1 on the stored snapshot; on a live read a top-20 walk where level 1 is thin, the side then priced at that walk's VWAP), any reported open interest and its 24h volume are at least this notional (and its quotes are at most 10 minutes old). The CEX spot transfer scanner sizes its order-book fills with it. |
| exchanges | string | Comma-separated exchange filter, for example Binance,Bybit,OKX. |
| marginType | string | Futures margin filter. |
| minDepthUsd | number | Minimum executable depth in USD when available. |
| minVolumeUsd | number | Minimum 24h futures or spot volume in USD. |
{
"type": "object",
"properties": {
"coin": {
"type": "string",
"minLength": 1,
"description": "Optional base coin ticker, for example BTC, ETH, or SOL."
},
"limit": {
"type": "integer",
"default": 100,
"maximum": 1000,
"minimum": 1,
"description": "Maximum number of rows returned."
},
"cursor": {
"type": "string",
"description": "Opaque cursor from the previous page."
},
"minNet": {
"type": "number",
"description": "Minimum of the board's net figure, as a fraction (0.05 is 5%): `netApr` on the dated basis board, `netRollApy` on the calendar board, `netCarryApr` (the fee-adjusted annualized net carry, not the edge to expiry) on the perp-dated carry board, `netReturn` (per trip, not annualized) on the CEX transfer board."
},
"minOiUsd": {
"type": "number",
"minimum": 0,
"description": "Minimum open interest in USD."
},
"notional": {
"type": "number",
"default": 10000,
"maximum": 1000000000,
"description": "Position notional in USD. On the dated-futures basis, calendar-spread and perp-dated carry scanners a row is executable only when its book depth (level 1 on the stored snapshot; on a live read a top-20 walk where level 1 is thin, the side then priced at that walk's VWAP), any reported open interest and its 24h volume are at least this notional (and its quotes are at most 10 minutes old). The CEX spot transfer scanner sizes its order-book fills with it.",
"exclusiveMinimum": 0
},
"exchanges": {
"type": "string",
"description": "Comma-separated exchange filter, for example Binance,Bybit,OKX."
},
"marginType": {
"enum": [
"linear",
"inverse",
"both"
],
"type": "string",
"description": "Futures margin filter."
},
"minDepthUsd": {
"type": "number",
"minimum": 0,
"description": "Minimum executable depth in USD when available."
},
"minVolumeUsd": {
"type": "number",
"minimum": 0,
"description": "Minimum 24h futures or spot volume in USD."
}
},
"additionalProperties": false
}| contract | string | Spot-perp: the venue's perp contract symbol, for example BTCUSDT. Optional: without it the venue's contract for the coin with the largest current open interest is used. |
| direction | string | Spot-perp: `short` buys spot and shorts the perp (collects positive funding); `long` sells spot and longs the perp (the venue's current borrow APR is charged where it publishes one: `borrowCostIncluded`). |
| longVenue | string | Cross-exchange: the venue of the long perp. |
| shortVenue | string | Cross-exchange: the venue of the short perp. |
| longContract | string | Cross-exchange: the long perp's contract symbol. Optional, resolved as `contract` is. |
| shortContract | string | Cross-exchange: the short perp's contract symbol. Optional, resolved as `contract` is. |
{
"type": "object",
"required": [
"coin"
],
"properties": {
"coin": {
"type": "string",
"maxLength": 32,
"minLength": 1,
"description": "Base coin, for example BTC."
},
"days": {
"type": "integer",
"default": 30,
"maximum": 90,
"minimum": 1,
"description": "Backtest window in days (1-90): the series covers it, and `backtests` lists it after the shorter standard windows."
},
"mode": {
"enum": [
"spot-perp",
"cross-exchange"
],
"type": "string",
"default": "spot-perp",
"description": "`spot-perp`: one venue's spot and perp (needs `venue`). `cross-exchange`: a long perp and a short perp (needs `longVenue` and `shortVenue`)."
},
"venue": {
"type": "string",
"maxLength": 32,
"description": "Spot-perp venue: Binance, OKX, Bybit, Bitget, Gate.io, KuCoin, MEXC, BingX or HTX. Required in the default `spot-perp` mode: a call without it answers 400."
},
"contract": {
"type": "string",
"maxLength": 64,
"description": "Spot-perp: the venue's perp contract symbol, for example BTCUSDT. Optional: without it the venue's contract for the coin with the largest current open interest is used."
},
"direction": {
"enum": [
"short",
"long"
],
"type": "string",
"default": "short",
"description": "Spot-perp: `short` buys spot and shorts the perp (collects positive funding); `long` sells spot and longs the perp (the venue's current borrow APR is charged where it publishes one: `borrowCostIncluded`)."
},
"longVenue": {
"type": "string",
"maxLength": 32,
"description": "Cross-exchange: the venue of the long perp."
},
"shortVenue": {
"type": "string",
"maxLength": 32,
"description": "Cross-exchange: the venue of the short perp."
},
"longContract": {
"type": "string",
"maxLength": 64,
"description": "Cross-exchange: the long perp's contract symbol. Optional, resolved as `contract` is."
},
"shortContract": {
"type": "string",
"maxLength": 64,
"description": "Cross-exchange: the short perp's contract symbol. Optional, resolved as `contract` is."
}
},
"additionalProperties": false
}| notional |
| number |
| Position notional in USD. On the dated-futures basis, calendar-spread and perp-dated carry scanners a row is executable only when its book depth (level 1 on the stored snapshot; on a live read a top-20 walk where level 1 is thin, the side then priced at that walk's VWAP), any reported open interest and its 24h volume are at least this notional (and its quotes are at most 10 minutes old). The CEX spot transfer scanner sizes its order-book fills with it. |
| exchanges | string | Comma-separated exchange filter, for example Binance,Bybit,OKX. |
| marginType | string | Futures margin filter. |
| minDepthUsd | number | Minimum executable depth in USD when available. |
| minVolumeUsd | number | Minimum 24h futures or spot volume in USD. |
{
"type": "object",
"properties": {
"coin": {
"type": "string",
"minLength": 1,
"description": "Optional base coin ticker, for example BTC, ETH, or SOL."
},
"limit": {
"type": "integer",
"default": 100,
"maximum": 1000,
"minimum": 1,
"description": "Maximum number of rows returned."
},
"cursor": {
"type": "string",
"description": "Opaque cursor from the previous page."
},
"minNet": {
"type": "number",
"description": "Minimum of the board's net figure, as a fraction (0.05 is 5%): `netApr` on the dated basis board, `netRollApy` on the calendar board, `netCarryApr` (the fee-adjusted annualized net carry, not the edge to expiry) on the perp-dated carry board, `netReturn` (per trip, not annualized) on the CEX transfer board."
},
"minOiUsd": {
"type": "number",
"minimum": 0,
"description": "Minimum open interest in USD."
},
"notional": {
"type": "number",
"default": 10000,
"maximum": 1000000000,
"description": "Position notional in USD. On the dated-futures basis, calendar-spread and perp-dated carry scanners a row is executable only when its book depth (level 1 on the stored snapshot; on a live read a top-20 walk where level 1 is thin, the side then priced at that walk's VWAP), any reported open interest and its 24h volume are at least this notional (and its quotes are at most 10 minutes old). The CEX spot transfer scanner sizes its order-book fills with it.",
"exclusiveMinimum": 0
},
"exchanges": {
"type": "string",
"description": "Comma-separated exchange filter, for example Binance,Bybit,OKX."
},
"marginType": {
"enum": [
"linear",
"inverse",
"both"
],
"type": "string",
"description": "Futures margin filter."
},
"minDepthUsd": {
"type": "number",
"minimum": 0,
"description": "Minimum executable depth in USD when available."
},
"minVolumeUsd": {
"type": "number",
"minimum": 0,
"description": "Minimum 24h futures or spot volume in USD."
}
},
"additionalProperties": false
}| minOiUsd |
| number |
| Minimum open interest in USD. |
| notional | number | Position notional in USD. On the dated-futures basis, calendar-spread and perp-dated carry scanners a row is executable only when its book depth (level 1 on the stored snapshot; on a live read a top-20 walk where level 1 is thin, the side then priced at that walk's VWAP), any reported open interest and its 24h volume are at least this notional (and its quotes are at most 10 minutes old). The CEX spot transfer scanner sizes its order-book fills with it. |
| exchanges | string | Comma-separated exchange filter, for example Binance,Bybit,OKX. |
| marginType | string | Futures margin filter. |
| minDepthUsd | number | Minimum executable depth in USD when available. |
| minVolumeUsd | number | Minimum 24h futures or spot volume in USD. |
{
"type": "object",
"properties": {
"coin": {
"type": "string",
"minLength": 1,
"description": "Optional base coin ticker, for example BTC, ETH, or SOL."
},
"limit": {
"type": "integer",
"default": 100,
"maximum": 1000,
"minimum": 1,
"description": "Maximum number of rows returned."
},
"cursor": {
"type": "string",
"description": "Opaque cursor from the previous page."
},
"minNet": {
"type": "number",
"description": "Minimum of the board's net figure, as a fraction (0.05 is 5%): `netApr` on the dated basis board, `netRollApy` on the calendar board, `netCarryApr` (the fee-adjusted annualized net carry, not the edge to expiry) on the perp-dated carry board, `netReturn` (per trip, not annualized) on the CEX transfer board."
},
"minOiUsd": {
"type": "number",
"minimum": 0,
"description": "Minimum open interest in USD."
},
"notional": {
"type": "number",
"default": 10000,
"maximum": 1000000000,
"description": "Position notional in USD. On the dated-futures basis, calendar-spread and perp-dated carry scanners a row is executable only when its book depth (level 1 on the stored snapshot; on a live read a top-20 walk where level 1 is thin, the side then priced at that walk's VWAP), any reported open interest and its 24h volume are at least this notional (and its quotes are at most 10 minutes old). The CEX spot transfer scanner sizes its order-book fills with it.",
"exclusiveMinimum": 0
},
"exchanges": {
"type": "string",
"description": "Comma-separated exchange filter, for example Binance,Bybit,OKX."
},
"marginType": {
"enum": [
"linear",
"inverse",
"both"
],
"type": "string",
"description": "Futures margin filter."
},
"minDepthUsd": {
"type": "number",
"minimum": 0,
"description": "Minimum executable depth in USD when available."
},
"minVolumeUsd": {
"type": "number",
"minimum": 0,
"description": "Minimum 24h futures or spot volume in USD."
}
},
"additionalProperties": false
}| direction | string | Filter by perpetual-leg direction: short for positive funding capture, long for negative funding capture. |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Rows per page (1-1000), in board order. Omitted with no `cursor`: every row. On v1 a paged answer carries `pagination`."
},
"cursor": {
"type": "string",
"description": "Opaque cursor from the previous page's `pagination.cursor` (100 rows a page when `limit` is omitted)."
},
"exchange": {
"type": "string",
"default": "all",
"description": "Filter by exchange name, or \"all\" for all exchanges."
},
"minOiUsd": {
"type": "number",
"default": 0,
"minimum": 0,
"description": "Minimum open interest in USD on the perpetual leg (`perpOpenInterestUsd`). Default 0 (no floor). A row whose open interest is unknown fails a positive floor, and so does a row on a venue left out of the API's open-interest totals (MEXC: `openInterestExcludedVenues` elsewhere), whose stored value is kept on the row."
},
"direction": {
"enum": [
"all",
"long",
"short"
],
"type": "string",
"default": "all",
"description": "Filter by perpetual-leg direction: short for positive funding capture, long for negative funding capture."
}
},
"additionalProperties": false
}| Argument | Type | Description |
|---|
| coin | string | The coin to return: a ticker (e.g. BTC), a lot or venue spelling (e.g. `1000PEPE`, `kPEPE`), or the full name (e.g. `bitcoin`, resolved to BTC). Case-insensitive, one coin per request. `coin` names an asset, not a base_coin string: every contract of that asset is returned whatever its base_coin spelling, so `PEPE` also returns the 1000PEPE and KPEPE lot contracts (read `lot_multiplier`), and a ticker two assets share (BB is BounceBit and BlackBerry) returns both, narrowed by `asset_class`. Optional filter for type=current and type=accumulated; required when type=history. A value that no perpetual in the funding book has ever settled returns 400 rather than an empty result set; GET /api/funding/coins lists every ticker carried. |
| days | integer | Number of days of history to retrieve (type=history only). |
| sort | string | type=current only: order the rows by `open_interest`, ascending, or descending with the leading `-`. Rows with unknown open interest come last either way. Applied before `limit`/`cursor`. Default: the book's order (base_coin, exchange, symbol). |
| type | string | Type of funding rate data to retrieve. |
| limit | integer | Maximum number of records to return per page. |
| stats | string | type=current only: `1` answers with the whole book's funding (`market`: mean and open-interest-weighted APR, the count of positive and negative rates, and how many of the tracked venues have a fresh contract). Returns an object instead of rows; cannot be combined with `coin`, `exchange`, `margin`, `asset_class`, `limit`, `cursor` or `sort`. |
| cursor | string | Opaque pagination cursor from a previous response. |
| margin | string | Narrow the response to one collateral convention: `linear` for quote-margined contracts, `inverse` for coin-margined ones. Unfiltered by default. Applies to type=current and type=accumulated; ignored for type=history. An unrecognized value returns 400. |
| summary | string | type=current or type=accumulated, with `coin` only: `1` answers with the coin's funding across venues (`summary`) instead of the rows. For type=current: the average and median 8-hour rate, how they were reduced, the venues behind them, the open interest of every contract and the next settlement. For type=accumulated, per window: the median realised funding and the median APR over the venues whose history covers the window, and the carry spread APR (best short venue minus best long venue). Returns an object instead of rows; cannot be combined with `limit`, `cursor` or `sort`. |
| exchange | string | Filter to a single venue. Accepts the slug (e.g. `gate-io`), the display name as returned in the `exchange` field (e.g. `Gate.io`), or the ccxt id. The venue registry is not frozen, so read the `sharpe://exchanges` MCP resource or /api/funding/rates for the current list. An unrecognized value returns 400. |
| extremes | integer | type=current only: answer with the N highest and N lowest rows by `rate_8h` (`extremes.highest`, `extremes.lowest`) among fresh rows with a usable interval, and how many rows each check left out (`extremes.omitted`). The other filters narrow the rows first. Returns an object instead of rows; cannot be combined with `limit`, `cursor` or `sort`. |
| min_oi_usd | number | type=current, with `extremes` only: leave out rows whose open interest in USD is below this floor. A row with unknown open interest fails a floor above 0. |
| asset_class | string | Narrow the response to one underlying category. The funding book is not crypto-only. Tokenized equity, commodity, index and FX perps trade on the same venues, so this is unfiltered by default. Applies to type=current and type=accumulated; ignored for type=history. An unrecognized value returns 400. |
{
"type": "object",
"properties": {
"coin": {
"type": "string",
"maxLength": 64,
"description": "The coin to return: a ticker (e.g. BTC), a lot or venue spelling (e.g. `1000PEPE`, `kPEPE`), or the full name (e.g. `bitcoin`, resolved to BTC). Case-insensitive, one coin per request. `coin` names an asset, not a base_coin string: every contract of that asset is returned whatever its base_coin spelling, so `PEPE` also returns the 1000PEPE and KPEPE lot contracts (read `lot_multiplier`), and a ticker two assets share (BB is BounceBit and BlackBerry) returns both, narrowed by `asset_class`. Optional filter for type=current and type=accumulated; required when type=history. A value that no perpetual in the funding book has ever settled returns 400 rather than an empty result set; GET /api/funding/coins lists every ticker carried."
},
"days": {
"type": "integer",
"default": 30,
"maximum": 1095,
"minimum": 1,
"description": "Number of days of history to retrieve (type=history only)."
},
"sort": {
"enum": [
"open_interest",
"-open_interest"
],
"type": "string",
"description": "type=current only: order the rows by `open_interest`, ascending, or descending with the leading `-`. Rows with unknown open interest come last either way. Applied before `limit`/`cursor`. Default: the book's order (base_coin, exchange, symbol)."
},
"type": {
"enum": [
"current",
"accumulated",
"history"
],
"type": "string",
"default": "current",
"description": "Type of funding rate data to retrieve."
},
"limit": {
"type": "integer",
"maximum": 5000,
"minimum": 1,
"description": "Maximum number of records to return per page."
},
"stats": {
"enum": [
"1"
],
"type": "string",
"description": "type=current only: `1` answers with the whole book's funding (`market`: mean and open-interest-weighted APR, the count of positive and negative rates, and how many of the tracked venues have a fresh contract). Returns an object instead of rows; cannot be combined with `coin`, `exchange`, `margin`, `asset_class`, `limit`, `cursor` or `sort`."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor from a previous response."
},
"margin": {
"enum": [
"linear",
"inverse"
],
"type": "string",
"description": "Narrow the response to one collateral convention: `linear` for quote-margined contracts, `inverse` for coin-margined ones. Unfiltered by default. Applies to type=current and type=accumulated; ignored for type=history. An unrecognized value returns 400."
},
"summary": {
"enum": [
"1"
],
"type": "string",
"description": "type=current or type=accumulated, with `coin` only: `1` answers with the coin's funding across venues (`summary`) instead of the rows. For type=current: the average and median 8-hour rate, how they were reduced, the venues behind them, the open interest of every contract and the next settlement. For type=accumulated, per window: the median realised funding and the median APR over the venues whose history covers the window, and the carry spread APR (best short venue minus best long venue). Returns an object instead of rows; cannot be combined with `limit`, `cursor` or `sort`."
},
"exchange": {
"type": "string",
"maxLength": 32,
"description": "Filter to a single venue. Accepts the slug (e.g. `gate-io`), the display name as returned in the `exchange` field (e.g. `Gate.io`), or the ccxt id. The venue registry is not frozen, so read the `sharpe://exchanges` MCP resource or /api/funding/rates for the current list. An unrecognized value returns 400."
},
"extremes": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "type=current only: answer with the N highest and N lowest rows by `rate_8h` (`extremes.highest`, `extremes.lowest`) among fresh rows with a usable interval, and how many rows each check left out (`extremes.omitted`). The other filters narrow the rows first. Returns an object instead of rows; cannot be combined with `limit`, `cursor` or `sort`."
},
"min_oi_usd": {
"type": "number",
"minimum": 0,
"description": "type=current, with `extremes` only: leave out rows whose open interest in USD is below this floor. A row with unknown open interest fails a floor above 0."
},
"asset_class": {
"enum": [
"crypto",
"equity",
"commodity",
"fx",
"index"
],
"type": "string",
"description": "Narrow the response to one underlying category. The funding book is not crypto-only. Tokenized equity, commodity, index and FX perps trade on the same venues, so this is unfiltered by default. Applies to type=current and type=accumulated; ignored for type=history. An unrecognized value returns 400."
}
},
"additionalProperties": false
}| class | string | Asset-class scope, the same categories as the funding board: `all`, `crypto`, `equity`, `commodity`, `fx` or `index` (one `asset_class` each). `rwa` is every non-crypto class at once (equity + commodity + fx + index). In the `totals` block the five classes, and `crypto` + `rwa`, reconcile exactly to `all`. |
| limit | integer | Maximum number of rows returned. |
| expand | string | Set to `venues` to include each row's per-venue breakdown. Omitted by default to keep the default payload small. |
| offset | integer | Zero-based row offset for pagination. |
| window | string | Settlement window. `current` is the next 24 hours of funding at current rates (each contract's forward rate x 24 / its own interval hours, priced live off open interest) and labelled `estimated`. `1d`/`3d`/`7d` are realised windows from the funding_fee_settlement matview. |
| exchange | string | Filter to coins settling on a single venue. Accepts the slug, the display name as returned in the `venues[].exchange` field, or the ccxt id. The venue registry is not frozen, so read the `sharpe://exchanges` MCP resource or /api/funding/rates for the current list. An unrecognized value returns 400. Implies the per-venue breakdown internally; the response still omits `venues` unless `expand=venues` is also set. |
{
"type": "object",
"properties": {
"coin": {
"type": "string",
"description": "Comma-separated coins, for example BTC,ETH. Each names an asset as on /funding/rates: full names resolve (bitcoin -> BTC) and a ticker brings its lot spellings (PEPE -> PEPE, 1000PEPE, KPEPE), each still its own row. Unfiltered by default."
},
"sort": {
"enum": [
"base_coin",
"net",
"long_paid",
"short_paid",
"open_interest_usd",
"-base_coin",
"-net",
"-long_paid",
"-short_paid",
"-open_interest_usd"
],
"type": "string",
"description": "Sort field for the selected `window`, optionally prefixed with \"-\" for descending. Rows with no value for the sort field (an unpriced coin) always sort last, regardless of direction."
},
"class": {
"enum": [
"all",
"crypto",
"equity",
"commodity",
"fx",
"index",
"rwa"
],
"type": "string",
"default": "all",
"description": "Asset-class scope, the same categories as the funding board: `all`, `crypto`, `equity`, `commodity`, `fx` or `index` (one `asset_class` each). `rwa` is every non-crypto class at once (equity + commodity + fx + index). In the `totals` block the five classes, and `crypto` + `rwa`, reconcile exactly to `all`."
},
"limit": {
"type": "integer",
"default": 100,
"maximum": 1000,
"minimum": 1,
"description": "Maximum number of rows returned."
},
"expand": {
"enum": [
"venues"
],
"type": "string",
"description": "Set to `venues` to include each row's per-venue breakdown. Omitted by default to keep the default payload small."
},
"offset": {
"type": "integer",
"default": 0,
"minimum": 0,
"description": "Zero-based row offset for pagination."
},
"window": {
"enum": [
"current",
"1d",
"3d",
"7d"
],
"type": "string",
"default": "current",
"description": "Settlement window. `current` is the next 24 hours of funding at current rates (each contract's forward rate x 24 / its own interval hours, priced live off open interest) and labelled `estimated`. `1d`/`3d`/`7d` are realised windows from the funding_fee_settlement matview."
},
"exchange": {
"type": "string",
"maxLength": 32,
"description": "Filter to coins settling on a single venue. Accepts the slug, the display name as returned in the `venues[].exchange` field, or the ccxt id. The venue registry is not frozen, so read the `sharpe://exchanges` MCP resource or /api/funding/rates for the current list. An unrecognized value returns 400. Implies the per-venue breakdown internally; the response still omits `venues` unless `expand=venues` is also set."
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"chart"
],
"properties": {
"coin": {
"type": "string",
"default": "BTC",
"minLength": 1,
"description": "Base coin ticker."
},
"chart": {
"enum": [
"perp-dislocation",
"funding-cost",
"crowding-risk",
"flow-confirmation",
"carry-curve",
"perpetual-price",
"liquidations",
"oi-stacked",
"oi-change",
"oi-daily-change",
"oi-snapshot",
"oi-volume",
"volume-snapshot",
"volume-history",
"cvd",
"long-short-ratio",
"funding-rate",
"top-trader-ls",
"returns-session",
"returns-heatmap",
"returns-hour",
"returns-day",
"annualized-basis",
"term-structure"
],
"type": "string",
"description": "Futures chart identifier."
},
"limit": {
"type": "integer",
"maximum": 10000,
"minimum": 1,
"description": "Maximum number of data points per page."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor from a previous response."
},
"exchanges": {
"type": "string",
"description": "Comma-separated list of exchanges to include (e.g. Binance,Bybit)."
},
"timeframe": {
"enum": [
"1W",
"2W",
"1M",
"3M",
"6M",
"1Y",
"3Y"
],
"type": "string",
"default": "3M",
"description": "Lookback window for the data."
}
},
"additionalProperties": false
}{
"type": "object",
"properties": {
"ex": {
"type": "string",
"pattern": "^[a-z0-9_.-]+(,[a-z0-9_.-]+)*$",
"maxLength": 2000,
"description": "Comma-separated CoinGecko coin ids to leave out, lower case (e.g. `bitcoin,ethereum`). Coins mode: removed after the Top N cut and never refilled, so `top10` with two member ids answers 8 coins. Aggregate modes: every tile is rebuilt from its members without them; a tile left with no member is dropped and counted in `omitted`. `excluded` lists the ids that were applied; the others are ignored and named in `meta.warnings`."
},
"mode": {
"enum": [
"coins",
"narratives",
"ecosystems"
],
"type": "string",
"default": "coins",
"description": "Heatmap grouping mode."
},
"category": {
"type": "string",
"default": "top50",
"description": "Coins-mode universe. `top10`, `top20`, `top30` and `top50` (the default) are the N largest eligible coins by market cap; the legacy `top-100` is an alias of `top50`. Otherwise one of the 15 narrative ids or 20 ecosystem ids (e.g. `layer-1`, `solana-ecosystem`), an alias such as `defi` or `sol`, or a /heatmap/<slug> page slug: the category's eligible members, of which the 50 largest are served; an ecosystem's members are the coins whose home chain it is. Ignored in the aggregate modes. Eligible coins: a 24h price change, market cap at least $1M, plausible 24h spot volume (at most 50x market cap) at least $100K, CoinGecko data under 48 hours old, and not a stablecoin, wrapped, bridged or staked copy, LP token, tokenized metal, fund, stock, ETF or pre-IPO token."
}
},
"additionalProperties": false
}| event_type | string | Filter by listing lifecycle event type. |
| venue_type | string | Filter by venue type. |
| asset_class | string | Filter by listed instrument class. |
| market_type | string | Filter by market type. |
{
"type": "object",
"properties": {
"to": {
"type": "string",
"description": "ISO date or datetime upper bound."
},
"days": {
"type": "integer",
"default": 90,
"maximum": 365,
"minimum": 1,
"description": "Lookback window in days."
},
"from": {
"type": "string",
"description": "ISO date or datetime lower bound."
},
"limit": {
"type": "integer",
"default": 200,
"maximum": 1000,
"minimum": 1,
"description": "Max rows returned."
},
"cursor": {
"type": "string",
"description": "Opaque two-stream cursor returned by the previous page. Pass it through unchanged."
},
"status": {
"enum": [
"announced",
"scheduled",
"live",
"completed",
"cancelled",
"needs_review"
],
"type": "string",
"description": "Filter by event status."
},
"exchange": {
"enum": [
"binance",
"okx",
"bybit",
"gateio",
"mexc",
"bitget",
"kucoin",
"bingx",
"bitmart",
"deepcoin",
"coinbase",
"kraken",
"crypto_com",
"upbit",
"bithumb",
"htx",
"bitfinex",
"bitstamp",
"gemini",
"bitmex",
"deribit",
"phemex",
"lbank",
"bitrue",
"coinex",
"backpack",
"hashkey",
"whitebit",
"toobit",
"hyperliquid",
"aster",
"dydx",
"aevo"
],
"type": "string",
"description": "Filter to a single exchange or perp DEX."
},
"narrative": {
"type": "string",
"description": "Filter by Sharpe narrative slug."
},
"confidence": {
"enum": [
"authoritative",
"high",
"medium",
"low",
"proxy",
"manual"
],
"type": "string",
"description": "Filter by source confidence."
},
"event_type": {
"enum": [
"listing",
"delisting",
"suspension",
"resumption",
"prelaunch"
],
"type": "string",
"description": "Filter by listing lifecycle event type."
},
"venue_type": {
"enum": [
"cex",
"perp_dex",
"dex"
],
"type": "string",
"description": "Filter by venue type."
},
"asset_class": {
"enum": [
"token",
"spot_pair",
"perp_contract",
"futures_contract",
"options_contract"
],
"type": "string",
"description": "Filter by listed instrument class."
},
"market_type": {
"enum": [
"spot",
"perp",
"futures",
"options",
"margin"
],
"type": "string",
"description": "Filter by market type."
}
},
"additionalProperties": false
}| confidence |
| string |
| Optional source confidence filter. |
| event_type | string | Optional event-feed lifecycle event filter. |
| venue_type | string | Optional event-feed venue type filter. |
| asset_class | string | Optional listed instrument class filter. |
| market_type | string | Optional event-feed market type filter. |
{
"type": "object",
"properties": {
"to": {
"type": "string",
"description": "ISO date or datetime upper bound."
},
"days": {
"type": "integer",
"default": 90,
"maximum": 365,
"minimum": 1,
"description": "How many days back to include. Default 90."
},
"from": {
"type": "string",
"description": "ISO date or datetime lower bound."
},
"limit": {
"type": "integer",
"default": 200,
"maximum": 1000,
"minimum": 1,
"description": "Max rows returned."
},
"cursor": {
"type": "string",
"description": "Cursor returned by previous page."
},
"status": {
"enum": [
"announced",
"scheduled",
"live",
"completed",
"cancelled",
"needs_review"
],
"type": "string",
"description": "Optional event status filter."
},
"exchange": {
"enum": [
"binance",
"okx",
"bybit",
"gateio",
"mexc",
"bitget",
"kucoin",
"bingx",
"bitmart",
"deepcoin",
"coinbase",
"kraken",
"crypto_com",
"upbit",
"bithumb",
"htx",
"bitfinex",
"bitstamp",
"gemini",
"bitmex",
"deribit",
"phemex",
"lbank",
"bitrue",
"coinex",
"backpack",
"hashkey",
"whitebit",
"toobit",
"hyperliquid",
"aster",
"dydx",
"aevo"
],
"type": "string",
"description": "Filter to a single exchange."
},
"narrative": {
"type": "string",
"description": "Filter to a single narrative slug."
},
"confidence": {
"enum": [
"authoritative",
"high",
"medium",
"low",
"proxy",
"manual"
],
"type": "string",
"description": "Optional source confidence filter."
},
"event_type": {
"enum": [
"listing",
"delisting",
"suspension",
"resumption",
"prelaunch"
],
"type": "string",
"description": "Optional event-feed lifecycle event filter."
},
"venue_type": {
"enum": [
"cex",
"perp_dex",
"dex"
],
"type": "string",
"description": "Optional event-feed venue type filter."
},
"asset_class": {
"enum": [
"token",
"spot_pair",
"perp_contract",
"futures_contract",
"options_contract"
],
"type": "string",
"description": "Optional listed instrument class filter."
},
"market_type": {
"enum": [
"spot",
"perp",
"futures",
"options",
"margin"
],
"type": "string",
"description": "Optional event-feed market type filter."
}
},
"additionalProperties": false
}| cursor |
| string |
| Opaque pagination cursor from a previous response. |
| symbol | string | Underlying ticker (e.g. TSLA, XAU, US500), case-insensitive. Required when type=history. GOOG and GOOGL are distinct share classes. |
{
"type": "object",
"properties": {
"days": {
"type": "integer",
"default": 7,
"maximum": 90,
"minimum": 1,
"description": "Days of settlement history to retrieve (type=history only)."
},
"type": {
"enum": [
"current",
"history",
"stats"
],
"type": "string",
"default": "current",
"description": "Type of rwa-perp data to retrieve."
},
"limit": {
"type": "integer",
"maximum": 5000,
"minimum": 1,
"description": "Maximum number of records to return per page."
},
"venue": {
"type": "string",
"maxLength": 32,
"description": "Filter to a single venue, case-insensitive (e.g. Binance, Bybit, OKX, Kraken, Aster, Lighter, Pacifica, or the Hyperliquid HIP-3 builder venue: Hyperliquid). The venue list is registry-driven and grows over time; an unknown venue is a 400 that names the valid ones."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor from a previous response."
},
"symbol": {
"type": "string",
"description": "Underlying ticker (e.g. TSLA, XAU, US500), case-insensitive. Required when type=history. GOOG and GOOGL are distinct share classes."
}
},
"additionalProperties": false
}