mcp
Read-only Hyperliquid data for AI agents: fills, candles, funding, liquidations, wallet analytics.
我该使用它吗
质量与安全性
A
发现（7）
- HIGHTool poisoning patterns detected
- MEDIUMTool description contains URL to non-standard domain在 run_query 中
- LOWTool 'get_mark_prices' description lacks action verb在 get_mark_prices 中
- LOWTool 'get_user_maker_taker' description lacks action verb在 get_user_maker_taker 中
- LOWTool 'get_pnl_leaderboard' description lacks action verb在 get_pnl_leaderboard 中
- LOWTool 'get_market_top_wallets' description lacks action verb在 get_market_top_wallets 中
- LOWTool 'get_user_pnl_series' description lacks action verb在 get_user_pnl_series 中
基于对工具定义和协议合规性的自动分析。
上下文开销
~12,768token 数（工具定义）
~3.6 KB典型响应大小
对注意力有显著影响（占 128k 上下文窗口的 9.98%）
这是每次将服务器的工具加载到模型上下文窗口时所消耗的大致 token 数。数值越高，可用于其他任务的注意力就越少。
安装
一键安装
将以下内容添加到你的 `claude_desktop_config.json` 文件中：
{
"mcpServers": {
"mcp": {
"command": "npx",
"args": [
"@ironflowsh/mcp"
]
}
}
}可运行的软件包
npm@ironflowsh/mcp
0.9.0stdio远程端点
https://mcp.ironflow.sh/mcpstreamable-http它能做什么
工具清单
工具（36）
🟢 只读🟡 写入🔴 删除⚪ 未知
🟢describe_data
Start here for any Hyperliquid question the other tools do not answer directly. Returns the SQL tables you can query with run_query (every fill, per-wallet daily totals, wallet behaviour labels, funding, mark and oracle prices, open interest, liquidations, builder-code fills, transfers, vault flows), their columns, how far back each goes, query tips, worked examples and your own limits.
输入模式
{
"type": "object",
"properties": {},
"required": []
}输出模式
{
"type": "object",
"properties": {
"dialect": {
"description": "SQL dialect and database name"
},
"tables": {
"type": "array",
"description": "Queryable tables",
"items": {
"type": "object",
"description": "One table",
"properties": {
"name": {
"description": "Table name, e.g. hl.fills"
},
"description": {
"description": "What one row is"
},
"time_column": {
"description": "Column the history window filters on"
},
"data_from": {
"description": "How far back the table goes"
},
"columns": {
"type": "array",
"description": "Columns",
"items": {
"type": "object",
"description": "One column",
"properties": {
"name": {
"description": "Name"
},
"type": {
"description": "ClickHouse type"
},
"description": {
"description": "Meaning"
}
}
}
}
}
}
},
"tips": {
"type": "array",
"description": "Query tips",
"items": {
"description": "One tip"
}
},
"examples": {
"type": "array",
"description": "Worked examples",
"items": {
"type": "object",
"description": "One example",
"properties": {
"question": {
"description": "Question"
},
"sql": {
"description": "SQL that answers it"
}
}
}
},
"limits": {
"description": "Your tier's limits: history_days, max_execution_seconds, max_rows, budget_seconds_per_hour"
},
"tiers": {
"type": "array",
"description": "Every tier's limits",
"items": {
"description": "One tier"
}
}
},
"description": "Catalog of the SQL tables run_query can read"
}🟢run_query(sql, max_rows)
Run one read-only ClickHouse SELECT over Ironflow's Hyperliquid tables (hl.fills, hl.wallet_daily, hl.wallet_behavior, hl.funding, hl.mark_prices, hl.oracle_prices, hl.open_interest, hl.liquidations, hl.builder_fills, hl.transfers, hl.vault_operations). Call describe_data first for columns and examples. Aggregate in SQL: results are capped (1,000 rows keyless). Keyless: last 24 hours, 5 s per query, 60 query seconds per hour per IP; a free key from https://ironflow.sh/key gives 30 days of history.
输入模式
{
"type": "object",
"properties": {
"sql": {
"type": "string",
"description": "One ClickHouse SELECT (or WITH ... SELECT) over hl.* tables, without a FORMAT clause"
},
"max_rows": {
"type": "number",
"description": "Most rows to return (default 200, capped by your tier)"
}
},
"required": [
"sql"
]
}输出模式
{
"type": "object",
"properties": {
"columns": {
"type": "array",
"description": "Column names in row order",
"items": {
"description": "Name"
}
},
"column_types": {
"type": "array",
"description": "ClickHouse types in row order",
"items": {
"description": "Type"
}
},
"rows": {
"type": "array",
"description": "Rows as positional arrays",
"items": {
"description": "One row"
}
},
"row_count": {
"description": "Rows returned"
},
"truncated": {
"description": "true when more rows existed than were returned"
},
"stats": {
"description": "elapsed_ms, rows_read, bytes_read"
},
"limits": {
"description": "Your tier's limits"
},
"budget_remaining_seconds": {
"description": "Query seconds left this hour"
}
},
"description": "Query result"
}🟢get_wallet_behavior(addresses, label, sort_by, min_volume_usd, limit)
How Hyperliquid wallets trade, from their last 30 days: labels (market_maker, high_frequency, whale, directional, consistent_winner, big_loser, revenge_sizing, often_liquidated, hip3_trader, spot_trader, prediction_trader) and the numbers behind them (maker share, buy/sell imbalance, fills per day, green-day share, profit factor, liquidations). Look up specific addresses, or list wallets with one label.
输入模式
{
"type": "object",
"properties": {
"addresses": {
"type": "string",
"description": "Comma-separated wallet addresses (up to 50). Omit to list wallets instead."
},
"label": {
"type": "string",
"description": "Only wallets carrying this label",
"enum": [
"market_maker",
"high_frequency",
"whale",
"directional",
"consistent_winner",
"big_loser",
"revenge_sizing",
"often_liquidated",
"hip3_trader",
"spot_trader",
"prediction_trader"
]
},
"sort_by": {
"type": "string",
"description": "Sort order when listing (default volume)",
"enum": [
"volume",
"pnl",
"fills",
"liquidations"
]
},
"min_volume_usd": {
"type": "number",
"description": "Only wallets with at least this 30-day volume"
},
"limit": {
"type": "number",
"description": "Wallets to return (default 20, max 100)"
}
},
"required": []
}输出模式
{
"type": "object",
"properties": {
"window_days": {
"description": "Days the features cover"
},
"wallets": {
"type": "array",
"description": "Wallets",
"items": {
"type": "object",
"description": "One wallet",
"properties": {
"address": {
"description": "Wallet address"
},
"labels": {
"type": "array",
"description": "Behaviour labels",
"items": {
"description": "Label"
}
},
"volume_usd": {
"description": "30-day volume in USD"
},
"realized_pnl_usd": {
"description": "30-day realized PnL in USD"
},
"maker_share": {
"description": "Maker volume / volume"
},
"fills_per_day": {
"description": "Fills per active day"
},
"liquidations": {
"description": "Liquidation events"
}
}
}
}
},
"description": "Wallet trading behaviour over the last 30 days"
}🟢get_price(market)
Latest mark price of a Hyperliquid market: native perps, HIP-3 builder perps (e.g. xyz:NVDA-PERP) and spot.
输入模式
{
"type": "object",
"properties": {
"market": {
"type": "string",
"description": "Market symbol — native HL perp (e.g. \"BTC-PERP\", \"ETH-PERP\") or HIP-3 builder market namespaced as \"<issuer>:<base>-PERP\" (e.g. \"flx:GAS-PERP\", \"xyz:NVDA-PERP\")"
}
},
"required": [
"market"
]
}输出模式
{
"type": "object",
"properties": {
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"price": {
"description": "Price in USD"
}
},
"description": "Latest mark price"
}🟢get_recent_trades(market, limit)
Latest tick-level trades on a Hyperliquid market from our own nodes: price, size, side and block time. Covers native perps, HIP-3 builder markets, HIP-4 outcomes and spot.
输入模式
{
"type": "object",
"properties": {
"market": {
"type": "string",
"description": "Market symbol — native HL perp (e.g. \"BTC-PERP\", \"ETH-PERP\") or HIP-3 builder market namespaced as \"<issuer>:<base>-PERP\" (e.g. \"flx:GAS-PERP\", \"xyz:NVDA-PERP\")"
},
"limit": {
"type": "number",
"description": "Number of trades to return (1-100, default 20)"
}
},
"required": [
"market"
]
}输出模式
{
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Trades, newest first",
"items": {
"type": "object",
"description": "One row",
"properties": {
"source": {
"description": "Venue, always hyperliquid"
},
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"issuer": {
"description": "HIP-3 builder code (\"\" for native markets)"
},
"base_market": {
"description": "Display symbol without the HIP-3 issuer prefix"
},
"display_symbol": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"venue": {
"description": "Venue, always hyperliquid"
},
"quote_asset": {
"description": "Quote asset, e.g. USDC"
},
"timestamp": {
"description": "Unix milliseconds"
},
"market_type": {
"description": "perp, spot or prediction"
},
"block_number": {
"description": "Hyperliquid block height"
},
"sequence": {
"description": "Order of the event within its block"
},
"price": {
"description": "Price in USD"
},
"size": {
"description": "Size in base units"
},
"side": {
"description": "Fill side, \"buy\" or \"sell\""
},
"address": {
"description": "Wallet address (0x…)"
},
"fee": {
"description": "Fee paid in USD"
},
"realized_pnl": {
"description": "Realized PnL in USD"
}
}
}
},
"pagination": {
"type": "object",
"description": "Cursor pagination",
"properties": {
"next_cursor": {
"description": "Pass as cursor to fetch the next page; null on the last page"
},
"has_more": {
"description": "Whether more rows exist"
}
}
}
},
"description": "Trades, newest first"
}🟢get_candles(market, interval, limit)
OHLCV candles for a Hyperliquid market, computed from tick-level trades.
输入模式
{
"type": "object",
"properties": {
"market": {
"type": "string",
"description": "Market symbol — native HL perp (e.g. \"BTC-PERP\", \"ETH-PERP\") or HIP-3 builder market namespaced as \"<issuer>:<base>-PERP\" (e.g. \"flx:GAS-PERP\", \"xyz:NVDA-PERP\")"
},
"interval": {
"type": "string",
"description": "Candle interval (1m, 5m, 15m, 1h, 4h, 1d). Default: 1h",
"enum": [
"1m",
"5m",
"15m",
"1h",
"4h",
"1d"
]
},
"limit": {
"type": "number",
"description": "Number of candles to return (1-500, default 24)"
}
},
"required": [
"market"
]
}输出模式
{
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "OHLCV candles",
"items": {
"type": "object",
"description": "One row",
"properties": {
"source": {
"description": "Venue, always hyperliquid"
},
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"issuer": {
"description": "HIP-3 builder code (\"\" for native markets)"
},
"base_market": {
"description": "Display symbol without the HIP-3 issuer prefix"
},
"display_symbol": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"venue": {
"description": "Venue, always hyperliquid"
},
"quote_asset": {
"description": "Quote asset, e.g. USDC"
},
"timestamp": {
"description": "Unix milliseconds"
},
"interval": {
"description": "Candle interval"
},
"open": {
"description": "Open price"
},
"high": {
"description": "High price"
},
"low": {
"description": "Low price"
},
"close": {
"description": "Close price"
},
"volume": {
"description": "Volume in base units"
},
"trade_count": {
"description": "Trades in the candle"
}
}
}
},
"pagination": {
"type": "object",
"description": "Cursor pagination",
"properties": {
"next_cursor": {
"description": "Pass as cursor to fetch the next page; null on the last page"
},
"has_more": {
"description": "Whether more rows exist"
}
}
}
},
"description": "OHLCV candles"
}🟢get_funding_rates(market, limit)
Hourly funding rate history for a Hyperliquid perp, including HIP-3 builder perps. A positive rate means longs pay shorts.
输入模式
{
"type": "object",
"properties": {
"market": {
"type": "string",
"description": "Market symbol — native HL perp (e.g. \"BTC-PERP\", \"ETH-PERP\") or HIP-3 builder market namespaced as \"<issuer>:<base>-PERP\" (e.g. \"flx:GAS-PERP\", \"xyz:NVDA-PERP\")"
},
"limit": {
"type": "number",
"description": "Number of funding rate entries (1-100, default 10)"
}
},
"required": [
"market"
]
}输出模式
{
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Hourly funding rates",
"items": {
"type": "object",
"description": "One row",
"properties": {
"source": {
"description": "Venue, always hyperliquid"
},
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"issuer": {
"description": "HIP-3 builder code (\"\" for native markets)"
},
"base_market": {
"description": "Display symbol without the HIP-3 issuer prefix"
},
"display_symbol": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"venue": {
"description": "Venue, always hyperliquid"
},
"quote_asset": {
"description": "Quote asset, e.g. USDC"
},
"timestamp": {
"description": "Unix milliseconds"
},
"rate": {
"description": "Hourly funding rate; positive means longs pay shorts"
},
"sequence": {
"description": "Order of the event within its block"
}
}
}
},
"pagination": {
"type": "object",
"description": "Cursor pagination",
"properties": {
"next_cursor": {
"description": "Pass as cursor to fetch the next page; null on the last page"
},
"has_more": {
"description": "Whether more rows exist"
}
}
}
},
"description": "Hourly funding rates"
}🟢get_open_interest(market)
Latest open interest for a Hyperliquid perp.
输入模式
{
"type": "object",
"properties": {
"market": {
"type": "string",
"description": "Market symbol — native HL perp (e.g. \"BTC-PERP\", \"ETH-PERP\") or HIP-3 builder market namespaced as \"<issuer>:<base>-PERP\" (e.g. \"flx:GAS-PERP\", \"xyz:NVDA-PERP\")"
}
},
"required": [
"market"
]
}输出模式
{
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Open interest samples",
"items": {
"type": "object",
"description": "One row",
"properties": {
"source": {
"description": "Venue, always hyperliquid"
},
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"issuer": {
"description": "HIP-3 builder code (\"\" for native markets)"
},
"base_market": {
"description": "Display symbol without the HIP-3 issuer prefix"
},
"display_symbol": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"venue": {
"description": "Venue, always hyperliquid"
},
"quote_asset": {
"description": "Quote asset, e.g. USDC"
},
"timestamp": {
"description": "Unix milliseconds"
},
"open_interest": {
"description": "Open interest in base units"
},
"volume_24h": {
"description": "24h volume in USD"
}
}
}
},
"pagination": {
"type": "object",
"description": "Cursor pagination",
"properties": {
"next_cursor": {
"description": "Pass as cursor to fetch the next page; null on the last page"
},
"has_more": {
"description": "Whether more rows exist"
}
}
}
},
"description": "Open interest samples"
}🟢get_liquidations(market, limit)
Liquidations on a Hyperliquid perp, read from our own nodes: price, size, side and the liquidated wallet. Hyperliquid's public API has no liquidation feed.
输入模式
{
"type": "object",
"properties": {
"market": {
"type": "string",
"description": "Market symbol — native HL perp (e.g. \"BTC-PERP\", \"ETH-PERP\") or HIP-3 builder market namespaced as \"<issuer>:<base>-PERP\" (e.g. \"flx:GAS-PERP\", \"xyz:NVDA-PERP\")"
},
"limit": {
"type": "number",
"description": "Number of liquidation events (1-100, default 20)"
}
},
"required": [
"market"
]
}输出模式
{
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Liquidations",
"items": {
"type": "object",
"description": "One row",
"properties": {
"source": {
"description": "Venue, always hyperliquid"
},
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"issuer": {
"description": "HIP-3 builder code (\"\" for native markets)"
},
"base_market": {
"description": "Display symbol without the HIP-3 issuer prefix"
},
"display_symbol": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"venue": {
"description": "Venue, always hyperliquid"
},
"quote_asset": {
"description": "Quote asset, e.g. USDC"
},
"timestamp": {
"description": "Unix milliseconds"
},
"market_type": {
"description": "perp, spot or prediction"
},
"block_number": {
"description": "Hyperliquid block height"
},
"address": {
"description": "Liquidated wallet"
},
"side": {
"description": "The liquidated wallet's fill side: \"sell\" closed a long, \"buy\" closed a short"
},
"price": {
"description": "Price in USD"
},
"size": {
"description": "Size in base units"
},
"realized_pnl": {
"description": "Realized PnL in USD"
}
}
}
},
"pagination": {
"type": "object",
"description": "Cursor pagination",
"properties": {
"next_cursor": {
"description": "Pass as cursor to fetch the next page; null on the last page"
},
"has_more": {
"description": "Whether more rows exist"
}
}
}
},
"description": "Liquidations"
}🟢get_liquidation_summary(minutes, market)
Liquidations across every Hyperliquid market (or one market) over the last N minutes, totalled: count, notional, longs vs shorts liquidated, the top markets and the largest single liquidation. Use it for 'who got liquidated in the last hour?'. Keyless calls can look back 60 minutes, keyed calls up to 240.
输入模式
{
"type": "object",
"properties": {
"minutes": {
"type": "number",
"description": "Lookback in minutes (default 60, max 240)"
},
"market": {
"type": "string",
"description": "Optional market filter (e.g. \"BTC-PERP\")"
}
},
"required": []
}输出模式
{
"type": "object",
"properties": {
"from": {
"description": "Window start, Unix milliseconds"
},
"to": {
"description": "Window end, Unix milliseconds"
},
"market": {
"description": "Market filter, or null for all markets"
},
"count": {
"description": "Number of liquidations"
},
"notional_usd": {
"description": "Liquidated notional in USD"
},
"longs_liquidated_usd": {
"description": "Notional of liquidated longs in USD"
},
"shorts_liquidated_usd": {
"description": "Notional of liquidated shorts in USD"
},
"by_market": {
"type": "array",
"description": "Top markets by liquidated notional",
"items": {
"type": "object",
"description": "One market",
"properties": {
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"count": {
"description": "Liquidations"
},
"notional_usd": {
"description": "Notional in USD"
}
}
}
},
"largest": {
"type": "object",
"description": "Largest single liquidation, or null when there were none",
"properties": {
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"side": {
"description": "\"long\" or \"short\""
},
"notional_usd": {
"description": "Notional in USD"
},
"price": {
"description": "Price in USD"
},
"address": {
"description": "Wallet address (0x…)"
},
"timestamp": {
"description": "Unix milliseconds"
}
}
},
"complete": {
"description": "False when the page cap was hit and totals are a lower bound"
}
},
"description": "Liquidation totals over the window"
}🟢get_fills(address, market, limit)
Every fill for one Hyperliquid wallet, optionally for one market, from indexed history: price, size, side, fee and realized PnL. Hyperliquid's own userFills endpoints stop at the 10,000 most recent fills.
输入模式
{
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Wallet address (e.g. 0x...)"
},
"market": {
"type": "string",
"description": "Optional market filter — native HL (e.g. \"BTC-PERP\") or HIP-3 builder market \"<issuer>:<base>-PERP\" (e.g. \"flx:GAS-PERP\")"
},
"limit": {
"type": "number",
"description": "Number of fills (1-100, default 20)"
}
},
"required": [
"address"
]
}输出模式
{
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Fills for one wallet, newest first",
"items": {
"type": "object",
"description": "One row",
"properties": {
"source": {
"description": "Venue, always hyperliquid"
},
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"issuer": {
"description": "HIP-3 builder code (\"\" for native markets)"
},
"base_market": {
"description": "Display symbol without the HIP-3 issuer prefix"
},
"display_symbol": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"venue": {
"description": "Venue, always hyperliquid"
},
"quote_asset": {
"description": "Quote asset, e.g. USDC"
},
"timestamp": {
"description": "Unix milliseconds"
},
"market_type": {
"description": "perp, spot or prediction"
},
"block_number": {
"description": "Hyperliquid block height"
},
"price": {
"description": "Price in USD"
},
"size": {
"description": "Size in base units"
},
"side": {
"description": "Fill side, \"buy\" or \"sell\""
},
"direction": {
"description": "e.g. \"Open Long\", \"Close Short\""
},
"fee": {
"description": "Fee paid in USD"
},
"realized_pnl": {
"description": "Realized PnL in USD"
},
"address": {
"description": "Wallet address (0x…)"
}
}
}
},
"pagination": {
"type": "object",
"description": "Cursor pagination",
"properties": {
"next_cursor": {
"description": "Pass as cursor to fetch the next page; null on the last page"
},
"has_more": {
"description": "Whether more rows exist"
}
}
}
},
"description": "Fills for one wallet, newest first"
}🟢get_mark_prices(market)
Mark price and oracle price series for a Hyperliquid perp.
输入模式
{
"type": "object",
"properties": {
"market": {
"type": "string",
"description": "Market symbol — native HL perp (e.g. \"BTC-PERP\") or HIP-3 builder market \"<issuer>:<base>-PERP\" (e.g. \"flx:GAS-PERP\")"
}
},
"required": [
"market"
]
}输出模式
{
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Mark price samples",
"items": {
"type": "object",
"description": "One row",
"properties": {
"source": {
"description": "Venue, always hyperliquid"
},
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"issuer": {
"description": "HIP-3 builder code (\"\" for native markets)"
},
"base_market": {
"description": "Display symbol without the HIP-3 issuer prefix"
},
"display_symbol": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"venue": {
"description": "Venue, always hyperliquid"
},
"quote_asset": {
"description": "Quote asset, e.g. USDC"
},
"timestamp": {
"description": "Unix milliseconds"
},
"mark_price": {
"description": "Mark price"
},
"oracle_price": {
"description": "Oracle price"
},
"funding_rate": {
"description": "Current hourly funding rate"
}
}
}
},
"pagination": {
"type": "object",
"description": "Cursor pagination",
"properties": {
"next_cursor": {
"description": "Pass as cursor to fetch the next page; null on the last page"
},
"has_more": {
"description": "Whether more rows exist"
}
}
}
},
"description": "Mark price samples"
}🟢get_vault_operations(vault, address, limit)
Deposits into and withdrawals from Hyperliquid vaults. Pass a vault address, a depositor address, or both; one is required.
输入模式
{
"type": "object",
"properties": {
"vault": {
"type": "string",
"description": "Vault address"
},
"address": {
"type": "string",
"description": "User address"
},
"limit": {
"type": "number",
"description": "Number of events (1-100, default 20)"
}
},
"required": []
}输出模式
{
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Vault deposits and withdrawals",
"items": {
"type": "object",
"description": "One row",
"properties": {
"source": {
"description": "Venue, always hyperliquid"
},
"timestamp": {
"description": "Unix milliseconds"
},
"block_number": {
"description": "Hyperliquid block height"
},
"address": {
"description": "Depositor"
},
"vault": {
"description": "Vault address"
},
"operation": {
"description": "deposit or withdraw"
},
"token": {
"description": "Token, usually USDC"
},
"requested_amount": {
"description": "Requested amount"
},
"net_amount": {
"description": "Amount after commission and closing cost"
},
"commission": {
"description": "Leader commission"
},
"closing_cost": {
"description": "Cost of closing positions for the withdrawal"
}
}
}
},
"pagination": {
"type": "object",
"description": "Cursor pagination",
"properties": {
"next_cursor": {
"description": "Pass as cursor to fetch the next page; null on the last page"
},
"has_more": {
"description": "Whether more rows exist"
}
}
}
},
"description": "Vault deposits and withdrawals"
}🟢get_liquidation_levels(market, bucket_size)
Liquidated notional on a Hyperliquid perp bucketed by price: where longs and shorts were wiped out. Needs a Builder or Enterprise key; keyless and free-key calls return 403.
输入模式
{
"type": "object",
"properties": {
"market": {
"type": "string",
"description": "Market symbol — native HL perp (e.g. \"BTC-PERP\") or HIP-3 builder market \"<issuer>:<base>-PERP\" (e.g. \"flx:GAS-PERP\")"
},
"bucket_size": {
"type": "string",
"description": "Price bucket size (1, 5, 10, 50, 100, 500, 1000, 5000). Default: 100"
}
},
"required": [
"market"
]
}输出模式
{
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Price buckets",
"items": {
"type": "object",
"description": "One bucket",
"properties": {
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
}
}
}
}
},
"description": "Liquidated notional by price bucket"
}🟢get_vault_leaderboard(limit)
Hyperliquid vaults ranked by net deposits. Needs a Builder or Enterprise key; keyless and free-key calls return 403.
输入模式
{
"type": "object",
"properties": {
"limit": {
"type": "number",
"description": "Number of vaults (default 10)"
}
},
"required": []
}输出模式
{
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Vaults",
"items": {
"type": "object",
"description": "One vault",
"properties": {
"vault": {
"description": "Vault address"
}
}
}
}
},
"description": "Vaults ranked by net deposits"
}🟢get_funding_stats(market, interval, limit)
Funding statistics per time bucket for a Hyperliquid perp: average, minimum, maximum and annualized rate.
输入模式
{
"type": "object",
"properties": {
"market": {
"type": "string",
"description": "Market symbol — native HL perp (e.g. \"BTC-PERP\") or HIP-3 builder market \"<issuer>:<base>-PERP\" (e.g. \"flx:GAS-PERP\")"
},
"interval": {
"type": "string",
"description": "Time interval (1h, 4h, 8h, 1d, 7d). Default: 1d",
"enum": [
"1h",
"4h",
"8h",
"1d",
"7d"
]
},
"limit": {
"type": "number",
"description": "Number of data points (default 7)"
}
},
"required": [
"market"
]
}输出模式
{
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Buckets",
"items": {
"type": "object",
"description": "One bucket",
"properties": {
"source": {
"description": "Venue, always hyperliquid"
},
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"bucket": {
"description": "Bucket start, Unix milliseconds"
},
"avg_rate": {
"description": "Average hourly rate"
},
"min_rate": {
"description": "Lowest hourly rate"
},
"max_rate": {
"description": "Highest hourly rate"
},
"cumulative_rate": {
"description": "Sum of hourly rates in the bucket"
}
}
}
}
},
"description": "Funding statistics per time bucket"
}🟢get_user_state(address)
Open positions and unrealized PnL for a Hyperliquid wallet right now, across native and HIP-3 perps. Use it for questions like 'is this wallet long or short?'
输入模式
{
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "0x-prefixed 20-byte hex address"
}
},
"required": [
"address"
]
}输出模式
{
"type": "object",
"properties": {
"address": {
"description": "Wallet address (0x…)"
},
"as_of_ts": {
"description": "Snapshot time, Unix milliseconds"
},
"asset_positions": {
"type": "array",
"description": "Open positions",
"items": {
"type": "object",
"description": "Open position",
"properties": {
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"market_class": {
"description": "perp, spot, prediction or option"
},
"size": {
"description": "Signed size: positive long, negative short"
},
"entry_price": {
"description": "Average entry price"
},
"mark_price": {
"description": "Current mark price"
},
"position_value": {
"description": "Position value in USD"
},
"unrealized_pnl": {
"description": "Unrealized PnL in USD"
},
"realized_pnl": {
"description": "Realized PnL in USD"
},
"return_on_equity": {
"description": "Unrealized PnL divided by margin"
},
"leverage": {
"description": "Leverage"
},
"leverage_type": {
"description": "cross or isolated"
}
}
}
},
"margin_summary": {
"type": "object",
"description": "Account totals",
"properties": {
"total_position_value": {
"description": "Sum of position values in USD"
},
"total_unrealized_pnl": {
"description": "Sum of unrealized PnL in USD"
},
"total_realized_pnl": {
"description": "Sum of realized PnL in USD"
},
"open_markets_count": {
"description": "Markets with an open position"
}
}
}
},
"description": "Open positions right now"
}🟢get_user_funding(address, market, from, to, bucket, ...)
Funding a Hyperliquid wallet paid or received, per market per bucket. Positive means received, negative means paid. bucket=1d gives daily totals, 1h the raw hourly payments.
输入模式
{
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "0x-prefixed 20-byte hex address"
},
"market": {
"type": "string",
"description": "Optional market filter (e.g. BTC-PERP)"
},
"from": {
"type": "number",
"description": "Unix ms window start (inclusive)"
},
"to": {
"type": "number",
"description": "Unix ms window end (exclusive)"
},
"bucket": {
"type": "string",
"enum": [
"1h",
"1d",
"raw"
],
"description": "Aggregation bucket; default 1d"
},
"limit": {
"type": "number",
"description": "Most recent rows to return (default 200)"
}
},
"required": [
"address"
]
}输出模式
{
"type": "object",
"properties": {
"total_rows": {
"description": "Rows in the window before the limit"
},
"returned": {
"description": "Rows in data, most recent first"
},
"address": {
"description": "Wallet address (0x…)"
},
"bucket": {
"description": "Bucket size"
},
"from": {
"description": "Window start, Unix milliseconds"
},
"to": {
"description": "Window end, Unix milliseconds"
},
"data": {
"type": "array",
"description": "Buckets",
"items": {
"type": "object",
"description": "One bucket and market",
"properties": {
"bucket_start": {
"description": "Bucket start, Unix milliseconds"
},
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"market_class": {
"description": "perp, spot, prediction or option"
},
"funding_payment": {
"description": "USD; positive received, negative paid"
},
"avg_position": {
"description": "Average position size"
},
"avg_funding_rate": {
"description": "Average hourly rate"
},
"interval_count": {
"description": "Hourly payments in the bucket"
}
}
}
}
},
"description": "Funding paid or received per market per bucket"
}🟢get_user_maker_taker(address, market, from, to)
Maker vs taker breakdown of a Hyperliquid wallet's fills per market: volume, fees and rebates. A high maker share with negative maker fees marks a market maker.
输入模式
{
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "0x-prefixed 20-byte hex address"
},
"market": {
"type": "string",
"description": "Optional market filter"
},
"from": {
"type": "number",
"description": "Unix ms window start"
},
"to": {
"type": "number",
"description": "Unix ms window end"
}
},
"required": [
"address"
]
}输出模式
{
"type": "object",
"properties": {
"address": {
"description": "Wallet address (0x…)"
},
"from": {
"description": "Window start, Unix milliseconds"
},
"to": {
"description": "Window end, Unix milliseconds"
},
"data": {
"type": "array",
"description": "Per market",
"items": {
"type": "object",
"description": "One market",
"properties": {
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
}
}
}
},
"total": {
"type": "object",
"description": "All markets",
"properties": {
"maker_fills": {
"description": "Fills as maker"
},
"taker_fills": {
"description": "Fills as taker"
},
"maker_notional": {
"description": "Maker notional in USD"
},
"taker_notional": {
"description": "Taker notional in USD"
},
"maker_fee": {
"description": "Maker fees in USD; negative means rebates"
},
"taker_fee": {
"description": "Taker fees in USD"
},
"total_fills": {
"description": "All fills"
},
"pct_maker": {
"description": "Share of fills as maker, 0 to 1"
}
}
}
},
"description": "Maker vs taker breakdown"
}🟢get_user_ledger(address, from, to, event_types, limit)
Vault deposits, withdrawals and transfers for a Hyperliquid wallet. Positive amounts go into the account. Account deposits and withdrawals are recorded only up to 2026-06-06.
输入模式
{
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "0x-prefixed 20-byte hex address"
},
"from": {
"type": "number",
"description": "Unix ms window start"
},
"to": {
"type": "number",
"description": "Unix ms window end"
},
"event_types": {
"type": "string",
"description": "Comma-separated type filter (deposit,withdrawal,vault_deposit,vault_withdraw,vault_transfer_in,vault_transfer_out)"
},
"limit": {
"type": "number",
"description": "Max entries, default 1000, cap 10000"
}
},
"required": [
"address"
]
}输出模式
{
"type": "object",
"properties": {
"address": {
"description": "Wallet address (0x…)"
},
"from": {
"description": "Window start, Unix milliseconds"
},
"to": {
"description": "Window end, Unix milliseconds"
},
"data": {
"type": "array",
"description": "Ledger entries",
"items": {
"type": "object",
"description": "One entry",
"properties": {
"timestamp": {
"description": "Unix milliseconds"
},
"type": {
"description": "Event type"
},
"amount": {
"description": "USD; positive into the account"
}
}
}
}
},
"description": "Vault and transfer ledger"
}🟢get_pnl_leaderboard(from, to, limit, sort_by)
Every Hyperliquid wallet ranked by realized PnL, biggest losses or volume over a window. Wallets with fewer than 5 fills in the window are left out.
输入模式
{
"type": "object",
"properties": {
"from": {
"type": "number",
"description": "Unix ms window start (default 30d ago)"
},
"to": {
"type": "number",
"description": "Unix ms window end (default now)"
},
"limit": {
"type": "number",
"description": "Number of rows, max 200, default 50"
},
"sort_by": {
"type": "string",
"description": "Ranking metric",
"enum": [
"realized_pnl",
"loss",
"volume"
]
}
},
"required": []
}输出模式
{
"type": "object",
"properties": {
"from": {
"description": "Window start, Unix milliseconds"
},
"to": {
"description": "Window end, Unix milliseconds"
},
"sort_by": {
"description": "Ranking metric"
},
"data": {
"type": "array",
"description": "Wallets",
"items": {
"type": "object",
"description": "One wallet",
"properties": {
"address": {
"description": "Wallet address (0x…)"
},
"fills": {
"description": "Fills in the window"
},
"volume_usd": {
"description": "Traded notional in USD"
},
"realized_pnl": {
"description": "Realized PnL in USD"
},
"wins": {
"description": "Profitable closing fills"
},
"losses": {
"description": "Losing closing fills"
},
"maker_fills": {
"description": "Fills as maker"
},
"taker_fills": {
"description": "Fills as taker"
},
"pct_maker": {
"description": "Share of fills as maker, 0 to 1"
},
"win_rate": {
"description": "Share of closed trades that were profitable, 0 to 1"
},
"markets_count": {
"description": "Markets traded"
},
"max_drawdown_pct": {
"description": "Largest peak-to-trough drop of the PnL curve, 0 to 1"
}
}
}
}
},
"description": "Wallets ranked over the window"
}🟢get_market_top_wallets(market, from, to, limit, sort_by)
Top wallets on one Hyperliquid market by volume or realized PnL, up to 200 rows.
输入模式
{
"type": "object",
"properties": {
"market": {
"type": "string",
"description": "Market symbol (e.g. 'BTC-PERP' or 'flx:GAS-PERP')"
},
"from": {
"type": "number",
"description": "Unix ms window start (default 24h ago)"
},
"to": {
"type": "number",
"description": "Unix ms window end (default now)"
},
"limit": {
"type": "number",
"description": "Number of rows, max 200, default 25"
},
"sort_by": {
"type": "string",
"description": "Ranking metric",
"enum": [
"volume",
"realized_pnl"
]
}
},
"required": [
"market"
]
}输出模式
{
"type": "object",
"properties": {
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"from": {
"description": "Window start, Unix milliseconds"
},
"to": {
"description": "Window end, Unix milliseconds"
},
"sort_by": {
"description": "Ranking metric"
},
"data": {
"type": "array",
"description": "Wallets",
"items": {
"type": "object",
"description": "One wallet",
"properties": {
"address": {
"description": "Wallet address (0x…)"
},
"fills": {
"description": "Fills in the window"
},
"volume_usd": {
"description": "Traded notional in USD"
},
"realized_pnl": {
"description": "Realized PnL in USD"
},
"wins": {
"description": "Profitable closing fills"
},
"losses": {
"description": "Losing closing fills"
},
"maker_fills": {
"description": "Fills as maker"
},
"taker_fills": {
"description": "Fills as taker"
},
"pct_maker": {
"description": "Share of fills as maker, 0 to 1"
},
"first_seen_ms": {
"description": "First fill in the window, Unix milliseconds"
},
"last_seen_ms": {
"description": "Last fill in the window, Unix milliseconds"
}
}
}
}
},
"description": "Top wallets on one market"
}🟢get_markets_snapshot(market_class, issuer, sort_by, order, limit, ...)
Active Hyperliquid markets ranked in one call: mark price, 24h change, 24h volume, open interest and current hourly funding. Sort by abs_funding for the most extreme funding, abs_change_24h for the biggest movers, or volume (default). Use min_volume_usd to skip illiquid markets. Returns the top 25 unless limit is set.
输入模式
{
"type": "object",
"properties": {
"market_class": {
"type": "string",
"description": "Filter to one class",
"enum": [
"perp",
"spot",
"prediction",
"option"
]
},
"issuer": {
"type": "string",
"description": "HIP-3 builder code (e.g. 'xyz'). Omit to include every issuer."
},
"sort_by": {
"type": "string",
"description": "Ranking key (default volume). funding_rate is hourly; positive means longs pay shorts.",
"enum": [
"volume",
"open_interest",
"funding",
"abs_funding",
"change_24h",
"abs_change_24h"
]
},
"order": {
"type": "string",
"description": "desc (default) or asc",
"enum": [
"desc",
"asc"
]
},
"limit": {
"type": "number",
"description": "Rows to return (1-200, default 25)"
},
"min_volume_usd": {
"type": "number",
"description": "Skip markets with less 24h volume than this (USD)"
}
},
"required": []
}输出模式
{
"type": "object",
"properties": {
"sort_by": {
"description": "Ranking key used"
},
"order": {
"description": "desc or asc"
},
"total_markets": {
"description": "Active markets before filtering"
},
"matched": {
"description": "Markets past the volume floor"
},
"returned": {
"description": "Rows in data"
},
"data": {
"type": "array",
"description": "Ranked markets",
"items": {
"type": "object",
"description": "One market",
"properties": {
"market_id": {
"description": "Stable market id"
},
"display_symbol": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"market_class": {
"description": "perp, spot, prediction or option"
},
"issuer": {
"description": "HIP-3 builder code (\"\" for native markets)"
},
"mark_price": {
"description": "Current mark price"
},
"mark_24h_ago": {
"description": "Mark price 24h ago"
},
"change_24h_pct": {
"description": "24h change as a fraction, e.g. -0.031 for -3.1%"
},
"open_interest_base": {
"description": "Open interest in base units"
},
"open_interest_usd": {
"description": "Open interest in USD"
},
"funding_rate": {
"description": "Current hourly funding rate"
},
"mark_ts_ms": {
"description": "Mark sample time, Unix milliseconds"
},
"volume_24h_usd": {
"description": "24h volume in USD"
}
}
}
}
},
"description": "Markets ranked by the requested key"
}🟢get_user_summary(address, from, to)
One Hyperliquid wallet's stats over a window: volume, realized PnL, fill count, win rate, maker share and markets traded.
输入模式
{
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "0x-prefixed 20-byte hex address"
},
"from": {
"type": "number",
"description": "Unix ms window start (default 24h ago)"
},
"to": {
"type": "number",
"description": "Unix ms window end (default now)"
}
},
"required": [
"address"
]
}输出模式
{
"type": "object",
"properties": {
"address": {
"description": "Wallet address (0x…)"
},
"from": {
"description": "Window start, Unix milliseconds"
},
"to": {
"description": "Window end, Unix milliseconds"
},
"state": {
"type": "object",
"description": "Open positions right now",
"properties": {
"address": {
"description": "Wallet address (0x…)"
},
"as_of_ts": {
"description": "Snapshot time, Unix milliseconds"
},
"asset_positions": {
"type": "array",
"description": "Open positions",
"items": {
"type": "object",
"description": "Open position",
"properties": {
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"market_class": {
"description": "perp, spot, prediction or option"
},
"size": {
"description": "Signed size: positive long, negative short"
},
"entry_price": {
"description": "Average entry price"
},
"mark_price": {
"description": "Current mark price"
},
"position_value": {
"description": "Position value in USD"
},
"unrealized_pnl": {
"description": "Unrealized PnL in USD"
},
"realized_pnl": {
"description": "Realized PnL in USD"
},
"return_on_equity": {
"description": "Unrealized PnL divided by margin"
},
"leverage": {
"description": "Leverage"
},
"leverage_type": {
"description": "cross or isolated"
}
}
}
},
"margin_summary": {
"type": "object",
"description": "Account totals",
"properties": {
"total_position_value": {
"description": "Sum of position values in USD"
},
"total_unrealized_pnl": {
"description": "Sum of unrealized PnL in USD"
},
"total_realized_pnl": {
"description": "Sum of realized PnL in USD"
},
"open_markets_count": {
"description": "Markets with an open position"
}
}
}
}
},
"window": {
"type": "object",
"description": "Window totals",
"properties": {
"fill_count": {
"description": "Fills"
},
"volume_usd": {
"description": "Traded notional in USD"
},
"realized_pnl": {
"description": "Realized PnL in USD"
},
"wins": {
"description": "Profitable closing fills"
},
"losses": {
"description": "Losing closing fills"
},
"win_rate": {
"description": "Share of closed trades that were profitable, 0 to 1"
},
"fees": {
"description": "Fees in USD"
},
"maker_notional": {
"description": "Maker notional in USD"
},
"taker_notional": {
"description": "Taker notional in USD"
},
"maker_fills": {
"description": "Fills as maker"
},
"taker_fills": {
"description": "Fills as taker"
},
"pct_maker": {
"description": "Share of fills as maker, 0 to 1"
}
}
}
},
"description": "One wallet over a window"
}🟢get_wallet_labels(addresses, whale_top_n, smart_top_n)
Labels for notable Hyperliquid wallets: top whales by 24h volume, top traders by 30-day realized PnL, vaults and vault leaders. Pass addresses to check specific wallets; without them it lists the whales and smart money.
输入模式
{
"type": "object",
"properties": {
"addresses": {
"type": "string",
"description": "Comma-separated wallet addresses to look up"
},
"whale_top_n": {
"type": "number",
"description": "Top N whales to include (max 500, default 100)"
},
"smart_top_n": {
"type": "number",
"description": "Top N smart-money wallets to include (max 500, default 100)"
}
},
"required": []
}输出模式
{
"type": "object",
"properties": {
"generated_at": {
"description": "Unix milliseconds"
},
"ttl_seconds": {
"description": "Cache lifetime"
},
"source": {
"description": "Venue, always hyperliquid"
},
"labels": {
"type": "object",
"description": "Address to its labels",
"additionalProperties": {
"type": "array",
"description": "Labels",
"items": {
"type": "object",
"description": "One label",
"properties": {
"kind": {
"description": "whale, smart_money, vault or vault_leader"
},
"name": {
"description": "Display label"
},
"rank": {
"description": "Rank"
}
}
}
}
},
"counts": {
"description": "Wallets per label kind"
},
"note": {
"description": "What the labels map includes"
}
},
"description": "Labels for notable wallets"
}🟢get_user_pnl_series(address, from, to, bucket_ms)
Realized PnL curve of a Hyperliquid wallet over time, bucketed (for example hourly or daily).
输入模式
{
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "0x-prefixed 20-byte hex address"
},
"from": {
"type": "number",
"description": "Unix ms window start"
},
"to": {
"type": "number",
"description": "Unix ms window end (default now)"
},
"bucket_ms": {
"type": "number",
"description": "Bucket size in ms (e.g. 3600000 for 1h)"
}
},
"required": [
"address"
]
}输出模式
{
"type": "object",
"properties": {
"address": {
"description": "Wallet address (0x…)"
},
"from": {
"description": "Window start, Unix milliseconds"
},
"to": {
"description": "Window end, Unix milliseconds"
},
"bucket": {
"description": "Bucket size"
},
"data": {
"type": "array",
"description": "Buckets",
"items": {
"type": "object",
"description": "One bucket",
"properties": {
"ts": {
"description": "Bucket start, Unix milliseconds"
},
"realized_pnl": {
"description": "Realized PnL in USD"
},
"fees_usd": {
"description": "Fees in USD"
}
}
}
}
},
"description": "Realized PnL per bucket"
}🟢get_top_traders(window, sort, limit)
Hyperliquid traders ranked across all markets by results over 7, 30 or 90 days: win rate, profit factor, realized PnL, max drawdown and best markets. sort=top ranks by realized PnL, lowrisk by smallest max drawdown, new by most recently first seen.
输入模式
{
"type": "object",
"properties": {
"window": {
"type": "string",
"description": "Lookback window. Default 30d",
"enum": [
"7d",
"30d",
"90d"
]
},
"sort": {
"type": "string",
"description": "Ranking. Default top",
"enum": [
"top",
"lowrisk",
"new"
]
},
"limit": {
"type": "number",
"description": "Number of traders (1-50, default 20)"
}
},
"required": []
}输出模式
{
"type": "object",
"properties": {
"window": {
"description": "Lookback window, e.g. \"30d\""
},
"sort": {
"description": "Ranking used"
},
"traders": {
"type": "array",
"description": "Traders",
"items": {
"type": "object",
"description": "One trader",
"properties": {
"address": {
"description": "Wallet address (0x…)"
},
"win_rate": {
"description": "Share of closed trades that were profitable, 0 to 1"
},
"profit_factor": {
"description": "Gross profit divided by gross loss"
},
"trades": {
"description": "Closed trades in the window"
},
"realized_pnl_usd": {
"description": "Realized PnL in USD"
},
"avg_notional_usd": {
"description": "Average trade size in USD"
},
"last_trade_ms": {
"description": "Last trade, Unix milliseconds"
},
"max_drawdown_pct": {
"description": "Largest peak-to-trough drop of the PnL curve, 0 to 1"
},
"first_trade_ms": {
"description": "First trade, Unix milliseconds"
},
"taker_share": {
"description": "Share of volume as taker, 0 to 1"
},
"liquidations": {
"description": "Liquidations in the window"
},
"top_pairs": {
"description": "Best markets with their win rates"
}
}
}
},
"aggregate": {
"type": "object",
"description": "Totals",
"properties": {
"trader_count": {
"description": "Traders ranked"
},
"total_pnl_usd": {
"description": "Sum of realized PnL in USD"
},
"active_today": {
"description": "Traders active today"
}
}
}
},
"description": "Traders ranked across all markets"
}🟢get_market_leaders(market, window, limit)
The best traders on one Hyperliquid market, ranked by profit factor then win rate, among wallets with at least 5 closed trades there.
输入模式
{
"type": "object",
"properties": {
"market": {
"type": "string",
"description": "Market symbol (e.g. \"BTC-PERP\", \"xyz:NVDA-PERP\")"
},
"window": {
"type": "string",
"description": "Lookback window. Default 30d",
"enum": [
"7d",
"30d",
"90d"
]
},
"limit": {
"type": "number",
"description": "Number of traders (1-50, default 20)"
}
},
"required": [
"market"
]
}输出模式
{
"type": "object",
"properties": {
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"window": {
"description": "Lookback window, e.g. \"30d\""
},
"traders": {
"type": "array",
"description": "Traders",
"items": {
"type": "object",
"description": "One trader",
"properties": {
"address": {
"description": "Wallet address (0x…)"
},
"win_rate": {
"description": "Share of closed trades that were profitable, 0 to 1"
},
"profit_factor": {
"description": "Gross profit divided by gross loss"
},
"trades": {
"description": "Closed trades in the window"
},
"realized_pnl_usd": {
"description": "Realized PnL in USD"
},
"avg_notional_usd": {
"description": "Average trade size in USD"
},
"last_trade_ms": {
"description": "Last trade, Unix milliseconds"
}
}
}
}
},
"description": "Best traders on one market"
}🟢get_early_movers(market, window, limit)
Wallets whose large orders (at least $10k) on a Hyperliquid market were followed by a price move in their direction within 30 minutes. Returns a lead score in basis points and a hit rate per wallet. Past activity does not predict future results.
输入模式
{
"type": "object",
"properties": {
"market": {
"type": "string",
"description": "Market symbol (e.g. \"BTC-PERP\", \"xyz:SKHX-PERP\")"
},
"window": {
"type": "string",
"description": "Lookback window. Default 30d",
"enum": [
"7d",
"30d"
]
},
"limit": {
"type": "number",
"description": "Number of wallets (1-25, default 10)"
}
},
"required": [
"market"
]
}输出模式
{
"type": "object",
"properties": {
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"window": {
"description": "Lookback window, e.g. \"30d\""
},
"formula": {
"description": "How the lead score is computed"
},
"signals": {
"type": "array",
"description": "Wallets",
"items": {
"type": "object",
"description": "One wallet",
"properties": {
"address": {
"description": "Wallet address (0x…)"
},
"events": {
"description": "Scored large orders"
},
"notional_usd": {
"description": "Notional of scored orders in USD"
},
"lead_score_bps": {
"description": "Notional-weighted 30-minute forward return, basis points"
},
"hit_rate": {
"description": "Share of orders followed by a move in their direction"
},
"last_event_ms": {
"description": "Last scored order, Unix milliseconds"
},
"cancel_ratio_30d": {
"description": "Share of large orders cancelled without a fill"
}
}
}
}
},
"description": "Wallets whose large orders preceded moves"
}🟢get_trader_profile(address, window)
A Hyperliquid wallet's trading record over 7, 30 or 90 days: win rate, profit factor, realized PnL, max drawdown and its best markets.
输入模式
{
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "0x-prefixed 20-byte hex address"
},
"window": {
"type": "string",
"description": "Lookback window. Default 30d",
"enum": [
"7d",
"30d",
"90d"
]
}
},
"required": [
"address"
]
}输出模式
{
"type": "object",
"properties": {
"address": {
"description": "Wallet address (0x…)"
},
"window": {
"description": "Lookback window, e.g. \"30d\""
},
"overall": {
"type": "object",
"description": "Headline stats",
"properties": {
"win_rate": {
"description": "Share of closed trades that were profitable, 0 to 1"
},
"profit_factor": {
"description": "Gross profit divided by gross loss"
},
"trades": {
"description": "Closed trades in the window"
},
"max_drawdown_pct": {
"description": "Largest peak-to-trough drop of the PnL curve, 0 to 1"
},
"realized_pnl_usd": {
"description": "Realized PnL in USD"
},
"first_trade_ms": {
"description": "First trade, Unix milliseconds"
}
}
},
"markets": {
"type": "array",
"description": "Best markets, ranked",
"items": {
"type": "object",
"description": "One market",
"properties": {
"market": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"win_rate": {
"description": "Share of closed trades that were profitable, 0 to 1"
},
"profit_factor": {
"description": "Gross profit divided by gross loss"
},
"trades": {
"description": "Closed trades in the window"
},
"avg_notional_usd": {
"description": "Average trade size in USD"
},
"realized_pnl_usd": {
"description": "Realized PnL in USD"
},
"rank": {
"description": "Rank among the wallet's markets"
},
"last_trade_ms": {
"description": "Last trade, Unix milliseconds"
}
}
}
},
"liquidation_count": {
"description": "Liquidations in the window"
},
"trades": {
"description": "Recent round-trip trades"
}
},
"description": "One wallet's trading record"
}🟢list_cohorts
List available address cohorts: six predefined groups (top_pnl_30d, high_volume_30d, whale_fills, net_withdrawers_7d, liquidation_prone, vault_whales) plus any custom cohorts the caller has created
输入模式
{
"type": "object",
"properties": {},
"required": []
}输出模式
{
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Cohorts",
"items": {
"type": "object",
"description": "One cohort",
"properties": {
"name": {
"description": "Cohort name"
},
"description": {
"description": "What the cohort contains"
}
}
}
}
},
"description": "Wallet cohorts"
}🟢get_cohort_addresses(name)
Get the wallet addresses in a specific cohort
输入模式
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Cohort name (e.g. top_pnl_30d, high_volume_30d, whale_fills, or a custom cohort name)"
}
},
"required": [
"name"
]
}输出模式
{
"type": "object",
"properties": {
"addresses": {
"type": "array",
"description": "Wallets",
"items": {
"type": "object",
"description": "One wallet",
"properties": {
"address": {
"description": "Wallet address (0x…)"
},
"value": {
"description": "The metric the cohort ranks by"
}
}
}
},
"fetched_at": {
"description": "Unix milliseconds"
}
},
"description": "Wallets in a cohort"
}🟢get_status
Get system status, data freshness, and venue health (unauthenticated)
输入模式
{
"type": "object",
"properties": {},
"required": []
}输出模式
{
"type": "object",
"properties": {
"status": {
"description": "operational, degraded or down"
},
"timestamp": {
"description": "Unix milliseconds"
},
"uptime": {
"description": "Time since the last incident"
},
"platform": {
"description": "Event and market counts"
},
"venues": {
"description": "Freshness per venue"
},
"components": {
"description": "data_pipeline, rest_api and streaming health"
}
},
"description": "Service status"
}🟢get_status_metrics
Get rolling-window API + pipeline + synthetic performance metrics (unauthenticated)
输入模式
{
"type": "object",
"properties": {},
"required": []
}输出模式
{
"type": "object",
"properties": {
"api": {
"description": "Latency and error rate"
},
"pipeline": {
"description": "Ingestion latency and throughput"
},
"synthetic": {
"description": "Synthetic probe latencies"
},
"timestamp": {
"description": "Unix milliseconds"
}
},
"description": "Rolling performance metrics"
}🟢get_status_history(period)
Get an uptime / freshness timeline. period: '24h' (default) or '7d' (unauthenticated)
输入模式
{
"type": "object",
"properties": {
"period": {
"type": "string",
"description": "Lookback window. '24h' (default) or '7d'.",
"enum": [
"24h",
"7d"
]
}
},
"required": []
}输出模式
{
"type": "object",
"properties": {
"points": {
"type": "array",
"description": "Hourly buckets",
"items": {
"type": "object",
"description": "One hour",
"properties": {
"ts": {
"description": "Hour start, Unix milliseconds"
},
"status": {
"description": "Worst status in the hour"
},
"fresh_sec": {
"description": "Data age in seconds"
}
}
}
},
"uptime_percent": {
"description": "Share of operational hours"
},
"period": {
"description": "24h or 7d"
}
},
"description": "Hourly status timeline"
}🟢list_markets(source, market_class, issuer, search, limit)
Active Hyperliquid markets with display symbol, class (perp, spot, prediction), HIP-3 issuer and base asset. Use search to find how a market is named (e.g. search 'nvda' finds xyz:NVDA-PERP).
输入模式
{
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "Venue. Defaults to 'hyperliquid'."
},
"market_class": {
"type": "string",
"description": "Market class. Omit to return perp + spot + prediction. 'prediction' filters to HIP-4 outcome contracts.",
"enum": [
"perp",
"spot",
"prediction",
"option"
]
},
"issuer": {
"type": "string",
"description": "HIP-3 issuer code (e.g. 'flx'). Pass empty string '' to return only native non-builder markets. Omit to include every issuer."
},
"search": {
"type": "string",
"description": "Case-insensitive match on symbol, base asset or Hyperliquid coin"
},
"limit": {
"type": "number",
"description": "Rows to return (default 100)"
}
},
"required": []
}输出模式
{
"type": "object",
"properties": {
"total_markets": {
"description": "Active markets before search"
},
"matched": {
"description": "Markets matching the search"
},
"returned": {
"description": "Rows in data"
},
"data": {
"type": "array",
"description": "Markets",
"items": {
"type": "object",
"description": "One market",
"properties": {
"market_id": {
"description": "Stable market id"
},
"source": {
"description": "Venue, always hyperliquid"
},
"market_class": {
"description": "perp, spot, prediction or option"
},
"issuer": {
"description": "HIP-3 builder code (\"\" for native markets)"
},
"base_asset": {
"description": "Base asset"
},
"quote_asset": {
"description": "Quote asset, e.g. USDC"
},
"base_market": {
"description": "Display symbol without the HIP-3 issuer prefix"
},
"display_symbol": {
"description": "Display symbol, e.g. \"BTC-PERP\" or \"xyz:NVDA-PERP\""
},
"hl_coin": {
"description": "Hyperliquid coin string"
},
"active_from_ms": {
"description": "Listing time, Unix milliseconds"
},
"max_leverage": {
"description": "Maximum leverage"
}
}
}
}
},
"description": "Active markets"
}社区
证据
最近观测
已验证未记录版本36 个工具