Gate info MCP for coin discovery, market snapshots, technical analysis, and on-chain data.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
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.
Look up one cryptocurrency profile by ticker, name, contract address, or Gate symbol. Optional chain disambiguates address clashes. Returns matching rows with basic project fields. Read-only public data; not investment advice.
Search text: symbol, contract address, localized name, etc. Non-empty.
Max rows; omit for default 3; minimum 1, maximum 20. Over-limit rejected (not truncated).
Chain hint for address disambiguation when query_type=address or auto-detected EVM address; e.g. eth, tron, bsc.
Response field scope; default basic when omitted. Allowed: basic|detailed|full|with_project|with_tokenomics.
Field allowlist; empty = all. scope wins when both set.
Lookup mode; default auto when omitted. Allowed: auto|address|symbol|name|project|gate_symbol|source_id.
Look up one cryptocurrency profile by ticker, name, contract address, or Gate symbol. Optional chain disambiguates address clashes. Returns matching rows with basic project fields. Read-only public data; not investment advice.
| Argument | Type | Description |
|---|---|---|
| size | integer | Max rows; omit for default 3; minimum 1, maximum 20. Over-limit rejected (not truncated). |
| chain | string | Chain hint for address disambiguation when query_type=address or auto-detected EVM address; e.g. eth, tron, bsc. |
| query* | string | Search text: symbol, contract address, localized name, etc. Non-empty. |
| scope | string | Response field scope; default basic when omitted. Allowed: basic|detailed|full|with_project|with_tokenomics. |
| fields | null | array | Field allowlist; empty = all. scope wins when both set. |
| query_type | string | Lookup mode; default auto when omitted. Allowed: auto|address|symbol|name|project|gate_symbol|source_id. |
{
"type": "object",
"required": [
"query"
],
"properties": {
"size": {
"type": "integer",
"default": 3,
"maximum": 20,
"minimum": 1,
"description": "Max rows; omit for default 3; minimum 1, maximum 20. Over-limit rejected (not truncated)."
},
"chain": {
"type": "string",
"description": "Chain hint for address disambiguation when query_type=address or auto-detected EVM address; e.g. eth, tron, bsc."
},
"query": {
"type": "string",
"minLength": 1,
"description": "Search text: symbol, contract address, localized name, etc. Non-empty."
},
"scope": {
"enum": [
"basic",
"detailed",
"full",
"with_project",
"with_tokenomics"
],
"type": "string",
"description": "Response field scope; default basic when omitted. Allowed: basic|detailed|full|with_project|with_tokenomics."
},
"fields": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
},
"description": "Field allowlist; empty = all. scope wins when both set."
},
"query_type": {
"enum": [
"auto",
"address",
"symbol",
"name",
"project",
"gate_symbol",
"source_id"
],
"type": "string",
"description": "Lookup mode; default auto when omitted. Allowed: auto|address|symbol|name|project|gate_symbol|source_id."
}
},
"additionalProperties": false
}Boards: popular, gainers/losers, twitter_hot, airdrop, new_listing, market_pulse_hot. time_range only for gainers/losers. Single match→get_coin_info. Filtered list→search_coins. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Rows; default 20, max 400. |
| time_range | string | Only for top_gainers|top_losers: 1h|24h (default)|7d. Omit for other ranking_type or validation fails. |
| listing_from | integer | new_listing only: Unix seconds from; 0 = omit. |
| ranking_type* | string | popular|top_gainers|top_losers|twitter_hot|airdrop|new_listing|market_pulse_hot |
| listing_query | string | new_listing only: exchange / keyword for upstream query. |
| listing_tickers | string | new_listing only: comma tickers e.g. BTC,ETH. |
{
"type": "object",
"required": [
"ranking_type"
],
"properties": {
"limit": {
"type": "integer",
"description": "Rows; default 20, max 400."
},
"time_range": {
"type": "string",
"description": "Only for top_gainers|top_losers: 1h|24h (default)|7d. Omit for other ranking_type or validation fails."
},
"listing_from": {
"type": "integer",
"description": "new_listing only: Unix seconds from; 0 = omit."
},
"ranking_type": {
"type": "string",
"description": "popular|top_gainers|top_losers|twitter_hot|airdrop|new_listing|market_pulse_hot"
},
"listing_query": {
"type": "string",
"description": "new_listing only: exchange / keyword for upstream query."
},
"listing_tickers": {
"type": "string",
"description": "new_listing only: comma tickers e.g. BTC,ETH."
}
},
"additionalProperties": false
}Multi-row asset list by category, chain, cap, type. One clear match→get_coin_info. Boards→get_coin_rankings. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| chain | string | Chain filter: canonical name or alias (ETH→Ethereum, BSC→BNB Chain); contains match on normalized chain list. |
| limit | integer | Page size; default 20, max 400. |
| offset | integer | Offset; default 0. |
| sort_by | string | market_cap (default) | fdv | circulating_supply; all desc |
| category | string | Controlled sector tag or group (e.g. Layer 1, DEX); case-insensitive; matches category_type_flat then category_type; unknown values return empty list. |
| asset_type | string | crypto (default) | tradefi | all |
| market_cap_max | null | number | Max market cap USD. |
| market_cap_min | null | number | Min market cap USD; range on market_value / market_cap. |
Public heuristic token security screen (e.g. tax/holder-risk style signals from data providers). Not a security guarantee or legal/investment advice. On-chain activity stats→get_token_onchain. Token xor address with chain; scope in schema. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| lang | string | Locale: en|cn|tw|ja|kr; default en. |
| chain* | string | Chain id e.g. eth, bsc, solana, base, arb. |
| scope | string | basic (default)|full. |
| token | string | Token symbol e.g. PEPE; xor with address. |
| address | string | Contract address; xor with token. |
{
"type": "object",
"required": [
"chain"
],
"properties": {
"lang": {
"type": "string",
"description": "Locale: en|cn|tw|ja|kr; default en."
},
"chain": {
"type": "string",
"description": "Chain id e.g. eth, bsc, solana, base, arb."
},
"scope": {
"type": "string",
"description": "basic (default)|full."
},
"token": {
"type": "string",
"description": "Token symbol e.g. PEPE; xor with address."
},
"address": {
"type": "string",
"description": "Contract address; xor with token."
}
},
"additionalProperties": false
}Filtered release calendar in a date window. Zero-arg dashboard→get_macro_summary. Indicator snapshot or series→get_macro_indicator. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| size | integer | Rows; default 20, max 400. |
| end_date | string | End YYYY-MM-DD inclusive; default start+30d; sorted by event_date desc. |
| event_type | string | FOMC|NFP|CPI|PPI|GDP|PCE|...; empty or all = no filter. |
| importance | string | Importance filter; ignored if index lacks field. |
| start_date | string | Start YYYY-MM-DD for event_date; default today UTC; if only end_date set, start defaults today. |
{
"type": "object",
"properties": {
"size": {
"type": "integer",
"description": "Rows; default 20, max 400."
},
"end_date": {
"type": "string",
"description": "End YYYY-MM-DD inclusive; default start+30d; sorted by event_date desc."
},
"event_type": {
"type": "string",
"description": "FOMC|NFP|CPI|PPI|GDP|PCE|...; empty or all = no filter."
},
"importance": {
"type": "string",
"description": "Importance filter; ignored if index lacks field."
},
"start_date": {
"type": "string",
"description": "Start YYYY-MM-DD for event_date; default today UTC; if only end_date set, start defaults today."
}
},
"additionalProperties": false
}Official macro stats: latest or series by country/indicator (CPI, rates, jobs). No event feed. Calendar→get_economic_calendar. Dashboard→get_macro_summary. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| mode | string | latest (default, snapshot) or timeseries. |
| size | integer | Rows; default 20, max 400. |
| country | string | Country display name e.g. United States; wins over country_code if both set. |
| end_date | string | Same as end_time. |
| end_time | string | Range end; alias end_date. |
| indicator* | string | Exact keyword match on indicator.keyword OR indicator_id.keyword OR slugname.keyword; ASCII case-insensitive via exact variants (original, lower, upper). |
| start_date | string | Same as start_time. |
| start_time | string | Range start; alias start_date; filters date/part_date. |
Zero-arg macro dashboard: key snapshots plus upcoming releases. Filtered calendar list→get_economic_calendar. Indicator snapshot or series→get_macro_indicator. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
No arguments.
{
"type": "object",
"additionalProperties": false
}Read-only Gate candlesticks for a trading pair or contract. Inputs: symbol (required), timeframe (validated per market_type; delivery excludes 1s|3d), market_type spot|futures|delivery|options (default spot), limit 1–400 (default 100; over-limit rejected) for latest N only, optional paired start_time/end_time Unix seconds (mutually exclusive with limit; range returns up to 400 latest candles and may set truncated/actual_start_time/actual_end_time), settle for futures/delivery. Each candle includes t, open, high, low, close; volume and quote_volume only when upstream provides them. Invalid timeframe or unknown symbol returns an error. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max candles when no time range; omit for default 100; minimum 1, maximum 400. Over-limit rejected. Cannot combine with start_time/end_time. |
| settle | string | futures/delivery settlement; default usdt. |
| symbol* | string | Pair or contract e.g. BTC_USDT. |
| end_time | integer | End Unix seconds; must be paired with start_time. Range queries return up to 400 latest candles and may set truncated. |
| timeframe* | string | Candle interval. start_time/end_time are Unix seconds. |
Read-only Gate order book depth (bids/asks as price/size) for a trading pair or contract. Inputs: symbol (required), market_type spot|futures|delivery|options (default spot), depth 1–100 (default 20; over-limit rejected), settle for futures (usdt|btc) or delivery (usdt). Spot/options reject settle. Does not place orders. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| depth | integer | Order book depth levels; omit for default 20; minimum 1, maximum 100. Values above max are rejected. |
| settle | string | Settlement for futures/delivery; default usdt; omit for options. |
| symbol* | string | Trading pair e.g. BTC_USDT. |
| market_type | string | Market venue; default spot when omitted. Allowed: spot|futures|delivery|options. |
{
"type": "object",
"required": [
"symbol"
],
"properties": {
"depth": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1,
"description": "Order book depth levels; omit for default 20; minimum 1, maximum 100. Values above max are rejected."
},
"settle": {
"type": "string",
"description": "Settlement for futures/delivery; default usdt; omit for options."
},
"symbol": {
"type": "string",
"minLength": 1,
"description": "Trading pair e.g. BTC_USDT."
},
"market_type": {
"enum": [
"spot",
"futures",
"delivery",
"options"
],
"type": "string",
"description": "Market venue; default spot when omitted. Allowed: spot|futures|delivery|options."
}
},
"additionalProperties": false
}Read-only recent Gate trade prints for a trading pair or contract. Inputs: symbol (required), market_type spot|futures|delivery|options (default spot), limit 1–400 (default 50; over-limit rejected), settle for futures (usdt|btc) or delivery (usdt). create_time_ms keeps upstream units (spot usually ms; futures/delivery often fractional seconds). side is optional (spot); derivatives may use signed size. Does not place orders. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Recent trades count; omit for default 50; minimum 1, maximum 400. Over-limit rejected. |
| settle | string | futures/delivery settlement; default usdt. |
| symbol* | string | Pair or contract id. |
| market_type | string | Market venue; default spot when omitted. Allowed: spot|futures|delivery|options. |
{
"type": "object",
"required": [
"symbol"
],
"properties": {
"limit": {
"type": "integer",
"default": 50,
"maximum": 400,
"minimum": 1,
"description": "Recent trades count; omit for default 50; minimum 1, maximum 400. Over-limit rejected."
},
"settle": {
"type": "string",
"description": "futures/delivery settlement; default usdt."
},
"symbol": {
"type": "string",
"minLength": 1,
"description": "Pair or contract id."
},
"market_type": {
"enum": [
"spot",
"futures",
"delivery",
"options"
],
"type": "string",
"description": "Market venue; default spot when omitted. Allowed: spot|futures|delivery|options."
}
},
"additionalProperties": false
}Batch market snapshots for up to 20 symbols; raw array length 1–20 before trim/dedupe; missing symbols appear in not_found. Same timeframe/source/quote/scope semantics as the single-symbol snapshot. Read-only public market data. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| quote | string | Quote currency; default USDT; maps to OpenSearch market. |
| scope | string | Response field scope; default basic. Allowed: basic|detailed|full. |
| source | string | Market source; default spot. futures is accepted and normalized to future. Allowed: alpha|spot|future|futures|fx. |
| symbols* | array | Raw symbol array length 1–20 (checked before trim/dedupe). Then trim, reject blanks, dedupe; missing symbols go to not_found (omitted from items). |
| timeframe | string | Kline interval; default 1h when omitted. Allowed: 15m|1h|4h|1d. |
{
"type": "object",
"required": [
"symbols"
],
"properties": {
"quote": {
"type": "string",
"description": "Quote currency; default USDT; maps to OpenSearch market."
},
"scope": {
"enum": [
"basic",
"detailed",
"full"
],
"type": "string",
"description": "Response field scope; default basic. Allowed: basic|detailed|full."
},
"source": {
"enum": [
"alpha",
"spot",
"future",
"futures",
"fx"
],
"type": "string",
"description": "Market source; default spot. futures is accepted and normalized to future. Allowed: alpha|spot|future|futures|fx."
},
"symbols": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20,
"minItems": 1,
"description": "Raw symbol array length 1–20 (checked before trim/dedupe). Then trim, reject blanks, dedupe; missing symbols go to not_found (omitted from items)."
},
"timeframe": {
"enum": [
"15m",
"1h",
"4h",
"1d"
],
"type": "string",
"description": "Kline interval; default 1h when omitted. Allowed: 15m|1h|4h|1d."
}
},
"additionalProperties": false
}BTC/ETH institutional ETF/CME/CFTC daily metrics (OpenSearch). asset=BTC|ETH|all; channel=all|etf|cme|cftc nulls non-selected fields. CME often null with data_status cme_source_not_procured. Returns assets[].latest and series[]. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| asset | string | BTC|ETH|all; default BTC. all returns BTC and ETH groups. |
| limit | integer | 1-366; default 30. |
| channel | string | all|etf|cme|cftc; default all. |
| end_date | string | YYYY-MM-DD; default latest part_date available from OpenSearch. |
| start_date | string | YYYY-MM-DD; default end_date - 30d. |
{
"type": "object",
"properties": {
"asset": {
"type": "string",
"description": "BTC|ETH|all; default BTC. all returns BTC and ETH groups."
},
"limit": {
"type": "integer",
"description": "1-366; default 30."
},
"channel": {
"type": "string",
"description": "all|etf|cme|cftc; default all."
},
"end_date": {
"type": "string",
"description": "YYYY-MM-DD; default latest part_date available from OpenSearch."
},
"start_date": {
"type": "string",
"description": "YYYY-MM-DD; default end_date - 30d."
}
},
"additionalProperties": false
}Broad market overview dashboard: capitalization, volume, dominance, and sentiment style metrics. No symbol required. Read-only public market breadth data. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
No arguments.
{
"type": "object",
"additionalProperties": false
}One-symbol market snapshot: realtime price, a short kline clip, and project summary. Inputs include symbol, timeframe, source (e.g. spot), quote, and scope. When no data exists for the symbol, returns status=not_found with empty realtime/kline/project_info. Read-only public market data. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| quote | string | Quote currency mapped to OpenSearch market; default USDT. |
| scope | string | Response field scope; default basic (trimmed). Allowed: basic|detailed|full. |
| source | string | Market source; default spot. futures is accepted and normalized to future. Allowed: alpha|spot|future|futures|fx. |
| symbol* | string | Symbol e.g. BTC, ETH, USDC. |
| timeframe | string | Kline interval; wins over indicator_timeframe when both set; default 1h if both empty. Allowed: 15m|1h|4h|1d. |
| indicator_timeframe | string | Alias of timeframe when timeframe omitted. Allowed: 15m|1h|4h|1d. |
{
"type": "object",
"required": [
"symbol"
],
"properties": {
"quote": {
"type": "string",
"description": "Quote currency mapped to OpenSearch market; default USDT."
},
"scope": {
"enum": [
"basic",
"detailed",
"full"
],
"type": "string",
"description": "Response field scope; default basic (trimmed). Allowed: basic|detailed|full."
},
"source": {
"enum": [
"alpha",
"spot",
"future",
"futures",
"fx"
],
"type": "string",
"description": "Market source; default spot. futures is accepted and normalized to future. Allowed: alpha|spot|future|futures|fx."
},
"symbol": {
"type": "string",
"minLength": 1,
"description": "Symbol e.g. BTC, ETH, USDC."
},
"timeframe": {
"enum": [
"15m",
"1h",
"4h",
"1d"
],
"type": "string",
"description": "Kline interval; wins over indicator_timeframe when both set; default 1h if both empty. Allowed: 15m|1h|4h|1d."
},
"indicator_timeframe": {
"enum": [
"15m",
"1h",
"4h",
"1d"
],
"type": "string",
"description": "Alias of timeframe when timeframe omitted. Allowed: 15m|1h|4h|1d."
}
},
"additionalProperties": false
}Historical indicator columns (RSI, MACD, MAs). OHLCV→get_kline. Chart-label snapshot→get_technical_analysis. Not trading signals or investment recommendations. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Points; default 50, max 400. |
| symbol* | string | Symbol. |
| end_time | string | Range end. |
| timeframe* | string | 15m|1h|4h|1d. |
| indicators* | null | array | ES field names e.g. rsi, macd, macd_dea, ma7, ema7, ma30, boll_upper_band, signal_value_k, profit_rate_stddev_7d. |
| start_time | string | Range start: ms or ISO8601. |
{
"type": "object",
"required": [
"symbol",
"indicators",
"timeframe"
],
"properties": {
"limit": {
"type": "integer",
"description": "Points; default 50, max 400."
},
"symbol": {
"type": "string",
"description": "Symbol."
},
"end_time": {
"type": "string",
"description": "Range end."
},
"timeframe": {
"type": "string",
"description": "15m|1h|4h|1d."
},
"indicators": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
},
"description": "ES field names e.g. rsi, macd, macd_dea, ma7, ema7, ma30, boll_upper_band, signal_value_k, profit_rate_stddev_7d."
},
"start_time": {
"type": "string",
"description": "Range start: ms or ISO8601."
}
},
"additionalProperties": false
}Trend-index OHLCV for symbols, with optional indicator bundle. Exchange pair or contract candles, or fine intervals→marketdetail_get_kline. Columns→get_indicator_history. Chart-label snapshot→get_technical_analysis. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| size | integer | Row count; alias of limit; default 100, max 400. |
| limit | integer | Row count; default 100, max 400; alternative to size. |
| period | string | Window: 1h|4h|24h|7d|3d|5d|10d; default 24h. Ignored when start/end set. |
| symbol* | string | Symbol e.g. BTC, ETH. |
| end_time | string | Absolute end. |
| timeframe* | string | Candle interval: 1m|5m|15m|1h|4h|1d. |
| start_time | string | Absolute start: ms timestamp or ISO8601; wins over period when paired with end. |
| with_indicators | null | boolean |
Multi-timeframe chart-derived labels (e.g. bullish/bearish/neutral style summaries) from OHLCV only—descriptive research, not a price forecast or investment recommendation. OHLCV→get_kline. Raw columns→get_indicator_history. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| period | string | Window: 1h|4h|24h|7d|3d|5d|10d|all; default 3d. Absolute start/end win when parseable. |
| symbol* | string | Symbol. |
| end_time | string | Absolute end: ms or RFC3339. |
| start_time | string | Absolute start: ms or RFC3339. |
{
"type": "object",
"required": [
"symbol"
],
"properties": {
"period": {
"type": "string",
"description": "Window: 1h|4h|24h|7d|3d|5d|10d|all; default 3d. Absolute start/end win when parseable."
},
"symbol": {
"type": "string",
"description": "Symbol."
},
"end_time": {
"type": "string",
"description": "Absolute end: ms or RFC3339."
},
"start_time": {
"type": "string",
"description": "Absolute start: ms or RFC3339."
}
},
"additionalProperties": false
}Wallet profile: asset_summary, token_balances (USD desc), multi_chain_token_balances, labels/risk; Solana adds token_account/mint_account. Chain aliases: op→optimism, avax|avalanche-c→avalanche, bera|berachain→bera, polygon|matic, etc. Errors: invalid_chain, invalid_address, upstream_not_ready. Transfers→get_address_transactions. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| chain | string | Chain id e.g. eth, trx, bsc, btc, sol, base, arb. Omit to auto-detect from labels; default eth if unknown. |
| scope | string | basic (default) | with_defi | with_counterparties | with_pnl | full. full merges all extensions; empty sections may be [] or null. detailed maps to full. |
| address* | string | On-chain address. |
| min_value_usd | null | number | Min token balance USD; keep rows with parsed value_usd >= threshold. 0 keeps non-negative; unset/unparseable value_usd dropped. |
| upstream_raw_mode | string | off (default) | lite | full. Prefer off for public MCP. include_upstream_raw=true forces full. |
| include_upstream_raw | boolean | Prefer false (default). If true, include New Explorer ApiResponse.data as new_explorer_*_raw; large payload, not for public clients. |
Paginated transfers; BTC items include inputs/outputs/tx_status. partial_upstream_response when upstream total>0 but list unparseable. Chain aliases same as get_address_info. Profile→get_address_info. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| chain | string | Chain id (eth, trx, bsc, btc, sol, base, arb, ...); default eth. |
| limit | integer | Max rows; default 20, max 400; maps to explorer page_size. Some filters apply only to GET list paths. |
| address* | string | On-chain address. |
| tx_type | string | transfer | contract_call | token_transfer | all (default). |
| end_time | integer | End Unix seconds. |
| start_time | integer | Start Unix seconds; pair with end_time; absolute wins over time_range. |
| time_range | string | Relative window vs start/end: 1h|24h|1d|7d|30d|90d as [now-Δ, now]. Ignored if start_time or end_time set. |
| to_address |
Token scope: holders, transfers, activity, smart_money. Address ledger→get_address_transactions. One tx→get_transaction. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| chain | string | Chain; omit for service default. |
| scope | string | holders|activity|transfers|smart_money|full; default full. |
| token* | string | Token symbol e.g. ETH, USDT, or contract address. |
| upstream_raw_mode | string | off (default) | lite | full. Prefer off for public MCP. include_upstream_raw=true forces full. |
| include_upstream_raw | boolean | Prefer false (default). If true, include explorer_*_page raw and transfer source_raw; large payload, not for public clients. |
{
"type": "object",
"required": [
"token"
],
"properties": {
"chain": {
"type": "string",
"description": "Chain; omit for service default."
},
"scope": {
"type": "string",
"description": "holders|activity|transfers|smart_money|full; default full."
},
"token": {
"type": "string",
"description": "Token symbol e.g. ETH, USDT, or contract address."
},
"upstream_raw_mode": {
"type": "string",
"description": "off (default) | lite | full. Prefer off for public MCP. include_upstream_raw=true forces full."
},
"include_upstream_raw": {
"type": "boolean",
"description": "Prefer false (default). If true, include explorer_*_page raw and transfer source_raw; large payload, not for public clients."
}
},
"additionalProperties": false
}One transaction by hash; fields sparse if upstream thin. Token view→get_token_onchain. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| chain | string | Chain e.g. eth, bsc, btc; default eth. |
| tx_hash* | string | Transaction hash. Response may omit fields when upstream data is incomplete. |
| upstream_raw_mode | string | off (default) | lite | full. Prefer off for public MCP; only full adds detail raw. include_upstream_raw=true forces full. |
| include_upstream_raw | boolean | Prefer false (default). If true, include explorer_detail_raw and blockinfo_detail_raw; large payload, not for public clients. |
{
"type": "object",
"required": [
"tx_hash"
],
"properties": {
"chain": {
"type": "string",
"description": "Chain e.g. eth, bsc, btc; default eth."
},
"tx_hash": {
"type": "string",
"description": "Transaction hash. Response may omit fields when upstream data is incomplete."
},
"upstream_raw_mode": {
"type": "string",
"description": "off (default) | lite | full. Prefer off for public MCP; only full adds detail raw. include_upstream_raw=true forces full."
},
"include_upstream_raw": {
"type": "boolean",
"description": "Prefer false (default). If true, include explorer_detail_raw and blockinfo_detail_raw; large payload, not for public clients."
}
},
"additionalProperties": false
}Bridge ranking or one-bridge chain breakdown. Cross-sector dashboard across DeFi, spot, perp, stablecoin, or bridge→get_defi_overview. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| chain | string | Chain; normalized e.g. eth→Ethereum; filters chain_breakdown. |
| limit | integer | Rows; default 10, max 400. |
| sort_by | string | volume_24h (default)|volume_7d|deposit_txs_24h. |
| bridge_name | string | Bridge name (ASCII case-insensitive after trim/space normalize); omit for ranked list without chain_breakdown. |
{
"type": "object",
"properties": {
"chain": {
"type": "string",
"description": "Chain; normalized e.g. eth→Ethereum; filters chain_breakdown."
},
"limit": {
"type": "integer",
"description": "Rows; default 10, max 400."
},
"sort_by": {
"type": "string",
"description": "volume_24h (default)|volume_7d|deposit_txs_24h."
},
"bridge_name": {
"type": "string",
"description": "Bridge name (ASCII case-insensitive after trim/space normalize); omit for ranked list without chain_breakdown."
}
},
"additionalProperties": false
}Competitor CEX ±1% order-book depth (spot/perp) from warehouse indices; BTC/ETH liquidity benchmarking. Gate native ladder→get_orderbook. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max rows; default 20, max 100. |
| symbol* | string | Base asset e.g. BTC, ETH. |
| exchange | string | Venue e.g. BINANCE; when set with exchange index, filters exchange dimension. |
| data_scope | string | exchange|market; default market if only market index configured, else exchange when exchange set. |
| market_type | string | spot|perp (maps to SPOT|PERP); default perp. |
{
"type": "object",
"required": [
"symbol"
],
"properties": {
"limit": {
"type": "integer",
"description": "Max rows; default 20, max 100."
},
"symbol": {
"type": "string",
"description": "Base asset e.g. BTC, ETH."
},
"exchange": {
"type": "string",
"description": "Venue e.g. BINANCE; when set with exchange index, filters exchange dimension."
},
"data_scope": {
"type": "string",
"description": "exchange|market; default market if only market index configured, else exchange when exchange set."
},
"market_type": {
"type": "string",
"description": "spot|perp (maps to SPOT|PERP); default perp."
}
},
"additionalProperties": false
}Chain-level activity metrics by metric_group. staking: Ethereum daily staking_metrics.series. l2: L2 ops daily l2_metrics.series (tps_avg_1d, active_addresses_1d, blob_cost_usd_1d, sequencer_revenue_usd_1d, stage_label; no tx_count/l1_fee_usd) from dwd_external_l2_metrics_daily_di; granularity day only. btc_l2: BTC L2 protocol ecosystem btc_l2_metrics.items (project_key, project_name, category, main_chain, tvl_usd, protocol_count, tx_count_1d, active_addresses_1d, bridge_volume_24h_usd, source_refs; whitelist: stacks|rootstock|merlin|bob|bitlayer). Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| chain | string | Chain; staking defaults empty to ethereum; l2 supports base/arbitrum/optimism/linea/zksync_era/blast or empty for all chains; btc_l2 defaults empty to btc (required). |
| limit | integer | l2 only: max series rows returned; 0 means no extra cap beyond date window. |
| project | string | btc_l2 only: filter by project_key; empty returns whitelist (stacks|rootstock|merlin|bob|bitlayer). Non-whitelist project returns data_status=not_in_scope. |
| end_date | string | YYYY-MM-DD; default latest part_date in index. |
| lookback | string | 30d|90d|1y when start_date empty; default 30d. |
| start_date |
Cross-sector dashboard for DeFi, spot, perp, stablecoin, or bridge categories. One bridge ranking or chain detail→get_bridge_metrics. One protocol→get_platform_info. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| category | string | all|defi|spot|perp|stablecoin|bridge or platform type; unknown values passed through; empty if no match. |
{
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "all|defi|spot|perp|stablecoin|bridge or platform type; unknown values passed through; empty if no match."
}
},
"additionalProperties": false
}Exchange reserve snapshots by venue and asset. scope=full adds por (PoR attestation). scope=full + include_flows=true returns flows.series[] (daily inflow/outflow/netflow). scope=full + include_events=true returns events[] (large_flow events). TVL history→get_platform_history. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| asset | string | Asset filter: BTC|ETH|USDT|USDC; default BTC. |
| limit | integer | Max flow rows; default 100, max 400. |
| scope | string | basic (default)|full; full adds por + optionally flows/events. |
| end_date | string | YYYY-MM-DD; default today. Filter flows by part_date. |
| exchange | string | Exchange name; empty returns all exchanges. Supports okx→okx, gate.io→gate via normalized mapping. |
| event_type | string | all|large_flow; filter events. Effective only when include_events=true. |
| start_date | string | YYYY-MM-DD; default end_date - 30d. Filter flows by part_date. |
Liquidation density by symbol and price buckets. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| range | string | Price range or bucket spec. |
| symbol* | string | Symbol e.g. BTC, ETH. |
| exchange | string | Exchange; empty = all venues. |
{
"type": "object",
"required": [
"symbol"
],
"properties": {
"range": {
"type": "string",
"description": "Price range or bucket spec."
},
"symbol": {
"type": "string",
"description": "Symbol e.g. BTC, ETH."
},
"exchange": {
"type": "string",
"description": "Exchange; empty = all venues."
}
},
"additionalProperties": false
}Daily TVL, volume, and fees time series for one named protocol. One-shot profile→get_platform_info. Ranked multi-protocol list→search_platforms. CEX perps history: pass exchange_slug (e.g. gate) or platform_name. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| metrics | null | array | tvl|volume|fees|revenue|volume_perps; default [tvl] when empty. volume_perps returns series when present in platform_history (GAP-001). |
| end_date | string | End YYYY-MM-DD. |
| start_date | string | Start YYYY-MM-DD. |
| granularity | string | day|week|month|quarter; used for volume_perps field mapping in derivatives history index; default day. |
| exchange_slug | string | DWS exchange_slug (e.g. gate); optional if platform_name is set. |
| platform_name | string | Protocol or platform display name; optional if exchange_slug is set. For volume_perps, expanded to DWS exchange_slug-style keys (e.g. Gate.io→gate) like merge path. |
{
"type": "object",
"properties": {
"metrics": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
},
"description": "tvl|volume|fees|revenue|volume_perps; default [tvl] when empty. volume_perps returns series when present in platform_history (GAP-001)."
},
"end_date": {
"type": "string",
"description": "End YYYY-MM-DD."
},
"start_date": {
"type": "string",
"description": "Start YYYY-MM-DD."
},
"granularity": {
"type": "string",
"description": "day|week|month|quarter; used for volume_perps field mapping in derivatives history index; default day."
},
"exchange_slug": {
"type": "string",
"description": "DWS exchange_slug (e.g. gate); optional if platform_name is set."
},
"platform_name": {
"type": "string",
"description": "Protocol or platform display name; optional if exchange_slug is set. For volume_perps, expanded to DWS exchange_slug-style keys (e.g. Gate.io→gate) like merge path."
}
},
"additionalProperties": false
}One-shot protocol profile by name and scope. scope=full adds competition_metrics{} for CEX venues (spot/derivs/depth/OI core+extended/PoR). Set include_oi_symbol_detail=true with oi_symbol_limit (1-100, default 20) for top-N OI breakdown. Ranked multi-protocol list→search_platforms. Daily time series→get_platform_history. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| scope | string | basic (default)|with_chain_breakdown (adds tvl_by_chain, volume_by_chain)|full (adds history_30d, top_pools, competition_metrics). |
| platform_name* | string | Protocol or platform name. |
| oi_symbol_limit | integer | Effective only when include_oi_symbol_detail=true. Default 20, range 1-100; >100 returns invalid_param. |
| include_oi_symbol_detail | boolean | scope=full only. true returns competition_metrics.oi_symbol_detail[] sorted by OI USD desc; default false. |
{
"type": "object",
"required": [
"platform_name"
],
"properties": {
"scope": {
"type": "string",
"description": "basic (default)|with_chain_breakdown (adds tvl_by_chain, volume_by_chain)|full (adds history_30d, top_pools, competition_metrics)."
},
"platform_name": {
"type": "string",
"description": "Protocol or platform name."
},
"oi_symbol_limit": {
"type": "integer",
"description": "Effective only when include_oi_symbol_detail=true. Default 20, range 1-100; >100 returns invalid_param."
},
"include_oi_symbol_detail": {
"type": "boolean",
"description": "scope=full only. true returns competition_metrics.oi_symbol_detail[] sorted by OI USD desc; default false."
}
},
"additionalProperties": false
}Stablecoin-only ranking or per-symbol chain breakdown. scope=full with sections=issuance_flow returns issuance_flows[] (CryptoQuant net issuance/redemption); sections=usage_structure returns real usage metrics; sections=depeg_events returns depeg events (stablecoin de-peg event library). Broad market dashboard→get_market_overview. Cross-sector rollup→get_defi_overview. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| chain | string | Chain filter; list mode restricts to stables with presence on chain. Extensions: all (default) or normalized chain e.g. ethereum/tron/solana/polygon. |
| limit | integer | List size; default 10, max 400; single row when symbol set. |
| scope | string | basic (default)|full; full required for sections. |
| symbol | string | Stablecoin symbol USDT/USDC/DAI/FDUSD/PYUSD; omit for ranked list or extension defaults. |
| end_date | string | UTC YYYY-MM-DD; extension window end, default latest data date for usage_structure or today for issuance_flow/depeg_events. |
| sections | null | array | Comma-separated string or array; supported values: issuance_flow, usage_structure, depeg_events when scope=full. |
Lending and LP pools by APY or TVL. scope=full adds apy_base_30d, apy_reward_30d, reward_tokens, market_share. One protocol profile→get_platform_info. TVL series→get_platform_history. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| chain | string | Chain filter. |
| limit | integer | Rows; default 20, max 400. |
| scope | string | basic (default)|full. full adds apy_base_30d, apy_reward_30d, reward_tokens, market_share. |
| symbol | string | Asset e.g. USDC, ETH-USDC. |
| project | string | Protocol e.g. aave-v3. |
| sort_by | string | apy|tvl_usd; default apy. |
| pool_type | string | Exposure single|multi or Lending|LP|Staking; maps to ES exposure. |
| min_tvl_usd | null | number | Min TVL USD; default 100000 when omitted; 0 = no floor. |
Ranked multi-protocol list with filter and sort. One-shot profile→get_platform_info. One named protocol daily series→get_platform_history. Read-only public research data. No account access, no order placement or fund transfers. Not investment advice.
| Argument | Type | Description |
|---|---|---|
| chain | string | Chain filter. |
| limit | integer | Rows; default 20, max 400. |
| sort_by | string | tvl|volume_24h|volume_spot_24h|volume_perps_24h|volume_perps_7d|volume_perps_30d|volume_perps_qtd|fees_24h; default tvl. |
| sort_order | string | asc|desc; default desc. When CEX + sort_by volume_perps_* uses the HF derivatives sub-index only, ranking follows this order; response echoes the normalized value. |
| platform_type | string | Optional filter on platform_info.platform_type. Empty or all = no filter. dex|dexs|dexes map to DEX+Dexs; derivatives|cex as labeled; defi expands to DeFi TVL group; any other value is passed through to the index (e.g. Lending, CDP, Yield). |
{
"type": "object",
"properties": {
"chain": {
"type": "string",
"description": "Chain filter."
},
"limit": {
"type": "integer",
"description": "Rows; default 20, max 400."
},
"sort_by": {
"type": "string",
"description": "tvl|volume_24h|volume_spot_24h|volume_perps_24h|volume_perps_7d|volume_perps_30d|volume_perps_qtd|fees_24h; default tvl."
},
"sort_order": {
"type": "string",
"description": "asc|desc; default desc. When CEX + sort_by volume_perps_* uses the HF derivatives sub-index only, ranking follows this order; response echoes the normalized value."
},
"platform_type": {
"type": "string",
"description": "Optional filter on platform_info.platform_type. Empty or all = no filter. dex|dexs|dexes map to DEX+Dexs; derivatives|cex as labeled; defi expands to DeFi TVL group; any other value is passed through to the index (e.g. Lending, CDP, Yield)."
}
},
"additionalProperties": false
}{
"type": "object",
"properties": {
"chain": {
"type": "string",
"description": "Chain filter: canonical name or alias (ETH→Ethereum, BSC→BNB Chain); contains match on normalized chain list."
},
"limit": {
"type": "integer",
"description": "Page size; default 20, max 400."
},
"offset": {
"type": "integer",
"description": "Offset; default 0."
},
"sort_by": {
"type": "string",
"description": "market_cap (default) | fdv | circulating_supply; all desc"
},
"category": {
"type": "string",
"description": "Controlled sector tag or group (e.g. Layer 1, DEX); case-insensitive; matches category_type_flat then category_type; unknown values return empty list."
},
"asset_type": {
"type": "string",
"description": "crypto (default) | tradefi | all"
},
"market_cap_max": {
"type": [
"null",
"number"
],
"description": "Max market cap USD."
},
"market_cap_min": {
"type": [
"null",
"number"
],
"description": "Min market cap USD; range on market_value / market_cap."
}
},
"additionalProperties": false
}| country_code | string | ISO code e.g. US when index lacks display name. |
{
"type": "object",
"required": [
"indicator"
],
"properties": {
"mode": {
"type": "string",
"description": "latest (default, snapshot) or timeseries."
},
"size": {
"type": "integer",
"description": "Rows; default 20, max 400."
},
"country": {
"type": "string",
"description": "Country display name e.g. United States; wins over country_code if both set."
},
"end_date": {
"type": "string",
"description": "Same as end_time."
},
"end_time": {
"type": "string",
"description": "Range end; alias end_date."
},
"indicator": {
"type": "string",
"description": "Exact keyword match on indicator.keyword OR indicator_id.keyword OR slugname.keyword; ASCII case-insensitive via exact variants (original, lower, upper)."
},
"start_date": {
"type": "string",
"description": "Same as start_time."
},
"start_time": {
"type": "string",
"description": "Range start; alias start_date; filters date/part_date."
},
"country_code": {
"type": "string",
"description": "ISO code e.g. US when index lacks display name."
}
},
"additionalProperties": false
}| start_time |
| integer |
| Start Unix seconds; must be paired with end_time. Omit both with limit for latest N candles. Mutually exclusive with explicit limit. |
| market_type | string | Market venue; default spot when omitted. Allowed: spot|futures|delivery|options. |
{
"type": "object",
"required": [
"symbol",
"timeframe"
],
"properties": {
"limit": {
"type": "integer",
"default": 100,
"maximum": 400,
"minimum": 1,
"description": "Max candles when no time range; omit for default 100; minimum 1, maximum 400. Over-limit rejected. Cannot combine with start_time/end_time."
},
"settle": {
"type": "string",
"description": "futures/delivery settlement; default usdt."
},
"symbol": {
"type": "string",
"minLength": 1,
"description": "Pair or contract e.g. BTC_USDT."
},
"end_time": {
"type": "integer",
"description": "End Unix seconds; must be paired with start_time. Range queries return up to 400 latest candles and may set truncated."
},
"timeframe": {
"enum": [
"1s",
"10s",
"1m",
"3m",
"5m",
"15m",
"30m",
"1h",
"2h",
"4h",
"6h",
"8h",
"12h",
"1d",
"3d",
"7d",
"30d",
"1w"
],
"type": "string",
"description": "Candle interval. start_time/end_time are Unix seconds."
},
"start_time": {
"type": "integer",
"description": "Start Unix seconds; must be paired with end_time. Omit both with limit for latest N candles. Mutually exclusive with explicit limit."
},
"market_type": {
"enum": [
"spot",
"futures",
"delivery",
"options"
],
"type": "string",
"description": "Market venue; default spot when omitted. Allowed: spot|futures|delivery|options."
}
},
"additionalProperties": false
}| If true, include technical columns in _source; default OHLCV only. |
{
"type": "object",
"required": [
"symbol",
"timeframe"
],
"properties": {
"size": {
"type": "integer",
"description": "Row count; alias of limit; default 100, max 400."
},
"limit": {
"type": "integer",
"description": "Row count; default 100, max 400; alternative to size."
},
"period": {
"type": "string",
"description": "Window: 1h|4h|24h|7d|3d|5d|10d; default 24h. Ignored when start/end set."
},
"symbol": {
"type": "string",
"description": "Symbol e.g. BTC, ETH."
},
"end_time": {
"type": "string",
"description": "Absolute end."
},
"timeframe": {
"type": "string",
"description": "Candle interval: 1m|5m|15m|1h|4h|1d."
},
"start_time": {
"type": "string",
"description": "Absolute start: ms timestamp or ISO8601; wins over period when paired with end."
},
"with_indicators": {
"type": [
"null",
"boolean"
],
"description": "If true, include technical columns in _source; default OHLCV only."
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"address"
],
"properties": {
"chain": {
"type": "string",
"description": "Chain id e.g. eth, trx, bsc, btc, sol, base, arb. Omit to auto-detect from labels; default eth if unknown."
},
"scope": {
"type": "string",
"description": "basic (default) | with_defi | with_counterparties | with_pnl | full. full merges all extensions; empty sections may be [] or null. detailed maps to full."
},
"address": {
"type": "string",
"description": "On-chain address."
},
"min_value_usd": {
"type": [
"null",
"number"
],
"description": "Min token balance USD; keep rows with parsed value_usd >= threshold. 0 keeps non-negative; unset/unparseable value_usd dropped."
},
"upstream_raw_mode": {
"type": "string",
"description": "off (default) | lite | full. Prefer off for public MCP. include_upstream_raw=true forces full."
},
"include_upstream_raw": {
"type": "boolean",
"description": "Prefer false (default). If true, include New Explorer ApiResponse.data as new_explorer_*_raw; large payload, not for public clients."
}
},
"additionalProperties": false
}| string |
| Filter recipient; maps to explorer GET to or POST body to. BlockInfo path ignores. |
| from_address | string | Filter sender; maps to explorer GET from or POST transfers from. BlockInfo path ignores. |
| min_value_usd | number | If >0, keep rows with value_usd >= threshold (same semantics as get_address_info min_value_usd). May map to explorer query when supported. |
| nonzero_value | boolean | If true, drop zero-amount token_transfer rows; passes nonzero_value to explorer POST when used. |
| upstream_raw_mode | string | off (default) | lite | full. Prefer off for public MCP. include_upstream_raw=true forces full. |
| include_upstream_raw | boolean | Prefer false (default). If true, include new_explorer_address_*_raw and per-item source_raw; large payload, not for public clients. |
{
"type": "object",
"required": [
"address"
],
"properties": {
"chain": {
"type": "string",
"description": "Chain id (eth, trx, bsc, btc, sol, base, arb, ...); default eth."
},
"limit": {
"type": "integer",
"description": "Max rows; default 20, max 400; maps to explorer page_size. Some filters apply only to GET list paths."
},
"address": {
"type": "string",
"description": "On-chain address."
},
"tx_type": {
"type": "string",
"description": "transfer | contract_call | token_transfer | all (default)."
},
"end_time": {
"type": "integer",
"description": "End Unix seconds."
},
"start_time": {
"type": "integer",
"description": "Start Unix seconds; pair with end_time; absolute wins over time_range."
},
"time_range": {
"type": "string",
"description": "Relative window vs start/end: 1h|24h|1d|7d|30d|90d as [now-Δ, now]. Ignored if start_time or end_time set."
},
"to_address": {
"type": "string",
"description": "Filter recipient; maps to explorer GET to or POST body to. BlockInfo path ignores."
},
"from_address": {
"type": "string",
"description": "Filter sender; maps to explorer GET from or POST transfers from. BlockInfo path ignores."
},
"min_value_usd": {
"type": "number",
"description": "If >0, keep rows with value_usd >= threshold (same semantics as get_address_info min_value_usd). May map to explorer query when supported."
},
"nonzero_value": {
"type": "boolean",
"description": "If true, drop zero-amount token_transfer rows; passes nonzero_value to explorer POST when used."
},
"upstream_raw_mode": {
"type": "string",
"description": "off (default) | lite | full. Prefer off for public MCP. include_upstream_raw=true forces full."
},
"include_upstream_raw": {
"type": "boolean",
"description": "Prefer false (default). If true, include new_explorer_address_*_raw and per-item source_raw; large payload, not for public clients."
}
},
"additionalProperties": false
}| string |
| YYYY-MM-DD; default derived from lookback or 30d. |
| granularity | string | l2 only: day (default); hour or minute returns unsupported_granularity. |
| metric_group* | string | Metric group: staking (Ethereum beacon daily) | l2 (L2 ops daily from growthepie+L2Beat) | btc_l2 (BTC L2 protocol ecosystem tvl/protocol_count/tx_count_1d/active_addresses_1d/bridge_volume_24h_usd from dwd_external_btc_protocol_di). |
{
"type": "object",
"required": [
"metric_group"
],
"properties": {
"chain": {
"type": "string",
"description": "Chain; staking defaults empty to ethereum; l2 supports base/arbitrum/optimism/linea/zksync_era/blast or empty for all chains; btc_l2 defaults empty to btc (required)."
},
"limit": {
"type": "integer",
"description": "l2 only: max series rows returned; 0 means no extra cap beyond date window."
},
"project": {
"type": "string",
"description": "btc_l2 only: filter by project_key; empty returns whitelist (stacks|rootstock|merlin|bob|bitlayer). Non-whitelist project returns data_status=not_in_scope."
},
"end_date": {
"type": "string",
"description": "YYYY-MM-DD; default latest part_date in index."
},
"lookback": {
"type": "string",
"description": "30d|90d|1y when start_date empty; default 30d."
},
"start_date": {
"type": "string",
"description": "YYYY-MM-DD; default derived from lookback or 30d."
},
"granularity": {
"type": "string",
"description": "l2 only: day (default); hour or minute returns unsupported_granularity."
},
"metric_group": {
"type": "string",
"description": "Metric group: staking (Ethereum beacon daily) | l2 (L2 ops daily from growthepie+L2Beat) | btc_l2 (BTC L2 protocol ecosystem tvl/protocol_count/tx_count_1d/active_addresses_1d/bridge_volume_24h_usd from dwd_external_btc_protocol_di)."
}
},
"additionalProperties": false
}| include_flows |
| boolean |
| scope=full only. true returns flows.series[]. |
| history_window | string | Only effective when include_history=true; currently only quarter is supported. |
| include_events | boolean | scope=full only. true returns events[]. |
| include_history | boolean | Default false. true returns precomputed comparison fields only, not raw historical snapshots. |
{
"type": "object",
"properties": {
"asset": {
"type": "string",
"description": "Asset filter: BTC|ETH|USDT|USDC; default BTC."
},
"limit": {
"type": "integer",
"description": "Max flow rows; default 100, max 400."
},
"scope": {
"type": "string",
"description": "basic (default)|full; full adds por + optionally flows/events."
},
"end_date": {
"type": "string",
"description": "YYYY-MM-DD; default today. Filter flows by part_date."
},
"exchange": {
"type": "string",
"description": "Exchange name; empty returns all exchanges. Supports okx→okx, gate.io→gate via normalized mapping."
},
"event_type": {
"type": "string",
"description": "all|large_flow; filter events. Effective only when include_events=true."
},
"start_date": {
"type": "string",
"description": "YYYY-MM-DD; default end_date - 30d. Filter flows by part_date."
},
"include_flows": {
"type": "boolean",
"description": "scope=full only. true returns flows.series[]."
},
"history_window": {
"type": "string",
"description": "Only effective when include_history=true; currently only quarter is supported."
},
"include_events": {
"type": "boolean",
"description": "scope=full only. true returns events[]."
},
"include_history": {
"type": "boolean",
"description": "Default false. true returns precomputed comparison fields only, not raw historical snapshots."
}
},
"additionalProperties": false
}| start_date | string | UTC YYYY-MM-DD; extension window start, default last 30 days. depeg_events: default 2020-01-01. |
| min_deviation | number | depeg_events only: filter events with max_deviation >= this value. Range 0.001-0.2, default 0.005. |
| review_status | string | depeg_events only: candidate|approved|rejected; default approved (only returns reviewed events). |
{
"type": "object",
"properties": {
"chain": {
"type": "string",
"description": "Chain filter; list mode restricts to stables with presence on chain. Extensions: all (default) or normalized chain e.g. ethereum/tron/solana/polygon."
},
"limit": {
"type": "integer",
"description": "List size; default 10, max 400; single row when symbol set."
},
"scope": {
"type": "string",
"description": "basic (default)|full; full required for sections."
},
"symbol": {
"type": "string",
"description": "Stablecoin symbol USDT/USDC/DAI/FDUSD/PYUSD; omit for ranked list or extension defaults."
},
"end_date": {
"type": "string",
"description": "UTC YYYY-MM-DD; extension window end, default latest data date for usage_structure or today for issuance_flow/depeg_events."
},
"sections": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
},
"description": "Comma-separated string or array; supported values: issuance_flow, usage_structure, depeg_events when scope=full."
},
"start_date": {
"type": "string",
"description": "UTC YYYY-MM-DD; extension window start, default last 30 days. depeg_events: default 2020-01-01."
},
"min_deviation": {
"type": "number",
"description": "depeg_events only: filter events with max_deviation >= this value. Range 0.001-0.2, default 0.005."
},
"review_status": {
"type": "string",
"description": "depeg_events only: candidate|approved|rejected; default approved (only returns reviewed events)."
}
},
"additionalProperties": false
}{
"type": "object",
"properties": {
"chain": {
"type": "string",
"description": "Chain filter."
},
"limit": {
"type": "integer",
"description": "Rows; default 20, max 400."
},
"scope": {
"type": "string",
"description": "basic (default)|full. full adds apy_base_30d, apy_reward_30d, reward_tokens, market_share."
},
"symbol": {
"type": "string",
"description": "Asset e.g. USDC, ETH-USDC."
},
"project": {
"type": "string",
"description": "Protocol e.g. aave-v3."
},
"sort_by": {
"type": "string",
"description": "apy|tvl_usd; default apy."
},
"pool_type": {
"type": "string",
"description": "Exposure single|multi or Lending|LP|Staking; maps to ES exposure."
},
"min_tvl_usd": {
"type": [
"null",
"number"
],
"description": "Min TVL USD; default 100000 when omitted; 0 = no floor."
}
},
"additionalProperties": false
}