hl_request_free_key
Get a free API key
Issue yourself a free API key, instantly and with no signup. The key grants 100 premium calls per month — enough to evaluate every premium tool. Send it as the X-API-Key header on later requests. Call this first if a premium tool says it needs a key. One active key per requester: calling again replaces the previous key and keeps the same monthly usage, so it is safe to call if you lost your key but is not a way to reset the quota.
输入参数acknowledge
Buy 30 days of Pro (unlimited premium calls) for $29 in USDC, paid over x402 on Base. Without an X-API-Key it issues a new Pro key; with one it renews that key (a free key is upgraded in place), adding 30 days to its current end. The first call answers with the payment requirements; pay and retry with the X-PAYMENT header. The payment is taken only once the key is ready. No automatic refunds. If the answer says the payment could not be confirmed, do not pay again: quote its reference. How to pay: https://github.com/johnsmithxy1mmm-sys/HyperliquidMCP#pricing
无需输入参数。
hl_get_markets
List Hyperliquid perp markets
List Hyperliquid perpetual markets with mark/oracle price, hourly + annualized funding, open interest, and 24h volume. Use to discover valid coin symbols and scan the board. Supports name filter, sorting, and pagination.
输入参数dexsortlimitfilteroffsetincludeDelisted
hl_get_orderbook
Get L2 order book
Level-2 order book for a coin: top-N bid/ask levels with price, size, and order count, plus spread and mid. Use for microstructure, spread, and near-touch liquidity. If the coin is unknown, call hl_get_markets first.
输入参数coin必填depth
hl_get_candles
Get OHLCV candles
OHLCV candlestick history for a coin at a given interval. Provide either an explicit [startTime,endTime] (ms epoch) or a `lookback` count of the most recent candles. Returns most-recent-last, paginated.
输入参数coin必填limitoffsetendTimeintervallookbackstartTime
hl_get_funding_history
Get funding rate history
Historical hourly funding rates for a coin over a time window, with cumulative and average annualized funding. Use for carry analysis and funding trend. Defaults to the last 7 days if no window is given.
输入参数coin必填limitoffsetendTimestartTime
hl_get_account
Get account positions & margin
Perp account snapshot for any address: equity, margin usage, withdrawable, and open positions (size, entry, uPnL, leverage, liquidation price). Read-only; works for any public 0x address.
输入参数dexaddress必填
hl_get_open_orders
Get open orders
Open resting orders for an address: coin, side, price, size, order id, type, and trigger info. Read-only; paginated. Use to inspect any wallet's live order book footprint.
输入参数dexcoinlimitoffsetaddress必填
hl_signal_pubkey
Get signal verification public key
Returns the server's Ed25519 public key (SPKI DER, base64) used to sign emitted signals, so anyone can independently verify a signal's authenticity and timestamp. Canonicalization: JSON with recursively sorted keys over {payload, ts}; signature is base64 Ed25519.
无需输入参数。
hl_link_telegram
Link Telegram for alerts
Get a one-time Telegram link (valid 15 minutes). Open it and press Start: this key's standing alerts are then also pushed to that chat (up to 30 messages an hour; everything stays available via hl_poll_alerts).
无需输入参数。
hl_unlink_telegram
Unlink Telegram
Stop pushing this key's alerts to Telegram (they remain available via hl_poll_alerts).
无需输入参数。
hl_set_webhook
Set alert webhook
POST this key's fired alerts to an https URL (public addresses only), up to 30 an hour. Each body is signed: header x-hypersignal-signature = sha256=HMAC-SHA256(secret, body). The secret is returned only once.
输入参数url必填
hl_delete_webhook
Delete alert webhook
Stop POSTing this key's alerts to its webhook (they remain available via hl_poll_alerts).
无需输入参数。
hl_score_calibration
Smart-money score calibration
Out-of-sample evidence for whether the hl_smart_money_score actually predicts anything: Spearman rank correlation between each wallet's score and the realized return it went on to earn over the forward window (PnL over account value), plus mean forward return per score quartile. Verdicts: insufficient_data (not enough resolved observations yet), inverted (significantly NEGATIVE — higher-scored wallets did worse), no_evidence, weak_positive, positive (both require p<0.05). Only server-selected cohorts enter the sample, so a caller cannot steer this figure. Read this before treating the score as a forecast.
无需输入参数。
hl_whale_positions
Aggregate whale positions by coin
[PREMIUM — needs an API key: call hl_request_free_key first for a free key, or pay per call via x402] Aggregated positioning of a whale cohort for a coin (or all coins): total long/short size & notional, long/short wallet counts, weighted-average entry, net bias, and change vs 1h/24h ago. Cohort = `cohort` arg or HL_WHALE_ADDRESSES. Analytics only, not investment advice.
输入参数dexcointopNcohort
hl_whale_flow_alerts
Whale flow alerts (recent large moves)
[PREMIUM — needs an API key: call hl_request_free_key first for a free key, or pay per call via x402] Recent large changes in whale cohort positioning: which coins saw net long/short notional shift beyond a USD threshold within a lookback window — 'who opened/closed what in the last hour'. Detects full exits. Seeds a baseline on first call. Analytics only, not investment advice.
输入参数dextopNcohortthresholdUsdlookbackMinutes
hl_liquidation_map
Liquidation cluster map
[PREMIUM — needs an API key: call hl_request_free_key first for a free key, or pay per call via x402] Estimated liquidation clusters for a coin from a whale cohort's open positions: distribution of liquidation prices and notional-at-risk bucketed by % distance from mark, plus nearest downside/upside cascade levels. Estimate over the cohort only (not exchange-wide). Analytics only, not investment advice.
输入参数coin必填topNcohortbucketPctmaxDistancePct
hl_funding_screener
Funding rate screener
[PREMIUM — needs an API key: call hl_request_free_key first for a free key, or pay per call via x402] Screen every Hyperliquid perp by annualized funding: top markets by absolute funding (carry candidates), sign (longs-pay vs shorts-pay), and — when predictedFundings is available — cross-venue funding spreads for delta-neutral strategies. Filter by min |APR| and OI/volume. Analytics only, not investment advice.
输入参数sidelimitoffsetminAbsAprminOpenInterestUsdincludeVenueSpreads
hl_hip3_analytics
HIP-3 market analytics
[PREMIUM — needs an API key: call hl_request_free_key first for a free key, or pay per call via x402] Analytics for HIP-3 (builder-deployed) perp markets such as RWA/equity perps: volume, open interest, funding, and 24h change, enumerated across builder dexs. Optionally pass `spotRefs` (coin→external spot price) to compute basis vs an external reference. Analytics only, not investment advice.
输入参数dexlimitoffsetspotRefs
hl_portfolio_risk
Portfolio risk report
[PREMIUM — needs an API key: call hl_request_free_key first for a free key, or pay per call via x402] Risk report for a perp address: liquidation distance per position, effective leverage, concentration (HHI + largest position share), uniform stress scenarios (-5/-10/-20% and mirror), and Sharpe of realized PnL from recent fills. Analytics only, not investment advice.
输入参数dexshocksaddress必填
hl_vault_screener
Vault screener
[PREMIUM — needs an API key: call hl_request_free_key first for a free key, or pay per call via x402] Screen Hyperliquid user vaults by APR, max drawdown, Sharpe/Sortino, age, TVL, and leader capital share. Provide `vaults` (list of vault 0x addresses) or set HL_VAULT_ADDRESSES. Metrics derived from vault history. Analytics only, not investment advice.
输入参数sortvaultsminTvlUsd
hl_trader_report
Trader report
[PREMIUM — needs an API key: call hl_request_free_key first for a free key, or pay per call via x402] Behavioral report for any wallet from its fills: winrate, average R (avg win / avg loss), total realized PnL, PnL curve, holding-time style (scalp vs swing), fees paid, and most-traded coins. Lookback in days (Hyperliquid serves only a wallet's 10,000 most recent fills; `historyTruncated` says when that cut the window short, so very active wallets are covered only for their latest trades). Analytics only, not investment advice.
输入参数address必填curvePointslookbackDays
hl_create_alert
Create a standing alert
[PREMIUM — needs an API key: call hl_request_free_key first for a free key, or pay per call via x402] Register a persistent alert the server evaluates on a schedule; fired events are retrieved with hl_poll_alerts. Types: funding_apr (|annualized funding| crosses a threshold), price_move (|return| over a window), whale_net_flip (cohort net position flips long/short). Turns the server into a market watcher for your agent. Analytics only, not investment advice.
输入参数coin必填type必填cohortmovePctaprThresholdwindowMinutescooldownMinutes
hl_list_alerts
List your standing alerts
[PREMIUM — needs an API key: call hl_request_free_key first for a free key, or pay per call via x402] List the standing alerts registered under your API key, with their type, params, and last-fired time.
无需输入参数。
hl_delete_alert
Delete a standing alert
[PREMIUM — needs an API key: call hl_request_free_key first for a free key, or pay per call via x402] Delete one of your standing alerts by id.
输入参数id必填
hl_poll_alerts
Poll fired alerts
[PREMIUM — needs an API key: call hl_request_free_key first for a free key, or pay per call via x402] Retrieve alert events that fired since your last poll. Default is simple at-most-once delivery (events are marked delivered as soon as they are read — a lost response loses them). For reliable at-least-once delivery, pass reliable=true: events are then redelivered on every poll until you acknowledge them by passing the highest event `id` you have processed as ackThroughId. Each event includes a signed signal payload verifiable with hl_signal_pubkey. Call periodically to act on the market.
输入参数limitreliableackThroughId
hl_signal_track_record
Signal track record
[PREMIUM — needs an API key: call hl_request_free_key first for a free key, or pay per call via x402] Transparent, verifiable performance of the signals this server has emitted: per signal type, the count, how many have been scored against forward price, hit-rate, and average/median direction-adjusted return. Every signal is cryptographically signed (verify the key via hl_signal_pubkey). Analytics only, not investment advice.
输入参数type
hl_smart_money_score
Smart-money screener & labels
[PREMIUM — needs an API key: call hl_request_free_key first for a free key, or pay per call via x402] Rank a cohort of wallets by a composite screening score over their PAST results (risk-adjusted performance, winrate, reward/risk, capital size, activity) and tag each with behavioral labels (whale, sharp, scalper, market_maker_like, high_conviction, underwater, …). IMPORTANT: this is a descriptive screener, NOT a validated predictor — the component weights are chosen by judgement and have not been shown to predict future returns. Check `calibration` in the response for the current out-of-sample evidence, and hl_score_calibration for detail. Use it to shortlist wallets to inspect, not as a forecast. Cohort resolves from `cohort` arg, the auto-refreshed leaderboard cohort, or HL_WHALE_ADDRESSES. Analytics only, not investment advice.
输入参数topNlimitcohortoffsetlookbackDays
hl_coordination_scan
Wallet coordination scan
[PREMIUM — needs an API key: call hl_request_free_key first for a free key, or pay per call via x402] Find wallets in a cohort that hold near-identical directional exposure right now (high cosine similarity of their position vectors) — likely the same entity, a copy-bot, or a coordinated group. Returns clusters and the strongest pairs. Cohort = `cohort` arg or HL_WHALE_ADDRESSES. Analytics only, not investment advice.
输入参数dextopNcohortthreshold
hl_polymarket_divergence
Polymarket ↔ Hyperliquid divergence
[PREMIUM — needs an API key: call hl_request_free_key first for a free key, or pay per call via x402] Compare Polymarket price-threshold odds for a coin (e.g. 'BTC above $100k by date') against the probability implied by Hyperliquid's price + realized volatility. Surfaces cross-market mispricings ranked by edge, checks the market's own price ladder for logically impossible orderings (P(further threshold) > P(nearer)), collapses duplicate contract listings, and reports each estimate's sensitivity to the volatility input. Rows where a diffusion model is out of its depth (extreme tails the market prices but a no-jump model cannot) are flagged, not asserted. Optionally use perp funding as drift. Estimate under lognormal dynamics. Analytics only, not investment advice.
输入参数coin必填limitminEdgevolIntervalvolWindowDaysuseFundingDrift