MCPサーバー

mcp

io.github.ironflowsh/mcp

このMCPでできること

Provides read-only Hyperliquid market, trading, funding, liquidation, wallet, trader, vault, and performance analytics.

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', 'required': [], 'properties': {}}
出力スキーマ
{'type': 'object', 'properties': {'tips': {'type': 'array', 'items': {'description': 'One tip'}, 'description': 'Query tips'}, 'tiers': {'type': 'array', 'items': {'description': 'One tier'}, 'description': "Every tier's limits"}, 'limits': {'description': "Your tier's limits: history_days, max_execution_seconds, max_rows, budget_seconds_per_hour"}, 'tables': {'type': 'array', 'items': {'type': 'object', 'properties': {'name': {'description': 'Table name, e.g. hl.fills'}, 'columns': {'type': 'array', 'items': {'type': 'object', 'properties': {'name': {'description': 'Name'}, 'type': {'description': 'ClickHouse type'}, 'description': {'description': 'Meaning'}}, 'description': 'One column'}, 'description': 'Columns'}, 'data_from': {'description': 'How far back the table goes'}, 'description': {'description': 'What one row is'}, 'time_column': {'description': 'Column the history window filters on'}}, 'description': 'One table'}, 'description': 'Queryable tables'}, 'dialect': {'description': 'SQL dialect and database name'}, 'examples': {'type': 'array', 'items': {'type': 'object', 'properties': {'sql': {'description': 'SQL that answers it'}, 'question': {'description': 'Question'}}, 'description': 'One example'}, 'description': 'Worked examples'}}, 'description': 'Catalog of the SQL tables run_query can read'}
get_candles
OHLCV candles for a Hyperliquid market, computed from tick-level trades.
読み取り専用 外部アクセスあり
入力スキーマ
{'type': 'object', 'required': ['market'], 'properties': {'limit': {'type': 'number', 'description': 'Number of candles to return (1-500, default 24)'}, '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': {'enum': ['1m', '5m', '15m', '1h', '4h', '1d'], 'type': 'string', 'description': 'Candle interval (1m, 5m, 15m, 1h, 4h, 1d). Default: 1h'}}}
出力スキーマ
{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'low': {'description': 'Low price'}, 'high': {'description': 'High price'}, 'open': {'description': 'Open price'}, 'close': {'description': 'Close price'}, 'venue': {'description': 'Venue, always hyperliquid'}, 'issuer': {'description': 'HIP-3 builder code ("" for native markets)'}, 'market': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}, 'source': {'description': 'Venue, always hyperliquid'}, 'volume': {'description': 'Volume in base units'}, 'interval': {'description': 'Candle interval'}, 'timestamp': {'description': 'Unix milliseconds'}, 'base_market': {'description': 'Display symbol without the HIP-3 issuer prefix'}, 'quote_asset': {'description': 'Quote asset, e.g. USDC'}, 'trade_count': {'description': 'Trades in the candle'}, 'display_symbol': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}}, 'description': 'One row'}, 'description': 'OHLCV candles'}, 'pagination': {'type': 'object', 'properties': {'has_more': {'description': 'Whether more rows exist'}, 'next_cursor': {'description': 'Pass as cursor to fetch the next page; null on the last page'}}, 'description': 'Cursor pagination'}}, 'description': 'OHLCV candles'}
get_cohort_addresses
Get the wallet addresses in a specific cohort
読み取り専用 外部アクセスあり
入力スキーマ
{'type': 'object', 'required': ['name'], 'properties': {'name': {'type': 'string', 'description': 'Cohort name (e.g. top_pnl_30d, high_volume_30d, whale_fills, or a custom cohort name)'}}}
出力スキーマ
{'type': 'object', 'properties': {'addresses': {'type': 'array', 'items': {'type': 'object', 'properties': {'value': {'description': 'The metric the cohort ranks by'}, 'address': {'description': 'Wallet address (0x…)'}}, 'description': 'One wallet'}, 'description': 'Wallets'}, 'fetched_at': {'description': 'Unix milliseconds'}}, 'description': 'Wallets in a cohort'}
get_early_movers
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', 'required': ['market'], 'properties': {'limit': {'type': 'number', 'description': 'Number of wallets (1-25, default 10)'}, 'market': {'type': 'string', 'description': 'Market symbol (e.g. "BTC-PERP", "xyz:SKHX-PERP")'}, 'window': {'enum': ['7d', '30d'], 'type': 'string', 'description': 'Lookback window. Default 30d'}}}
出力スキーマ
{'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', 'items': {'type': 'object', 'properties': {'events': {'description': 'Scored large orders'}, 'address': {'description': 'Wallet address (0x…)'}, 'hit_rate': {'description': 'Share of orders followed by a move in their direction'}, 'notional_usd': {'description': 'Notional of scored orders in USD'}, 'last_event_ms': {'description': 'Last scored order, Unix milliseconds'}, 'lead_score_bps': {'description': 'Notional-weighted 30-minute forward return, basis points'}, 'cancel_ratio_30d': {'description': 'Share of large orders cancelled without a fill'}}, 'description': 'One wallet'}, 'description': 'Wallets'}}, 'description': 'Wallets whose large orders preceded moves'}
get_fills
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', 'required': ['address'], 'properties': {'limit': {'type': 'number', 'description': 'Number of fills (1-100, default 20)'}, '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")'}, 'address': {'type': 'string', 'description': 'Wallet address (e.g. 0x...)'}}}
出力スキーマ
{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'fee': {'description': 'Fee paid in USD'}, 'side': {'description': 'Fill side, "buy" or "sell"'}, 'size': {'description': 'Size in base units'}, 'price': {'description': 'Price in USD'}, 'venue': {'description': 'Venue, always hyperliquid'}, 'issuer': {'description': 'HIP-3 builder code ("" for native markets)'}, 'market': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}, 'source': {'description': 'Venue, always hyperliquid'}, 'address': {'description': 'Wallet address (0x…)'}, 'direction': {'description': 'e.g. "Open Long", "Close Short"'}, 'timestamp': {'description': 'Unix milliseconds'}, 'base_market': {'description': 'Display symbol without the HIP-3 issuer prefix'}, 'market_type': {'description': 'perp, spot or prediction'}, 'quote_asset': {'description': 'Quote asset, e.g. USDC'}, 'block_number': {'description': 'Hyperliquid block height'}, 'realized_pnl': {'description': 'Realized PnL in USD'}, 'display_symbol': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}}, 'description': 'One row'}, 'description': 'Fills for one wallet, newest first'}, 'pagination': {'type': 'object', 'properties': {'has_more': {'description': 'Whether more rows exist'}, 'next_cursor': {'description': 'Pass as cursor to fetch the next page; null on the last page'}}, 'description': 'Cursor pagination'}}, 'description': 'Fills for one wallet, newest first'}
get_funding_rates
Hourly funding rate history for a Hyperliquid perp, including HIP-3 builder perps. A positive rate means longs pay shorts.
読み取り専用 外部アクセスあり
入力スキーマ
{'type': 'object', 'required': ['market'], 'properties': {'limit': {'type': 'number', 'description': 'Number of funding rate entries (1-100, default 10)'}, '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")'}}}
出力スキーマ
{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'rate': {'description': 'Hourly funding rate; positive means longs pay shorts'}, 'venue': {'description': 'Venue, always hyperliquid'}, 'issuer': {'description': 'HIP-3 builder code ("" for native markets)'}, 'market': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}, 'source': {'description': 'Venue, always hyperliquid'}, 'sequence': {'description': 'Order of the event within its block'}, 'timestamp': {'description': 'Unix milliseconds'}, 'base_market': {'description': 'Display symbol without the HIP-3 issuer prefix'}, 'quote_asset': {'description': 'Quote asset, e.g. USDC'}, 'display_symbol': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}}, 'description': 'One row'}, 'description': 'Hourly funding rates'}, 'pagination': {'type': 'object', 'properties': {'has_more': {'description': 'Whether more rows exist'}, 'next_cursor': {'description': 'Pass as cursor to fetch the next page; null on the last page'}}, 'description': 'Cursor pagination'}}, 'description': 'Hourly funding rates'}
get_funding_stats
Funding statistics per time bucket for a Hyperliquid perp: average, minimum, maximum and annualized rate.
読み取り専用 外部アクセスあり
入力スキーマ
{'type': 'object', 'required': ['market'], 'properties': {'limit': {'type': 'number', 'description': 'Number of data points (default 7)'}, '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': {'enum': ['1h', '4h', '8h', '1d', '7d'], 'type': 'string', 'description': 'Time interval (1h, 4h, 8h, 1d, 7d). Default: 1d'}}}
出力スキーマ
{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'bucket': {'description': 'Bucket start, Unix milliseconds'}, 'market': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}, 'source': {'description': 'Venue, always hyperliquid'}, 'avg_rate': {'description': 'Average hourly rate'}, 'max_rate': {'description': 'Highest hourly rate'}, 'min_rate': {'description': 'Lowest hourly rate'}, 'cumulative_rate': {'description': 'Sum of hourly rates in the bucket'}}, 'description': 'One bucket'}, 'description': 'Buckets'}}, 'description': 'Funding statistics per time bucket'}
get_liquidation_levels
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', 'required': ['market'], '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'}}}
出力スキーマ
{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'market': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}}, 'description': 'One bucket'}, 'description': 'Price buckets'}}, 'description': 'Liquidated notional by price bucket'}
get_liquidations
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', 'required': ['market'], 'properties': {'limit': {'type': 'number', 'description': 'Number of liquidation events (1-100, default 20)'}, '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")'}}}
出力スキーマ
{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'side': {'description': 'The liquidated wallet\'s fill side: "sell" closed a long, "buy" closed a short'}, 'size': {'description': 'Size in base units'}, 'price': {'description': 'Price in USD'}, 'venue': {'description': 'Venue, always hyperliquid'}, 'issuer': {'description': 'HIP-3 builder code ("" for native markets)'}, 'market': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}, 'source': {'description': 'Venue, always hyperliquid'}, 'address': {'description': 'Liquidated wallet'}, 'timestamp': {'description': 'Unix milliseconds'}, 'base_market': {'description': 'Display symbol without the HIP-3 issuer prefix'}, 'market_type': {'description': 'perp, spot or prediction'}, 'quote_asset': {'description': 'Quote asset, e.g. USDC'}, 'block_number': {'description': 'Hyperliquid block height'}, 'realized_pnl': {'description': 'Realized PnL in USD'}, 'display_symbol': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}}, 'description': 'One row'}, 'description': 'Liquidations'}, 'pagination': {'type': 'object', 'properties': {'has_more': {'description': 'Whether more rows exist'}, 'next_cursor': {'description': 'Pass as cursor to fetch the next page; null on the last page'}}, 'description': 'Cursor pagination'}}, 'description': 'Liquidations'}
get_liquidation_summary
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', 'required': [], 'properties': {'market': {'type': 'string', 'description': 'Optional market filter (e.g. "BTC-PERP")'}, 'minutes': {'type': 'number', 'description': 'Lookback in minutes (default 60, max 240)'}}}
出力スキーマ
{'type': 'object', 'properties': {'to': {'description': 'Window end, Unix milliseconds'}, 'from': {'description': 'Window start, Unix milliseconds'}, 'count': {'description': 'Number of liquidations'}, 'market': {'description': 'Market filter, or null for all markets'}, 'largest': {'type': 'object', 'properties': {'side': {'description': '"long" or "short"'}, 'price': {'description': 'Price in USD'}, 'market': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}, 'address': {'description': 'Wallet address (0x…)'}, 'timestamp': {'description': 'Unix milliseconds'}, 'notional_usd': {'description': 'Notional in USD'}}, 'description': 'Largest single liquidation, or null when there were none'}, 'complete': {'description': 'False when the page cap was hit and totals are a lower bound'}, 'by_market': {'type': 'array', 'items': {'type': 'object', 'properties': {'count': {'description': 'Liquidations'}, 'market': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}, 'notional_usd': {'description': 'Notional in USD'}}, 'description': 'One market'}, 'description': 'Top markets by liquidated notional'}, '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'}}, 'description': 'Liquidation totals over the window'}
get_market_leaders
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', 'required': ['market'], 'properties': {'limit': {'type': 'number', 'description': 'Number of traders (1-50, default 20)'}, 'market': {'type': 'string', 'description': 'Market symbol (e.g. "BTC-PERP", "xyz:NVDA-PERP")'}, 'window': {'enum': ['7d', '30d', '90d'], 'type': 'string', 'description': 'Lookback window. Default 30d'}}}
出力スキーマ
{'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', 'items': {'type': 'object', 'properties': {'trades': {'description': 'Closed trades in the window'}, 'address': {'description': 'Wallet address (0x…)'}, 'win_rate': {'description': 'Share of closed trades that were profitable, 0 to 1'}, 'last_trade_ms': {'description': 'Last trade, Unix milliseconds'}, 'profit_factor': {'description': 'Gross profit divided by gross loss'}, 'avg_notional_usd': {'description': 'Average trade size in USD'}, 'realized_pnl_usd': {'description': 'Realized PnL in USD'}}, 'description': 'One trader'}, 'description': 'Traders'}}, 'description': 'Best traders on one market'}
get_markets_snapshot
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', 'required': [], 'properties': {'limit': {'type': 'number', 'description': 'Rows to return (1-200, default 25)'}, 'order': {'enum': ['desc', 'asc'], 'type': 'string', 'description': 'desc (default) or asc'}, 'issuer': {'type': 'string', 'description': "HIP-3 builder code (e.g. 'xyz'). Omit to include every issuer."}, 'sort_by': {'enum': ['volume', 'open_interest', 'funding', 'abs_funding', 'change_24h', 'abs_change_24h'], 'type': 'string', 'description': 'Ranking key (default volume). funding_rate is hourly; positive means longs pay shorts.'}, 'market_class': {'enum': ['perp', 'spot', 'prediction', 'option'], 'type': 'string', 'description': 'Filter to one class'}, 'min_volume_usd': {'type': 'number', 'description': 'Skip markets with less 24h volume than this (USD)'}}}
出力スキーマ
{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'issuer': {'description': 'HIP-3 builder code ("" for native markets)'}, 'market_id': {'description': 'Stable market id'}, 'mark_price': {'description': 'Current mark price'}, 'mark_ts_ms': {'description': 'Mark sample time, Unix milliseconds'}, 'funding_rate': {'description': 'Current hourly funding rate'}, 'mark_24h_ago': {'description': 'Mark price 24h ago'}, 'market_class': {'description': 'perp, spot, prediction or option'}, 'change_24h_pct': {'description': '24h change as a fraction, e.g. -0.031 for -3.1%'}, 'display_symbol': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}, 'volume_24h_usd': {'description': '24h volume in USD'}, 'open_interest_usd': {'description': 'Open interest in USD'}, 'open_interest_base': {'description': 'Open interest in base units'}}, 'description': 'One market'}, 'description': 'Ranked markets'}, 'order': {'description': 'desc or asc'}, 'matched': {'description': 'Markets past the volume floor'}, 'sort_by': {'description': 'Ranking key used'}, 'returned': {'description': 'Rows in data'}, 'total_markets': {'description': 'Active markets before filtering'}}, 'description': 'Markets ranked by the requested key'}
get_market_top_wallets
Top wallets on one Hyperliquid market by volume or realized PnL, up to 200 rows.
読み取り専用 外部アクセスあり
入力スキーマ
{'type': 'object', 'required': ['market'], 'properties': {'to': {'type': 'number', 'description': 'Unix ms window end (default now)'}, 'from': {'type': 'number', 'description': 'Unix ms window start (default 24h ago)'}, 'limit': {'type': 'number', 'description': 'Number of rows, max 200, default 25'}, 'market': {'type': 'string', 'description': "Market symbol (e.g. 'BTC-PERP' or 'flx:GAS-PERP')"}, 'sort_by': {'enum': ['volume', 'realized_pnl'], 'type': 'string', 'description': 'Ranking metric'}}}
出力スキーマ
{'type': 'object', 'properties': {'to': {'description': 'Window end, Unix milliseconds'}, 'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'wins': {'description': 'Profitable closing fills'}, 'fills': {'description': 'Fills in the window'}, 'losses': {'description': 'Losing closing fills'}, 'address': {'description': 'Wallet address (0x…)'}, 'pct_maker': {'description': 'Share of fills as maker, 0 to 1'}, 'volume_usd': {'description': 'Traded notional in USD'}, 'maker_fills': {'description': 'Fills as maker'}, 'taker_fills': {'description': 'Fills as taker'}, 'last_seen_ms': {'description': 'Last fill in the window, Unix milliseconds'}, 'realized_pnl': {'description': 'Realized PnL in USD'}, 'first_seen_ms': {'description': 'First fill in the window, Unix milliseconds'}}, 'description': 'One wallet'}, 'description': 'Wallets'}, 'from': {'description': 'Window start, Unix milliseconds'}, 'market': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}, 'sort_by': {'description': 'Ranking metric'}}, 'description': 'Top wallets on one market'}
get_mark_prices
Mark price and oracle price series for a Hyperliquid perp.
読み取り専用 外部アクセスあり
入力スキーマ
{'type': 'object', 'required': ['market'], '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")'}}}
出力スキーマ
{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'venue': {'description': 'Venue, always hyperliquid'}, 'issuer': {'description': 'HIP-3 builder code ("" for native markets)'}, 'market': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}, 'source': {'description': 'Venue, always hyperliquid'}, 'timestamp': {'description': 'Unix milliseconds'}, 'mark_price': {'description': 'Mark price'}, 'base_market': {'description': 'Display symbol without the HIP-3 issuer prefix'}, 'quote_asset': {'description': 'Quote asset, e.g. USDC'}, 'funding_rate': {'description': 'Current hourly funding rate'}, 'oracle_price': {'description': 'Oracle price'}, 'display_symbol': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}}, 'description': 'One row'}, 'description': 'Mark price samples'}, 'pagination': {'type': 'object', 'properties': {'has_more': {'description': 'Whether more rows exist'}, 'next_cursor': {'description': 'Pass as cursor to fetch the next page; null on the last page'}}, 'description': 'Cursor pagination'}}, 'description': 'Mark price samples'}
get_open_interest
Latest open interest for a Hyperliquid perp.
読み取り専用 外部アクセスあり
入力スキーマ
{'type': 'object', 'required': ['market'], '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")'}}}
出力スキーマ
{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'venue': {'description': 'Venue, always hyperliquid'}, 'issuer': {'description': 'HIP-3 builder code ("" for native markets)'}, 'market': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}, 'source': {'description': 'Venue, always hyperliquid'}, 'timestamp': {'description': 'Unix milliseconds'}, 'volume_24h': {'description': '24h volume in USD'}, 'base_market': {'description': 'Display symbol without the HIP-3 issuer prefix'}, 'quote_asset': {'description': 'Quote asset, e.g. USDC'}, 'open_interest': {'description': 'Open interest in base units'}, 'display_symbol': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}}, 'description': 'One row'}, 'description': 'Open interest samples'}, 'pagination': {'type': 'object', 'properties': {'has_more': {'description': 'Whether more rows exist'}, 'next_cursor': {'description': 'Pass as cursor to fetch the next page; null on the last page'}}, 'description': 'Cursor pagination'}}, 'description': 'Open interest samples'}
get_pnl_leaderboard
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', 'required': [], 'properties': {'to': {'type': 'number', 'description': 'Unix ms window end (default now)'}, 'from': {'type': 'number', 'description': 'Unix ms window start (default 30d ago)'}, 'limit': {'type': 'number', 'description': 'Number of rows, max 200, default 50'}, 'sort_by': {'enum': ['realized_pnl', 'loss', 'volume'], 'type': 'string', 'description': 'Ranking metric'}}}
出力スキーマ
{'type': 'object', 'properties': {'to': {'description': 'Window end, Unix milliseconds'}, 'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'wins': {'description': 'Profitable closing fills'}, 'fills': {'description': 'Fills in the window'}, 'losses': {'description': 'Losing closing fills'}, 'address': {'description': 'Wallet address (0x…)'}, 'win_rate': {'description': 'Share of closed trades that were profitable, 0 to 1'}, 'pct_maker': {'description': 'Share of fills as maker, 0 to 1'}, 'volume_usd': {'description': 'Traded notional in USD'}, 'maker_fills': {'description': 'Fills as maker'}, 'taker_fills': {'description': 'Fills as taker'}, 'realized_pnl': {'description': 'Realized PnL in USD'}, 'markets_count': {'description': 'Markets traded'}, 'max_drawdown_pct': {'description': 'Largest peak-to-trough drop of the PnL curve, 0 to 1'}}, 'description': 'One wallet'}, 'description': 'Wallets'}, 'from': {'description': 'Window start, Unix milliseconds'}, 'sort_by': {'description': 'Ranking metric'}}, 'description': 'Wallets ranked over the window'}
get_price
Latest mark price of a Hyperliquid market: native perps, HIP-3 builder perps (e.g. xyz:NVDA-PERP) and spot.
読み取り専用 外部アクセスあり
入力スキーマ
{'type': 'object', 'required': ['market'], '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")'}}}
出力スキーマ
{'type': 'object', 'properties': {'price': {'description': 'Price in USD'}, 'market': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}}, 'description': 'Latest mark price'}
get_recent_trades
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', 'required': ['market'], 'properties': {'limit': {'type': 'number', 'description': 'Number of trades to return (1-100, default 20)'}, '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")'}}}
出力スキーマ
{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'fee': {'description': 'Fee paid in USD'}, 'side': {'description': 'Fill side, "buy" or "sell"'}, 'size': {'description': 'Size in base units'}, 'price': {'description': 'Price in USD'}, 'venue': {'description': 'Venue, always hyperliquid'}, 'issuer': {'description': 'HIP-3 builder code ("" for native markets)'}, 'market': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}, 'source': {'description': 'Venue, always hyperliquid'}, 'address': {'description': 'Wallet address (0x…)'}, 'sequence': {'description': 'Order of the event within its block'}, 'timestamp': {'description': 'Unix milliseconds'}, 'base_market': {'description': 'Display symbol without the HIP-3 issuer prefix'}, 'market_type': {'description': 'perp, spot or prediction'}, 'quote_asset': {'description': 'Quote asset, e.g. USDC'}, 'block_number': {'description': 'Hyperliquid block height'}, 'realized_pnl': {'description': 'Realized PnL in USD'}, 'display_symbol': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}}, 'description': 'One row'}, 'description': 'Trades, newest first'}, 'pagination': {'type': 'object', 'properties': {'has_more': {'description': 'Whether more rows exist'}, 'next_cursor': {'description': 'Pass as cursor to fetch the next page; null on the last page'}}, 'description': 'Cursor pagination'}}, 'description': 'Trades, newest first'}
get_status
Get system status, data freshness, and venue health (unauthenticated)
読み取り専用 外部アクセスあり
入力スキーマ
{'type': 'object', 'required': [], 'properties': {}}
出力スキーマ
{'type': 'object', 'properties': {'status': {'description': 'operational, degraded or down'}, 'uptime': {'description': 'Time since the last incident'}, 'venues': {'description': 'Freshness per venue'}, 'platform': {'description': 'Event and market counts'}, 'timestamp': {'description': 'Unix milliseconds'}, 'components': {'description': 'data_pipeline, rest_api and streaming health'}}, 'description': 'Service status'}
get_status_history
Get an uptime / freshness timeline. period: '24h' (default) or '7d' (unauthenticated)
読み取り専用 外部アクセスあり
入力スキーマ
{'type': 'object', 'required': [], 'properties': {'period': {'enum': ['24h', '7d'], 'type': 'string', 'description': "Lookback window. '24h' (default) or '7d'."}}}
出力スキーマ
{'type': 'object', 'properties': {'period': {'description': '24h or 7d'}, 'points': {'type': 'array', 'items': {'type': 'object', 'properties': {'ts': {'description': 'Hour start, Unix milliseconds'}, 'status': {'description': 'Worst status in the hour'}, 'fresh_sec': {'description': 'Data age in seconds'}}, 'description': 'One hour'}, 'description': 'Hourly buckets'}, 'uptime_percent': {'description': 'Share of operational hours'}}, 'description': 'Hourly status timeline'}
get_status_metrics
Get rolling-window API + pipeline + synthetic performance metrics (unauthenticated)
読み取り専用 外部アクセスあり
入力スキーマ
{'type': 'object', 'required': [], 'properties': {}}
出力スキーマ
{'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_top_traders
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', 'required': [], 'properties': {'sort': {'enum': ['top', 'lowrisk', 'new'], 'type': 'string', 'description': 'Ranking. Default top'}, 'limit': {'type': 'number', 'description': 'Number of traders (1-50, default 20)'}, 'window': {'enum': ['7d', '30d', '90d'], 'type': 'string', 'description': 'Lookback window. Default 30d'}}}
出力スキーマ
{'type': 'object', 'properties': {'sort': {'description': 'Ranking used'}, 'window': {'description': 'Lookback window, e.g. "30d"'}, 'traders': {'type': 'array', 'items': {'type': 'object', 'properties': {'trades': {'description': 'Closed trades in the window'}, 'address': {'description': 'Wallet address (0x…)'}, 'win_rate': {'description': 'Share of closed trades that were profitable, 0 to 1'}, 'top_pairs': {'description': 'Best markets with their win rates'}, 'taker_share': {'description': 'Share of volume as taker, 0 to 1'}, 'liquidations': {'description': 'Liquidations in the window'}, 'last_trade_ms': {'description': 'Last trade, Unix milliseconds'}, 'profit_factor': {'description': 'Gross profit divided by gross loss'}, 'first_trade_ms': {'description': 'First trade, Unix milliseconds'}, 'avg_notional_usd': {'description': 'Average trade size in USD'}, 'max_drawdown_pct': {'description': 'Largest peak-to-trough drop of the PnL curve, 0 to 1'}, 'realized_pnl_usd': {'description': 'Realized PnL in USD'}}, 'description': 'One trader'}, 'description': 'Traders'}, 'aggregate': {'type': 'object', 'properties': {'active_today': {'description': 'Traders active today'}, 'trader_count': {'description': 'Traders ranked'}, 'total_pnl_usd': {'description': 'Sum of realized PnL in USD'}}, 'description': 'Totals'}}, 'description': 'Traders ranked across all markets'}
get_trader_profile
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', 'required': ['address'], 'properties': {'window': {'enum': ['7d', '30d', '90d'], 'type': 'string', 'description': 'Lookback window. Default 30d'}, 'address': {'type': 'string', 'description': '0x-prefixed 20-byte hex address'}}}
出力スキーマ
{'type': 'object', 'properties': {'trades': {'description': 'Recent round-trip trades'}, 'window': {'description': 'Lookback window, e.g. "30d"'}, 'address': {'description': 'Wallet address (0x…)'}, 'markets': {'type': 'array', 'items': {'type': 'object', 'properties': {'rank': {'description': "Rank among the wallet's markets"}, 'market': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}, 'trades': {'description': 'Closed trades in the window'}, 'win_rate': {'description': 'Share of closed trades that were profitable, 0 to 1'}, 'last_trade_ms': {'description': 'Last trade, Unix milliseconds'}, 'profit_factor': {'description': 'Gross profit divided by gross loss'}, 'avg_notional_usd': {'description': 'Average trade size in USD'}, 'realized_pnl_usd': {'description': 'Realized PnL in USD'}}, 'description': 'One market'}, 'description': 'Best markets, ranked'}, 'overall': {'type': 'object', 'properties': {'trades': {'description': 'Closed trades in the window'}, 'win_rate': {'description': 'Share of closed trades that were profitable, 0 to 1'}, 'profit_factor': {'description': 'Gross profit divided by gross loss'}, 'first_trade_ms': {'description': 'First trade, Unix milliseconds'}, 'max_drawdown_pct': {'description': 'Largest peak-to-trough drop of the PnL curve, 0 to 1'}, 'realized_pnl_usd': {'description': 'Realized PnL in USD'}}, 'description': 'Headline stats'}, 'liquidation_count': {'description': 'Liquidations in the window'}}, 'description': "One wallet's trading record"}
get_user_funding
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', 'required': ['address'], 'properties': {'to': {'type': 'number', 'description': 'Unix ms window end (exclusive)'}, 'from': {'type': 'number', 'description': 'Unix ms window start (inclusive)'}, 'limit': {'type': 'number', 'description': 'Most recent rows to return (default 200)'}, 'bucket': {'enum': ['1h', '1d', 'raw'], 'type': 'string', 'description': 'Aggregation bucket; default 1d'}, 'market': {'type': 'string', 'description': 'Optional market filter (e.g. BTC-PERP)'}, 'address': {'type': 'string', 'description': '0x-prefixed 20-byte hex address'}}}
出力スキーマ
{'type': 'object', 'properties': {'to': {'description': 'Window end, Unix milliseconds'}, 'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'market': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}, 'avg_position': {'description': 'Average position size'}, 'bucket_start': {'description': 'Bucket start, Unix milliseconds'}, 'market_class': {'description': 'perp, spot, prediction or option'}, 'interval_count': {'description': 'Hourly payments in the bucket'}, 'funding_payment': {'description': 'USD; positive received, negative paid'}, 'avg_funding_rate': {'description': 'Average hourly rate'}}, 'description': 'One bucket and market'}, 'description': 'Buckets'}, 'from': {'description': 'Window start, Unix milliseconds'}, 'bucket': {'description': 'Bucket size'}, 'address': {'description': 'Wallet address (0x…)'}, 'returned': {'description': 'Rows in data, most recent first'}, 'total_rows': {'description': 'Rows in the window before the limit'}}, 'description': 'Funding paid or received per market per bucket'}
get_user_ledger
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', 'required': ['address'], 'properties': {'to': {'type': 'number', 'description': 'Unix ms window end'}, 'from': {'type': 'number', 'description': 'Unix ms window start'}, 'limit': {'type': 'number', 'description': 'Max entries, default 1000, cap 10000'}, 'address': {'type': 'string', 'description': '0x-prefixed 20-byte hex address'}, 'event_types': {'type': 'string', 'description': 'Comma-separated type filter (deposit,withdrawal,vault_deposit,vault_withdraw,vault_transfer_in,vault_transfer_out)'}}}
出力スキーマ
{'type': 'object', 'properties': {'to': {'description': 'Window end, Unix milliseconds'}, 'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'type': {'description': 'Event type'}, 'amount': {'description': 'USD; positive into the account'}, 'timestamp': {'description': 'Unix milliseconds'}}, 'description': 'One entry'}, 'description': 'Ledger entries'}, 'from': {'description': 'Window start, Unix milliseconds'}, 'address': {'description': 'Wallet address (0x…)'}}, 'description': 'Vault and transfer ledger'}
get_user_maker_taker
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', 'required': ['address'], 'properties': {'to': {'type': 'number', 'description': 'Unix ms window end'}, 'from': {'type': 'number', 'description': 'Unix ms window start'}, 'market': {'type': 'string', 'description': 'Optional market filter'}, 'address': {'type': 'string', 'description': '0x-prefixed 20-byte hex address'}}}
出力スキーマ
{'type': 'object', 'properties': {'to': {'description': 'Window end, Unix milliseconds'}, 'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'market': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}}, 'description': 'One market'}, 'description': 'Per market'}, 'from': {'description': 'Window start, Unix milliseconds'}, 'total': {'type': 'object', 'properties': {'maker_fee': {'description': 'Maker fees in USD; negative means rebates'}, 'pct_maker': {'description': 'Share of fills as maker, 0 to 1'}, 'taker_fee': {'description': 'Taker fees in USD'}, 'maker_fills': {'description': 'Fills as maker'}, 'taker_fills': {'description': 'Fills as taker'}, 'total_fills': {'description': 'All fills'}, 'maker_notional': {'description': 'Maker notional in USD'}, 'taker_notional': {'description': 'Taker notional in USD'}}, 'description': 'All markets'}, 'address': {'description': 'Wallet address (0x…)'}}, 'description': 'Maker vs taker breakdown'}
get_user_pnl_series
Realized PnL curve of a Hyperliquid wallet over time, bucketed (for example hourly or daily).
読み取り専用 外部アクセスあり
入力スキーマ
{'type': 'object', 'required': ['address'], 'properties': {'to': {'type': 'number', 'description': 'Unix ms window end (default now)'}, 'from': {'type': 'number', 'description': 'Unix ms window start'}, 'address': {'type': 'string', 'description': '0x-prefixed 20-byte hex address'}, 'bucket_ms': {'type': 'number', 'description': 'Bucket size in ms (e.g. 3600000 for 1h)'}}}
出力スキーマ
{'type': 'object', 'properties': {'to': {'description': 'Window end, Unix milliseconds'}, 'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'ts': {'description': 'Bucket start, Unix milliseconds'}, 'fees_usd': {'description': 'Fees in USD'}, 'realized_pnl': {'description': 'Realized PnL in USD'}}, 'description': 'One bucket'}, 'description': 'Buckets'}, 'from': {'description': 'Window start, Unix milliseconds'}, 'bucket': {'description': 'Bucket size'}, 'address': {'description': 'Wallet address (0x…)'}}, 'description': 'Realized PnL per bucket'}
get_user_state
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', 'required': ['address'], 'properties': {'address': {'type': 'string', 'description': '0x-prefixed 20-byte hex address'}}}
出力スキーマ
{'type': 'object', 'properties': {'address': {'description': 'Wallet address (0x…)'}, 'as_of_ts': {'description': 'Snapshot time, Unix milliseconds'}, 'margin_summary': {'type': 'object', 'properties': {'open_markets_count': {'description': 'Markets with an open position'}, 'total_realized_pnl': {'description': 'Sum of realized PnL in USD'}, 'total_position_value': {'description': 'Sum of position values in USD'}, 'total_unrealized_pnl': {'description': 'Sum of unrealized PnL in USD'}}, 'description': 'Account totals'}, 'asset_positions': {'type': 'array', 'items': {'type': 'object', 'properties': {'size': {'description': 'Signed size: positive long, negative short'}, 'market': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}, 'leverage': {'description': 'Leverage'}, 'mark_price': {'description': 'Current mark price'}, 'entry_price': {'description': 'Average entry price'}, 'market_class': {'description': 'perp, spot, prediction or option'}, 'realized_pnl': {'description': 'Realized PnL in USD'}, 'leverage_type': {'description': 'cross or isolated'}, 'position_value': {'description': 'Position value in USD'}, 'unrealized_pnl': {'description': 'Unrealized PnL in USD'}, 'return_on_equity': {'description': 'Unrealized PnL divided by margin'}}, 'description': 'Open position'}, 'description': 'Open positions'}}, 'description': 'Open positions right now'}
get_user_summary
One Hyperliquid wallet's stats over a window: volume, realized PnL, fill count, win rate, maker share and markets traded.
読み取り専用 外部アクセスあり
入力スキーマ
{'type': 'object', 'required': ['address'], 'properties': {'to': {'type': 'number', 'description': 'Unix ms window end (default now)'}, 'from': {'type': 'number', 'description': 'Unix ms window start (default 24h ago)'}, 'address': {'type': 'string', 'description': '0x-prefixed 20-byte hex address'}}}
出力スキーマ
{'type': 'object', 'properties': {'to': {'description': 'Window end, Unix milliseconds'}, 'from': {'description': 'Window start, Unix milliseconds'}, 'state': {'type': 'object', 'properties': {'address': {'description': 'Wallet address (0x…)'}, 'as_of_ts': {'description': 'Snapshot time, Unix milliseconds'}, 'margin_summary': {'type': 'object', 'properties': {'open_markets_count': {'description': 'Markets with an open position'}, 'total_realized_pnl': {'description': 'Sum of realized PnL in USD'}, 'total_position_value': {'description': 'Sum of position values in USD'}, 'total_unrealized_pnl': {'description': 'Sum of unrealized PnL in USD'}}, 'description': 'Account totals'}, 'asset_positions': {'type': 'array', 'items': {'type': 'object', 'properties': {'size': {'description': 'Signed size: positive long, negative short'}, 'market': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}, 'leverage': {'description': 'Leverage'}, 'mark_price': {'description': 'Current mark price'}, 'entry_price': {'description': 'Average entry price'}, 'market_class': {'description': 'perp, spot, prediction or option'}, 'realized_pnl': {'description': 'Realized PnL in USD'}, 'leverage_type': {'description': 'cross or isolated'}, 'position_value': {'description': 'Position value in USD'}, 'unrealized_pnl': {'description': 'Unrealized PnL in USD'}, 'return_on_equity': {'description': 'Unrealized PnL divided by margin'}}, 'description': 'Open position'}, 'description': 'Open positions'}}, 'description': 'Open positions right now'}, 'window': {'type': 'object', 'properties': {'fees': {'description': 'Fees 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'}, 'pct_maker': {'description': 'Share of fills as maker, 0 to 1'}, 'fill_count': {'description': 'Fills'}, 'volume_usd': {'description': 'Traded notional in USD'}, 'maker_fills': {'description': 'Fills as maker'}, 'taker_fills': {'description': 'Fills as taker'}, 'realized_pnl': {'description': 'Realized PnL in USD'}, 'maker_notional': {'description': 'Maker notional in USD'}, 'taker_notional': {'description': 'Taker notional in USD'}}, 'description': 'Window totals'}, 'address': {'description': 'Wallet address (0x…)'}}, 'description': 'One wallet over a window'}
get_vault_leaderboard
Hyperliquid vaults ranked by net deposits. Needs a Builder or Enterprise key; keyless and free-key calls return 403.
読み取り専用 外部アクセスあり
入力スキーマ
{'type': 'object', 'required': [], 'properties': {'limit': {'type': 'number', 'description': 'Number of vaults (default 10)'}}}
出力スキーマ
{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'vault': {'description': 'Vault address'}}, 'description': 'One vault'}, 'description': 'Vaults'}}, 'description': 'Vaults ranked by net deposits'}
get_vault_operations
Deposits into and withdrawals from Hyperliquid vaults. Pass a vault address, a depositor address, or both; one is required.
読み取り専用 外部アクセスあり
入力スキーマ
{'type': 'object', 'required': [], 'properties': {'limit': {'type': 'number', 'description': 'Number of events (1-100, default 20)'}, 'vault': {'type': 'string', 'description': 'Vault address'}, 'address': {'type': 'string', 'description': 'User address'}}}
出力スキーマ
{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'token': {'description': 'Token, usually USDC'}, 'vault': {'description': 'Vault address'}, 'source': {'description': 'Venue, always hyperliquid'}, 'address': {'description': 'Depositor'}, 'operation': {'description': 'deposit or withdraw'}, 'timestamp': {'description': 'Unix milliseconds'}, 'commission': {'description': 'Leader commission'}, 'net_amount': {'description': 'Amount after commission and closing cost'}, 'block_number': {'description': 'Hyperliquid block height'}, 'closing_cost': {'description': 'Cost of closing positions for the withdrawal'}, 'requested_amount': {'description': 'Requested amount'}}, 'description': 'One row'}, 'description': 'Vault deposits and withdrawals'}, 'pagination': {'type': 'object', 'properties': {'has_more': {'description': 'Whether more rows exist'}, 'next_cursor': {'description': 'Pass as cursor to fetch the next page; null on the last page'}}, 'description': 'Cursor pagination'}}, 'description': 'Vault deposits and withdrawals'}
get_wallet_behavior
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', 'required': [], 'properties': {'label': {'enum': ['market_maker', 'high_frequency', 'whale', 'directional', 'consistent_winner', 'big_loser', 'revenge_sizing', 'often_liquidated', 'hip3_trader', 'spot_trader', 'prediction_trader'], 'type': 'string', 'description': 'Only wallets carrying this label'}, 'limit': {'type': 'number', 'description': 'Wallets to return (default 20, max 100)'}, 'sort_by': {'enum': ['volume', 'pnl', 'fills', 'liquidations'], 'type': 'string', 'description': 'Sort order when listing (default volume)'}, 'addresses': {'type': 'string', 'description': 'Comma-separated wallet addresses (up to 50). Omit to list wallets instead.'}, 'min_volume_usd': {'type': 'number', 'description': 'Only wallets with at least this 30-day volume'}}}
出力スキーマ
{'type': 'object', 'properties': {'wallets': {'type': 'array', 'items': {'type': 'object', 'properties': {'labels': {'type': 'array', 'items': {'description': 'Label'}, 'description': 'Behaviour labels'}, 'address': {'description': 'Wallet address'}, 'volume_usd': {'description': '30-day volume in USD'}, 'maker_share': {'description': 'Maker volume / volume'}, 'liquidations': {'description': 'Liquidation events'}, 'fills_per_day': {'description': 'Fills per active day'}, 'realized_pnl_usd': {'description': '30-day realized PnL in USD'}}, 'description': 'One wallet'}, 'description': 'Wallets'}, 'window_days': {'description': 'Days the features cover'}}, 'description': 'Wallet trading behaviour over the last 30 days'}
get_wallet_labels
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', 'required': [], 'properties': {'addresses': {'type': 'string', 'description': 'Comma-separated wallet addresses to look up'}, 'smart_top_n': {'type': 'number', 'description': 'Top N smart-money wallets to include (max 500, default 100)'}, 'whale_top_n': {'type': 'number', 'description': 'Top N whales to include (max 500, default 100)'}}}
出力スキーマ
{'type': 'object', 'properties': {'note': {'description': 'What the labels map includes'}, 'counts': {'description': 'Wallets per label kind'}, 'labels': {'type': 'object', 'description': 'Address to its labels', 'additionalProperties': {'type': 'array', 'items': {'type': 'object', 'properties': {'kind': {'description': 'whale, smart_money, vault or vault_leader'}, 'name': {'description': 'Display label'}, 'rank': {'description': 'Rank'}}, 'description': 'One label'}, 'description': 'Labels'}}, 'source': {'description': 'Venue, always hyperliquid'}, 'ttl_seconds': {'description': 'Cache lifetime'}, 'generated_at': {'description': 'Unix milliseconds'}}, 'description': 'Labels for notable wallets'}
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', 'required': [], 'properties': {}}
出力スキーマ
{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'name': {'description': 'Cohort name'}, 'description': {'description': 'What the cohort contains'}}, 'description': 'One cohort'}, 'description': 'Cohorts'}}, 'description': 'Wallet cohorts'}
list_markets
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', 'required': [], 'properties': {'limit': {'type': 'number', 'description': 'Rows to return (default 100)'}, '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'}, 'source': {'type': 'string', 'description': "Venue. Defaults to 'hyperliquid'."}, 'market_class': {'enum': ['perp', 'spot', 'prediction', 'option'], 'type': 'string', 'description': "Market class. Omit to return perp + spot + prediction. 'prediction' filters to HIP-4 outcome contracts."}}}
出力スキーマ
{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'properties': {'issuer': {'description': 'HIP-3 builder code ("" for native markets)'}, 'source': {'description': 'Venue, always hyperliquid'}, 'hl_coin': {'description': 'Hyperliquid coin string'}, 'market_id': {'description': 'Stable market id'}, 'base_asset': {'description': 'Base asset'}, 'base_market': {'description': 'Display symbol without the HIP-3 issuer prefix'}, 'quote_asset': {'description': 'Quote asset, e.g. USDC'}, 'market_class': {'description': 'perp, spot, prediction or option'}, 'max_leverage': {'description': 'Maximum leverage'}, 'active_from_ms': {'description': 'Listing time, Unix milliseconds'}, 'display_symbol': {'description': 'Display symbol, e.g. "BTC-PERP" or "xyz:NVDA-PERP"'}}, 'description': 'One market'}, 'description': 'Markets'}, 'matched': {'description': 'Markets matching the search'}, 'returned': {'description': 'Rows in data'}, 'total_markets': {'description': 'Active markets before search'}}, 'description': 'Active markets'}
run_query
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', 'required': ['sql'], '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)'}}}
出力スキーマ
{'type': 'object', 'properties': {'rows': {'type': 'array', 'items': {'description': 'One row'}, 'description': 'Rows as positional arrays'}, 'stats': {'description': 'elapsed_ms, rows_read, bytes_read'}, 'limits': {'description': "Your tier's limits"}, 'columns': {'type': 'array', 'items': {'description': 'Name'}, 'description': 'Column names in row order'}, 'row_count': {'description': 'Rows returned'}, 'truncated': {'description': 'true when more rows existed than were returned'}, 'column_types': {'type': 'array', 'items': {'description': 'Type'}, 'description': 'ClickHouse types in row order'}, 'budget_remaining_seconds': {'description': 'Query seconds left this hour'}}, 'description': 'Query result'}
追加
get_wallet_behavior
2026年9月27日2:40
追加
run_query
2026年9月27日2:40
追加
describe_data
2026年9月27日2:40
追加
list_markets
2026年9月25日2:40
追加
get_status_history
2026年9月25日2:40
追加
get_status_metrics
2026年9月25日2:40
追加
get_status
2026年9月25日2:40
追加
get_cohort_addresses
2026年9月25日2:40
追加
list_cohorts
2026年9月25日2:40
追加
get_trader_profile
2026年9月25日2:40
追加
get_early_movers
2026年9月25日2:40
追加
get_market_leaders
2026年9月25日2:40
追加
get_top_traders
2026年9月25日2:40
追加
get_user_pnl_series
2026年9月25日2:40
追加
get_wallet_labels
2026年9月25日2:40
追加
get_user_summary
2026年9月25日2:40
追加
get_markets_snapshot
2026年9月25日2:40
追加
get_market_top_wallets
2026年9月25日2:40
追加
get_pnl_leaderboard
2026年9月25日2:40
追加
get_user_ledger
2026年9月25日2:40
追加
get_user_maker_taker
2026年9月25日2:40
追加
get_user_funding
2026年9月25日2:40
追加
get_user_state
2026年9月25日2:40
追加
get_funding_stats
2026年9月25日2:40
追加
get_vault_leaderboard
2026年9月25日2:40
追加
get_liquidation_levels
2026年9月25日2:40
追加
get_vault_operations
2026年9月25日2:40
追加
get_mark_prices
2026年9月25日2:40
追加
get_fills
2026年9月25日2:40
追加
get_liquidation_summary
2026年9月25日2:40