Vike Data API is an MCP server published by io.vike, hosted at data.vike.io. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 84 tools, including token_search, wallet_summary, wallet_discover, token_transfers, hl_ohlcv.
Crypto data for AI agents: on-chain wallets, Hyperliquid, HL Cohorts, Polymarket and Predict.fun.
Nothing else in the archive shares these values.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
Search for tokens by name or symbol. Returns matching symbols, names, addresses (0x-prefixed, lower case; pass them straight to token_holders and token_transfers), and logos.
| Parameter | Type | Description |
|---|---|---|
| chain | string | Chain. Default: ethereum |
| limit | integer | Max results (default 10) |
| query * | string | Search term (symbol or name) |
{
"name": "token_search",
"title": "Token Search",
"description": "Search for tokens by name or symbol. Returns matching symbols, names, addresses (0x-prefixed, lower case; pass them straight to token_holders and token_transfers), and logos.",
"inputSchema": {
"type": "object",
"required": [
"query"
],
"properties": {
"chain": {
"enum": [
"ethereum",
"bsc",
"base",
"hyperevm"
],
"type": "string",
"default": "ethereum",
"description": "Chain. Default: ethereum"
},
"limit": {
"type": "integer",
"default": 10,
"description": "Max results (default 10)"
},
"query": {
"type": "string",
"description": "Search term (symbol or name)"
}
}
},
"annotations": {
"title": "Token Search",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Get a wallet's aggregate metrics: volume, inflow, outflow, net flow, tx count, tokens traded across time windows (24h/7d/30d/90d/all). Without `chain` it answers for the more recently active of ethereum and bsc, and for base or hyperevm only when the wallet has no priced ethereum/bsc volume; the result's `chain` says which.
| Parameter | Type | Description |
|---|---|---|
| chain | string | Answer for this chain only (default: see the tool description) |
| address * | string | Wallet address (0x-prefixed hex) |
{
"name": "wallet_summary",
"title": "Wallet Summary",
"description": "Get a wallet's aggregate metrics: volume, inflow, outflow, net flow, tx count, tokens traded across time windows (24h/7d/30d/90d/all). Without `chain` it answers for the more recently active of ethereum and bsc, and for base or hyperevm only when the wallet has no priced ethereum/bsc volume; the result's `chain` says which.",
"inputSchema": {
"type": "object",
"required": [
"address"
],
"properties": {
"chain": {
"enum": [
"ethereum",
"bsc",
"base",
"hyperevm"
],
"type": "string",
"description": "Answer for this chain only (default: see the tool description)"
},
"address": {
"type": "string",
"description": "Wallet address (0x-prefixed hex)"
}
}
},
"annotations": {
"title": "Wallet Summary",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Find top wallets ranked by volume, inflow, outflow, net flow, tx count, or realized PnL. On base and hyperevm window=all always works; 24h/7d/30d/90d only while those windows were refreshed in the last 2 days, otherwise a 400.
| Parameter | Type | Description |
|---|---|---|
| size | integer | Results per page (default 10, max 20) |
| sort | string | Sort metric (default volume) |
| chain | string | Chain (default ethereum) |
| order | string | Sort direction (default desc) |
| window | string | Time window (default 30d; base and hyperevm default to all, and serve the others only while those windows are under 2 days old) |
| include_hubs | ["boolean","string"] | Also rank round-trip hubs (flash-loan/MEV/router pass-through wallets: volume of $10B or more, net flow and realized PnL each within 0.1% of it), hidden by default |
{
"name": "wallet_discover",
"title": "Wallet Discover",
"description": "Find top wallets ranked by volume, inflow, outflow, net flow, tx count, or realized PnL. On base and hyperevm window=all always works; 24h/7d/30d/90d only while those windows were refreshed in the last 2 days, otherwise a 400.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"size": {
"type": "integer",
"default": 10,
"description": "Results per page (default 10, max 20)"
},
"sort": {
"enum": [
"volume",
"inflow",
"outflow",
"net_flow",
"tx_count",
"pnl"
],
"type": "string",
"default": "volume",
"description": "Sort metric (default volume)"
},
"chain": {
"enum": [
"ethereum",
"bsc",
"base",
"hyperevm"
],
"type": "string",
"default": "ethereum",
"description": "Chain (default ethereum)"
},
"order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc",
"description": "Sort direction (default desc)"
},
"window": {
"enum": [
"24h",
"7d",
"30d",
"90d",
"all"
],
"type": "string",
"description": "Time window (default 30d; base and hyperevm default to all, and serve the others only while those windows are under 2 days old)"
},
"include_hubs": {
"type": [
"boolean",
"string"
],
"default": false,
"description": "Also rank round-trip hubs (flash-loan/MEV/router pass-through wallets: volume of $10B or more, net flow and realized PnL each within 0.1% of it), hidden by default"
}
}
},
"annotations": {
"title": "Wallet Discover",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Get who bought and sold a specific token in a given period, ranked by net USD. tab=bought lists the top NET buyers (bought more than sold), tab=sold the top NET sellers, largest first, with quantities and USD values. Wallets that only pass the token through (routers, pools: bought ~= sold) are not listed; a row can still be a contract (a pool, vault or settlement contract), and `title` names the known ones; `hide_contracts` leaves out the contracts we know of. bought / sold / net_tokens are whole tokens, usd_spent / usd_received USD. net_usd = usd_received - usd_spent, so a net buyer's is NEGATIVE: its net USD bought is -net_usd.
| Parameter | Type | Description |
|---|---|---|
| tab | string | Net buyers or net sellers (default sold) |
| chain | string | Chain (default ethereum) |
| period | string | Lookback period (default 24h) |
| max_amount | ["number","string"] | Count only transfers of at most this many tokens (whole tokens, not raw units, up to 1e18). Applied to each transfer BEFORE a wallet's totals are summed, so bought, sold and the USD columns add up only those transfers and a wallet ranks on them alone. Omit for no ceiling |
| min_amount | ["number","string"] | Count only transfers of at least this many tokens (whole tokens, not raw units, up to 1e18). Applied to each transfer BEFORE a wallet's totals are summed, so bought, sold and the USD columns add up only those transfers and a wallet ranks on them alone. Omit for no floor |
| token_address * | string | Token contract address (0x-prefixed) |
Historical OHLCV candles for a Hyperliquid market, aggregated from HL's own executed fills, by `view`. `candles` (default): one symbol's bars. Pass `symbol` as the HL asset (BTC, ETH, HYPE); `market` picks perps or HL spot and `dex` picks a builder-deployed HIP-3 perp DEX (default HL, the core venue). Buckets are left-aligned UTC and the window is half-open [start, end). Returns candles as {ts (epoch ms, UTC), open, high, low, close, volume, volume_usd, n_trades} ascending by ts, plus `source` naming the rollup that answered. `export`: the same, with `limit` defaulting to the maximum, 5000 (the REST export streams it as NDJSON). `latest`: the newest 1-minute bar of EVERY symbol that traded in the last hour in one call (takes only `market`, `dex` and `interval`; `dex` omitted = every DEX, each row naming its own; a bar may still be forming). Same data as GET /v1/hyperliquid/ohlcv, /ohlcv/export and /ohlcv/latest.
| Parameter | Type | Description |
|---|---|---|
| dex | string | Perp DEX. Default HL, the core venue; the others are builder-deployed HIP-3 DEXs. On `latest`, omitted = every DEX. |
| end | string | ISO-8601 UTC or epoch ms (exclusive). Default: now. |
| view | string | `candles` (default): one symbol's bars; `export`: the same with `limit` defaulting to 5000; `latest`: the newest 1-minute bar of every symbol. |
| limit | ["integer","string"] | Max candles (default 500 on `candles`, 5000 on `export`; hard max 5000). |
| start | string | ISO-8601 UTC or epoch ms (inclusive). Default: end - limit*interval. |
| market | string | Perpetual or HL spot. Default perp. |
Historical OHLCV candles for ONE Polymarket outcome token, from the recorded L2 tape. `token_id` is the ERC-1155 outcome token id — a market's condition_id will NOT work here; read the token ids off `clob_token_ids` from polymarket_market_detail. Prices are probabilities in [0, 1]. Returns bars OLDEST first as {ts (epoch ms, UTC), open, high, low, close, volume, trades}. There is no cursor, so a window wider than `limit` is truncated at the OLD end — raise `from` to reach the recent end. With `to` and no `from`, `limit` keeps the bars nearest `to` (`to`=X, `limit`=1 is the last bar at or before X).
| Parameter | Type | Description |
|---|---|---|
| to | ["integer","string"] | Epoch MILLISECONDS, INCLUSIVE upper bound. Omit for no upper bound. |
| from | ["integer","string"] | Epoch MILLISECONDS, inclusive lower bound. Omit for no lower bound. |
| limit | ["integer","string"] | Max candles (default 500, hard max 1000). |
| interval * | string | Candle width. Required. |
| token_id * | string | ERC-1155 outcome token id. Required. |
{
"name": "polymarket_ohlcv",
"title": "Polymarket OHLCV",
"description": "Historical OHLCV candles for ONE Polymarket outcome token, from the recorded L2 tape. `token_id` is the ERC-1155 outcome token id — a market's condition_id will NOT work here; read the token ids off `clob_token_ids` from polymarket_market_detail. Prices are probabilities in [0, 1]. Returns bars OLDEST first as {ts (epoch ms, UTC), open, high, low, close, volume, trades}. There is no cursor, so a window wider than `limit` is truncated at the OLD end — raise `from` to reach the recent end. With `to` and no `from`, `limit` keeps the bars nearest `to` (`to`=X, `limit`=1 is the last bar at or before X).",
"inputSchema": {
"type": "object",
"required": [
"token_id",
"interval"
],
"properties": {
"to": {
"type": [
"integer",
"string"
],
"description": "Epoch MILLISECONDS, INCLUSIVE upper bound. Omit for no upper bound."
},
"from": {
"type": [
"integer",
"string"
],
"description": "Epoch MILLISECONDS, inclusive lower bound. Omit for no lower bound."
},
"limit": {
"type": [
"integer",
"string"
],
"default": 500,
"description": "Max candles (default 500, hard max 1000)."
},
"interval": {
"enum": [
"1m",
"5m",
"1h",
"1d"
],
"type": "string",
"description": "Candle width. Required."
},
"token_id": {
"type": "string",
"description": "ERC-1155 outcome token id. Required."
}
}
},
"annotations": {
"title": "Polymarket OHLCV",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Perpetual-futures funding rates. Pass `symbol` (e.g. 'BTC') to get current per-venue rates for one asset. Omit `symbol` to get top cross-venue funding-arbitrage opportunities (pre-ranked, normalised to daily %, spreads >= 0.3%). Each arb row includes long_exchange+long_daily_pct, short_exchange+short_daily_pct, spread_daily_pct. A halted or no-longer-polled venue (Coinbase International, halted 2026-10-01) is left out, and so is a venue silent for over an hour in the per-symbol list.
| Parameter | Type | Description |
|---|---|---|
| symbol | string | Specific symbol (e.g. 'BTC'). Omit for all symbols. |
{
"name": "perp_funding",
"title": "Perp Funding",
"description": "Perpetual-futures funding rates. Pass `symbol` (e.g. 'BTC') to get current per-venue rates for one asset. Omit `symbol` to get top cross-venue funding-arbitrage opportunities (pre-ranked, normalised to daily %, spreads >= 0.3%). Each arb row includes long_exchange+long_daily_pct, short_exchange+short_daily_pct, spread_daily_pct. A halted or no-longer-polled venue (Coinbase International, halted 2026-10-01) is left out, and so is a venue silent for over an hour in the per-symbol list.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"symbol": {
"type": "string",
"description": "Specific symbol (e.g. 'BTC'). Omit for all symbols."
}
}
},
"annotations": {
"title": "Perp Funding",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Get top cross-venue spread-arbitrage opportunities for perpetual futures. Returns symbols where the price gap between the cheapest and most-expensive exchange is >= 0.5%. Each row includes buy_exchange+buy_price, sell_exchange+sell_price, and spread_pct. Pre-ranked — just cite the rows directly. Outliers (>400 bps from cross-venue median, typically unit-mismatch listings like 1000SHIB) are already filtered out.
| Parameter | Type | Description |
|---|---|---|
| symbol | string | Symbol to compare. Omit for full matrix. |
{
"name": "perp_spreads",
"title": "Perp Spreads",
"description": "Get top cross-venue spread-arbitrage opportunities for perpetual futures. Returns symbols where the price gap between the cheapest and most-expensive exchange is >= 0.5%. Each row includes buy_exchange+buy_price, sell_exchange+sell_price, and spread_pct. Pre-ranked — just cite the rows directly. Outliers (>400 bps from cross-venue median, typically unit-mismatch listings like 1000SHIB) are already filtered out.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"symbol": {
"type": "string",
"description": "Symbol to compare. Omit for full matrix."
}
}
},
"annotations": {
"title": "Perp Spreads",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List the current user's alert rules. Returns active alerts by default; pass include_inactive=true to include paused/deleted ones. Also use this to look up an alert_id before editing or deleting. Each row has `alert_type`, `policy` (per_event, cooldown or hysteresis: how often it notifies) and, for a Hyperliquid alert, an `hl` object holding its parameters (a `pm` object for a Polymarket alert).
| Parameter | Type | Description |
|---|---|---|
| include_inactive | ["boolean","string"] | Include paused/deleted alerts. Default false. |
{
"name": "alerts_list",
"title": "Alerts List",
"description": "List the current user's alert rules. Returns active alerts by default; pass include_inactive=true to include paused/deleted ones. Also use this to look up an alert_id before editing or deleting. Each row has `alert_type`, `policy` (per_event, cooldown or hysteresis: how often it notifies) and, for a Hyperliquid alert, an `hl` object holding its parameters (a `pm` object for a Polymarket alert).",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"include_inactive": {
"type": [
"boolean",
"string"
],
"default": false,
"description": "Include paused/deleted alerts. Default false."
}
}
},
"annotations": {
"title": "Alerts List",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Create an alert rule for the current user: an on-chain transfer alert (the default), a Hyperliquid or a Polymarket alert, chosen by `alert_type`. TRANSFER ('transfer'): fires when a transfer on ONE chain (eth, bsc, base or hyperevm) matches: token_symbol if given, min_value_usd if given, and, if `address` is given, that wallet on the side `address_role` says. `address` = ONE 20-byte EVM address ('0x' + 40 hex); ENS names, entity names and non-EVM addresses are refused. Without min_value_usd EVERY transfer touching the address matches (dust and unpriced tokens too); with min_value_usd or max_value_usd only transfers that already carry a USD value do. min_amount (needs token_symbol) is a floor in whole tokens, priced or not; set with a USD bound, both must hold. An alert with an `address` notifies on EVERY matching transfer: no cooldown, no daily cap. A token-wide alert (no address) sends one notification per cooldown_minutes for the newest match, at most 10 a day. HYPERLIQUID (perpetuals only; leave out chain, address, address_role and max_value_usd): hl_wallet = every fill of `wallet` (required), narrowed by `actions`, `token_symbol` (the coin) and min_value_usd; hl_cohort_fill = every fill by wallets in `pnl_cohorts` / `size_cohorts` (at least one cohort is REQUIRED, or it would match every large fill on Hyperliquid), REQUIRES min_value_usd >= 10000; hl_liquidation = every liquidation, optionally of one `wallet`, of cohorts, of one coin, above a min_value_usd floor; hl_cohort_bias = the cohort `index` of `token_symbol` (required) crossing `threshold` by `band`, filtered by `direction`; hl_liq_proximity = `wallet` (required) getting `threshold` of the way from entry to liquidation price; hl_wallet_orders = the orders of `wallet` (required) worth at least min_value_usd (size x price, default 10000, >= 1000) that are placed or gone (`events`), narrowed by `side` and `token_symbol`, from the 5-minute order-book snapshots, as one event per evaluator pass (about every 5 minutes) whose `orders` lists every one of them with its `action` (placed or gone; a gone one with its outcome filled, partially_filled or canceled) and the pass totals beside it (a pass of more than 200 orders comes as `parts` events of 200, each with its `part` and the same totals); the e-mail and webhook carry the list, the feed keeps it 1 hour (then the totals only, with `orders_removed`); private to the alert's owner. Fill and liquidation alerts notify on every event; a wallet alert once per coin, action and side of each evaluator pass (about every 10 s): the fills merged into one event, `fills` their count, min_value_usd applied to the merged total. Bias and proximity alerts notify once per crossing and re-arm after the value retreats by `band`. POLYMARKET (leave out chain, address, address_role, max_value_usd and token_symbol): pm_wallet_trade = every trade of the proxy `wallet` (required), optionally in one `condition_id` and above min_value_usd; pm_market_trade = every trade in `condition_id` (required) at or above min_value_usd (REQUIRED, >= 1000); pm_price_move = a move of 0.05 or more within 5 minutes in the price of the market's first outcome (Yes), filtered by `direction`; pm_resolution = the market resolved. Each notifies on every event. cooldown_minutes does not apply to Hyperliquid or Polymarket alerts. They are delivered by a webhook channel (register one with alerts_register_webhook) and/or e-mail, or only read with alerts_events (channels left empty); `channels` = ['email'] mails the account address: one mail per evaluator pass listing its events, and (but for hl_wallet) none after the alert's 10th event of the UTC day. `label` is the user-visible name. `channels` = ['email'], ['webhook'] or both (Discord is temporarily off and is refused). One address and one chain per transfer alert: create several alerts to watch more. Returns the new alert row including its id, its `policy` and, for a Hyperliquid or Polymarket alert, an `hl` or `pm` object.
Partial update of one of the user's alerts. Only the fields you pass are modified; pass alert_id to identify which one (get it from alerts_list). Use is_active=false to pause an alert without deleting it. `address` replaces the alert's wallet condition (one per alert; same rules as alerts_create); address='' removes it; `address_role` alone moves the existing address to that side. The fields mean what they mean in alerts_create, and a Hyperliquid alert (its type cannot change) is re-validated whole after the edit: '' or [] clears an optional field such as token_symbol or pnl_cohorts, and a field its type does not use is an error. `channels` replaces the list (email or webhook; Discord is off); [] leaves a Hyperliquid or Polymarket alert feed-only, read with alerts_events.
| Parameter | Type | Description |
|---|---|---|
| band | ["number","string"] | hl_cohort_bias and hl_liq_proximity: hysteresis, greater than 0 (default 0.1). A bias alert fires when the index reaches threshold + band (up) or threshold - band (down); a proximity alert fires when the ratio reaches threshold and re-arms below threshold - band. |
| side | string | hl_wallet_orders only: only buy or only sell orders. Leave out for both. |
| chain | string | |
| index | string | hl_cohort_bias only, required: the index watched for token_symbol. smi = long share of smart wallets minus long share of rekt wallets; wsi = long share of whales minus long share of shrimp; smart_bias / whale_bias = (long - short) / (long + short) of that cohort; smi_wsi_gap = smi - wsi. Ratios run … |
| label | string | |
| events | array | hl_wallet_orders only: placed = a new order appeared in the book, gone = an order left it (its outcome filled, partially_filled or canceled comes from the order's own fills). Default both. Each check's orders arrive together, as one event. |
Delete one of the user's alerts by id. Soft-delete (pauses it, keeps history) by default; pass hard=true to remove permanently. Returns {ok: true} on success.
| Parameter | Type | Description |
|---|---|---|
| hard | ["boolean","string"] | Hard-delete vs pause. Default false. |
| alert_id * | ["integer","string"] | The alert ID to delete. |
{
"name": "alerts_delete",
"title": "Alerts Delete",
"description": "Delete one of the user's alerts by id. Soft-delete (pauses it, keeps history) by default; pass hard=true to remove permanently. Returns {ok: true} on success.",
"inputSchema": {
"type": "object",
"required": [
"alert_id"
],
"properties": {
"hard": {
"type": [
"boolean",
"string"
],
"default": false,
"description": "Hard-delete vs pause. Default false."
},
"alert_id": {
"type": [
"integer",
"string"
],
"description": "The alert ID to delete."
}
}
},
"annotations": {
"title": "Alerts Delete",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}List the user's enabled email + webhook notification channels. Use before creating an alert to confirm which channels are available (a Hyperliquid or Polymarket alert mails the account address, needs a webhook, or is read with alerts_events). Returns a list of {id, channel_type, is_verified, label} rows.
No parameters.
{
"name": "alerts_list_channels",
"title": "Alerts List Channels",
"description": "List the user's enabled email + webhook notification channels. Use before creating an alert to confirm which channels are available (a Hyperliquid or Polymarket alert mails the account address, needs a webhook, or is read with alerts_events). Returns a list of {id, channel_type, is_verified, label} rows.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {}
},
"annotations": {
"title": "Alerts List Channels",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read the events the current user's alert rules produced, oldest first (the feed behind GET /v1/alerts/events). Page forward by passing the returned `next_cursor` back as `cursor`; an empty page returns the same cursor, so a poller keeps it and asks again. A page also ends once its events pass about 2 MB (a wallet-orders event can list 200 orders), so it can hold fewer than `limit` events with `has_more` true: keep paging, nothing is skipped. A wallet-orders event keeps its `orders` list 1 hour after the alert (until its deliveries are done, if later); after that it has its totals, `orders_removed: true` and a `note`. Each event has id, rule_id, alert_label, alert_type, created_at, `event` (what happened: the transfer, fill, liquidation, bias flip, proximity crossing, a pass of wallet orders, Polymarket trade, price move or resolution) and `delivery`: one item per channel it went to with id, channel, channel_key, status, attempts, last_attempt_at, next_attempt_at (while it waits) and last_error as a code only (http 500, timeout, network). A delivery's id is what alerts_resend_delivery takes. Events are kept for 15 days. Read-only; only the user's own rules appear.
| Parameter | Type | Description |
|---|---|---|
| limit | ["integer","string"] | Events per page, 1 to 500. Default 100. |
| cursor | string | The previous page's `next_cursor`. Omit for the oldest retained event. |
| rule_id | ["integer","string"] | Only the events of this alert (its id from alerts_list). |
{
"name": "alerts_events",
"title": "Alerts Events",
"description": "Read the events the current user's alert rules produced, oldest first (the feed behind GET /v1/alerts/events). Page forward by passing the returned `next_cursor` back as `cursor`; an empty page returns the same cursor, so a poller keeps it and asks again. A page also ends once its events pass about 2 MB (a wallet-orders event can list 200 orders), so it can hold fewer than `limit` events with `has_more` true: keep paging, nothing is skipped. A wallet-orders event keeps its `orders` list 1 hour after the alert (until its deliveries are done, if later); after that it has its totals, `orders_removed: true` and a `note`. Each event has id, rule_id, alert_label, alert_type, created_at, `event` (what happened: the transfer, fill, liquidation, bias flip, proximity crossing, a pass of wallet orders, Polymarket trade, price move or resolution) and `delivery`: one item per channel it went to with id, channel, channel_key, status, attempts, last_attempt_at, next_attempt_at (while it waits) and last_error as a code only (http 500, timeout, network). A delivery's id is what alerts_resend_delivery takes. Events are kept for 15 days. Read-only; only the user's own rules appear.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"limit": {
"type": [
"integer",
"string"
],
"default": 100,
"description": "Events per page, 1 to 500. Default 100."
},
"cursor": {
"type": "string",
"description": "The previous page's `next_cursor`. Omit for the oldest retained event."
},
"rule_id": {
"type": [
"integer",
"string"
],
"description": "Only the events of this alert (its id from alerts_list)."
}
}
},
"annotations": {
"title": "Alerts Events",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Send one of the user's own alert deliveries again (the same as POST /v1/alerts/deliveries/{id}/resend): the webhook or e-mail of an event that failed, expired or was lost on the receiving side. Take the delivery `id` from the `delivery` list of an event in alerts_events. Works whatever the delivery's status, up to 15 days after its event; it is queued for an immediate attempt with the same event id and a fresh signature, then retried as usual. Returns {id, status, result} where result is queued, already_queued or sending. Queued is a request, not a promise: the sender checks the rule and the channel again, so a delivery whose rule is off or whose channel is disabled or deleted is skipped again, and a paused channel delays the attempt. An error for a delivery that is not the user's own, is older than 15 days or is `unsupported` (its channel cannot carry that kind of event, so it would fail the same way). A wallet-orders event older than about an hour is sent again with its totals only: its `orders` list is kept 1 hour.
| Parameter | Type | Description |
|---|---|---|
| delivery_id * | ["integer","string"] | The delivery `id` from an event's `delivery` list in alerts_events. |
{
"name": "alerts_resend_delivery",
"title": "Alerts Resend Delivery",
"description": "Send one of the user's own alert deliveries again (the same as POST /v1/alerts/deliveries/{id}/resend): the webhook or e-mail of an event that failed, expired or was lost on the receiving side. Take the delivery `id` from the `delivery` list of an event in alerts_events. Works whatever the delivery's status, up to 15 days after its event; it is queued for an immediate attempt with the same event id and a fresh signature, then retried as usual. Returns {id, status, result} where result is queued, already_queued or sending. Queued is a request, not a promise: the sender checks the rule and the channel again, so a delivery whose rule is off or whose channel is disabled or deleted is skipped again, and a paused channel delays the attempt. An error for a delivery that is not the user's own, is older than 15 days or is `unsupported` (its channel cannot carry that kind of event, so it would fail the same way). A wallet-orders event older than about an hour is sent again with its totals only: its `orders` list is kept 1 hour.",
"inputSchema": {
"type": "object",
"required": [
"delivery_id"
],
"properties": {
"delivery_id": {
"type": [
"integer",
"string"
],
"description": "The delivery `id` from an event's `delivery` list in alerts_events."
}
}
},
"annotations": {
"title": "Alerts Resend Delivery",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}Rank top Hyperliquid perp wallets by PnL / ROI / win rate / volume / trade count within a time window. Use for questions like 'top HL traders with win rate > 75%' or 'best HL perp wallets last 7d'. Data comes from the same pipeline that backs vike.io/hyperliquid/wallets. Use win_rate expressed as percent (0-100). roi_pct is window realized PnL over the CURRENT account value (a unified or portfolio-margin wallet's whole value, native + builder + USDC outside them; perp_account_value is the native perp account and account_mode default, unifiedAccount, portfolioMargin or disabled) and max_drawdown_pct is account-level and all-time (null when the wallet has too little equity history to say, and for unified and portfolio-margin wallets), both in percent (12.5 = 12.5%).
| Parameter | Type | Description |
|---|---|---|
| size | ["integer","string"] | Number of traders (default 20, max 100) |
| sort | string | Sort metric (default pnl) |
| order | string | Sort direction (default desc) |
| window | string | Time window (default 30d) |
| min_trades | ["integer","string"] | Minimum trade count (default 3) |
| min_volume | ["number","string"] | Minimum volume USD (default 0 = no filter) |
| min_win_rate | ["number","string"] | Minimum win rate as percent 0-100 (default 0 = no filter) |
Reverse-lookup a Hyperliquid open position from share-card details (symbol + side + leverage + entry price). Given the info shown on a HL trader's share card, return wallet(s) with matching open positions, ranked by entry-price proximity. Useful for 'whose share card is this?' or 'who has a 25x ETH long open at $3,200?'. Walks tight (±0.05%) -> loose (±0.5%) -> fallback (±1.0%) entry bands and requires leverage within ±0.5. Reads from the latest position snapshot (freshness-gated to the newest 15-minute window).
| Parameter | Type | Description |
|---|---|---|
| side * | string | Position side |
| limit | ["integer","string"] | Max matches to return (default 50, max 500) |
| symbol * | string | Asset symbol (e.g. BTC, ETH, SOL) |
| leverage * | ["number","string"] | Leverage from share card (e.g. 5, 10, 25); 0 finds positions with no leverage recorded |
| mark_price | ["number","string"] | Optional current mark price; sharpens the tie-break when multiple wallets share the same entry. |
| entry_price * | ["number","string"] | Entry price from share card |
Hourly long/short positioning of ONE Hyperliquid perp split by cohort: every bucket of one ladder, every hour, in one call (the matrix behind 'are whales / smart money long or short BTC'). `axis` picks the ladder: `size` (account value), `pnl` (percentile of cumulative realized PnL), `pnl_abs` (realized PnL in dollar bands), `pnl_unrealized` (currently onside), `tier` (each position's own notional). Data from 2026-04-07 (the first hour cohort labels are correct); an older `start` is served from there and the envelope says `data_from`. Rows are hour x cohort: `n_wallets` (wallets in the cohort holding the symbol), notional in USD (`total_position_value`, `total_position_value_long`) and `bias` = (long - short) / (long + short), a fraction from -1 (all short) to +1 (all long), not a percent. BACKTESTS: by default the `pnl` cohort is TODAY's grading applied to past hours (look-ahead); pass label_basis=point_in_time for each hour's label as it was, and read `label_computed` and `freshness` in the envelope. The hour in progress is never included. The response holds about `hours` x 12-13 rows: pass a small `hours` (1-24) for a current read and page older data with `cursor`. With `include` (`volume`, `median_pnl`; `size` or `pnl` axis) the newest hour's rows also carry each cohort's 24-hour fill volume and the median realized PnL of its wallets, in USD, computed at request time. Same data as GET /v1/hl-cohorts/symbols/{symbol}/cohort-metrics.
| Parameter | Type | Description |
|---|---|---|
| end | string | ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z. |
| axis | string | Ladder to split by: `size` (account value), `pnl` (percentile of cumulative realized PnL), `pnl_abs` (realized PnL in dollar bands), `tier` (each position's own notional bucket; `trade_size` is an alias of it), `pnl_unrealized` (currently onside). |
| hours | ["integer","string"] | Number of hourly buckets, newest first; the response holds about this many x 12-13 cohort rows. Pass 1-24 for a current read. Max 8760. |
| start |
The Hyperliquid cohort vocabulary and its latest-snapshot positioning, by `view`. `cohorts`: the label sets per ladder, the exact spellings every `cohort` parameter accepts. `segments`: the catalogue with bounds, ranks and what each ladder measures (`size` is account value in USD; `pnl` is a percentile rank of cumulative realized PnL, not dollars; `pnl_abs` is dollars). `summary`: everything ONE cohort holds right now across all symbols: long/short notional in USD, `bias` a fraction from -1 to +1, `pct_wallets_in_profit` a FRACTION from 0 to 1 despite its name, `exposure_ratio` = notional / margin used, `perp_bias` = (long - short) / equity and `equity_exposure` = (long + short) / equity: positions on the main dex over the native perp account value, plus for a unified or portfolio-margin wallet the USDC it holds outside it (each wallet once, the whole account even under `opened_within`); builder-DEX positions are not included; wallets without a known positive equity are left out of perp_bias, equity_exposure and this share's numerator, see `equity_covered_share` (main-dex notional of the counted wallets / of the whole cohort). Unbounded ratios (above 1 = over 1x; null when equity <= 0); that equity is not `total_equity`, so perp_bias x total_equity != total_long_usd - total_short_usd. `heatmap`: the whole symbol x cohort board (large: every symbol with open interest; empty cells are omitted). Positions are the latest 5-minute snapshot. `history`: ONE cohort (`cohort` + `axis`, both required; `axis` is `size` or `pnl` only) hour by hour, summed over all symbols, newest first, from 2026-04-07: `long_usd` and `short_usd` in USD, `bias` = (long - short) / (long + short), a RATIO from -1 to +1 (null when both are 0), `position_count` = open positions, NOT wallets. Each hour carries the cohort label it had then (`label_basis` is `point_in_time`; `pnl` labels are daily before 2026-08-06, see `label_computed`). `hours` sizes the window, `limit` caps the rows, `has_more` says older rows exist. With `include=leverage` each hour also carries `perp_bias`, `equity_exposure` and `equity_covered_share`, the three `summary` ratios of that hour (null before 2026-08-11 and for a missing hour; `perp_bias` and `equity_exposure` are also null where no wallet has a known positive equity, and `equity_covered_share` is 0 when none is counted). An unknown cohort for the axis is an error. Same data as GET /v1/hl-cohorts/{cohorts, segments, segments/{cohort}/summary, heatmap, segments/{cohort}/history}.
| Parameter | Type | Description |
|---|
One Hyperliquid wallet, by `view`. `summary`: live equity, open positions, both cohort labels, the risk metrics of the window (`win_rate` is a FRACTION from 0 to 1; `max_drawdown_pct` and `pnl_pct` are percents, `pnl_pct` is null under $1 of equity), cumulative realized PnL since inception and lifetime deposits and withdrawals, all money in USD; `equity.account_value` is the wallet's whole value in the venue's unified and portfolio-margin modes (native perp account + builder accounts + USDC outside them, free spot tokens left out; those modes also read null on the drawdown fields), else the native perp account; `equity.perp_account_value` is always the native perp account and `equity.account_mode` is `default`, `unifiedAccount`, `portfolioMargin` or `disabled`; `open_positions.perp_bias` = (long - short) / `equity.perp_account_value` and `equity_exposure` = (long + short) / it, native perp account only: positions on the main dex over the native perp account value; builder-DEX positions are not included. Unbounded ratios, null with no main-dex position or no positive equity. `trades_summary`: closed round-trip trade statistics overall and per symbol, medians as well as means. An address we hold nothing for (`summary`) or that never traded (`trades_summary`) is an error, never a block of zeros. Find addresses with hl_leaderboard, hl_perp_top_traders or hl_position_match. Same data as GET /v1/hyperliquid/wallets/{address} and /wallets/{address}/trades/summary.
| Parameter | Type | Description |
|---|---|---|
| view | string | What to read. `summary`: equity, open positions, cohort labels, risk metrics and lifetime flow. `trades_summary`: closed-trade statistics overall and per symbol. Default `summary`. |
| window | string | Window of the risk metrics and trade statistics, by trade time: `1d`, `7d`, `30d` or `all`. |
| address | string | Hyperliquid wallet address: 0x followed by 40 hex characters, any case. Required. |
| opened_within | string |
A Hyperliquid wallet's event history, by `view`. `fills`: raw fills, newest first (`size_usd`, `closed_pnl` in USD; `fee` is in its own `fee_token`). `funding`: funding payments, `payment_usd` signed from the wallet's side (negative = the wallet PAID). `ledger`: deposits, withdrawals, transfers and vault events with `amount_usd`. `builders`: the builder codes the wallet's flow is routed through, by volume (`share_of_volume` is of its builder-routed volume only, not of all its trading). Keyset-paged: pass `nextCursor` back; it is null on the last page. Same data as GET /v1/hyperliquid/wallets/{address}/{fills, funding, ledger, builders}.
| Parameter | Type | Description |
|---|---|---|
| end | string | ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z. Used by view: fills, funding, ledger. |
| side | string | `buy` or `sell`. Omit for both. Used by view: fills. |
| view | string | What to read. `fills`: raw fills, newest first. `funding`: funding paid and received, newest first. `ledger`: deposits, withdrawals, transfers and vault events, newest first. `builders`: which builder codes the wallet's flow is routed through, by volume. Default `fills`. |
| limit | ["integer","string"] | Rows per page, newest first. Default by view: fills 100, funding 100, ledger 100, builders 50. Max by view: fills 5000, funding 5000, ledger 5000, builders 500. |
| start | string | ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. Used by view: fills, funding, ledger. |
| cursor | string | `nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. |
Rank Hyperliquid wallets with the full risk set, by `view`. `ranking`: precomputed per-window metrics sorted on any of 20 keys (PnL, ROI, win rate, Calmar, profit factor, drawdown, streaks, ...), filtered by cohort and by minimum trades / win rate / volume, cursor-paged. A window is what was REALIZED in it (the trades closed in it) and a wallet needs 3 closed trades in it unless `min_trades` says otherwise (0 = no floor). `flow_adjusted`: ranks FILLS-DERIVED realized trading PnL, which excludes deposits by construction, with deposits, withdrawals and daily attribution returned beside it, both of the NATIVE perp account only (`flow_unbalanced` marks rows whose attributed block is off the fills; `attributed` and `flow_unbalanced` are null for a wallet now in unified or portfolio-margin mode, whose native account follows margin). `account_value` and `roi` use the wallet's whole value in those two modes, which read null on the drawdown fields; `perp_account_value` and `account_mode` show the native account and the mode. UNITS differ from hl_perp_top_traders: here `win_rate` and `min_win_rate` are FRACTIONS (0.6 = 60%), there percents; `max_drawdown_pct` and `pnl_pct` are percents, and `pnl_pct` is null under $1 of equity (prefer it to the raw `roi`); money is USD. Same data as GET /v1/hyperliquid/leaderboard and /leaderboard/flow-adjusted.
| Parameter | Type | Description |
|---|---|---|
| axis | string | Cohort ladder: `size` = account-value tiers in USD, `pnl` = percentile rank of cumulative realized PnL (NOT dollars), `pnl_abs` = dollar bands of that same PnL. Selects the ladder `cohort` filters on. Used by view: ranking. |
| sort | string | Ranking metric; an unknown key is refused, never replaced by a default. Used by view: ranking. |
| view | string | What to read. `ranking`: traders ranked on any of 20 metrics with the full risk set. `flow_adjusted`: traders ranked on fills-derived trading PnL, deposits reported beside it. Default `ranking`. |
| limit |
Hyperliquid liquidations, by `view`. `fills`: liquidation events, newest first, filtered by symbol, wallet, side and time. Since 2026-08-03 rows are EXACT, the liquidated wallet's own fill from the node (`liq_ts` the fill's millisecond, sizes what it closed, `mark_price` the venue's mark); older rows are INFERRED from ~5-minute position snapshots (a position over $100 whose mark was within 5% of its liquidation price and which is gone from the next snapshot; `liq_ts` is that snapshot's time and size/mark are the last values seen; a hand close that near liquidation counts, partial liquidations are missed); `direction` is the side of the position that was CLOSED (long = longs liquidated, price fell) and each row's `pnl_cohort` carries a `pnl_cohort_basis` saying how it was labelled. `risk`: per symbol, the share of open notional close to liquidation: `percent_risk` is a FRACTION from 0 to 1 despite its name, ranked by that fraction, so thin micro-cap markets can top it (read `total_value_usd`, or pass `min_value_usd`). `heatmap`: one symbol, where its open positions' own liquidation prices cluster, in equal-width price bins weighted by notional USD; positions outside +-50% of mark or without a liquidation price are left out and counted under `coverage`. Same data as GET /v1/hyperliquid/{liquidations, liquidations/risk, symbols/{symbol}/liquidation-heatmap}.
| Parameter | Type | Description |
|---|---|---|
| end | string | ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z. Used by view: fills. |
| axis | string | Cohort ladder: `size` = account-value tiers in USD, `pnl` = percentile rank of cumulative realized PnL (NOT dollars), `pnl_abs` = dollar bands of that same PnL. Used by view: risk. |
| bins | ["integer","string"] | Number of equal-width price bins, minimum 5. The window is fixed at +-50% around the mark price. Max 500. Used by view: heatmap. |
| view | string | What to read. `fills`: liquidation events, newest first: exact from the node's fills since 2026-08-03, inferred from position snapshots before. `risk`: per symbol, the share of open notional close to liquidation. `heatmap`: where one symbol's open positions would liquidate, binned by price. Default … |
Hyperliquid market positioning, by `view`. `open_interest`: open interest per symbol at the latest snapshot beside the venue's own figure, so the two can be reconciled. `symbol_metrics`: the hourly open-interest, position-count and `bias` series (a fraction from -1 to +1) of ONE symbol, all cohorts summed or one cohort sliced; the newest row is `provisional` (the hour in progress). A cohort slice has data from 2026-04-07 (the first hour cohort labels are correct; `data_from`), all cohorts summed the whole history. A `pnl` cohort slice here uses TODAY's grading for past hours (look-ahead): use hl_cohort_metrics with label_basis=point_in_time for research. `size_breakdown`: one symbol's positioning by position-size bucket (ten dollar ranges, empty ones zero-filled). `positions`: individual position rows, current by default or historical with `start` (and optionally `end`; `end` alone is refused; bound it by `symbol` or `wallet`). `positions` is ordered by KEY, NOT by size (current: wallet, symbol, direction; historical: symbol, snapshot time, wallet), because the cursor pages on the primary key: `limit=10` is the first ten wallets in address order, never the ten biggest. For the biggest positions of ONE symbol pass `sort=size` (current only, `limit` at most 500, no `cursor`): rows come biggest first and each carries `account_value`, the wallet's NATIVE perp account value in USD (null when unknown, never 0; a builder DEX's separate account is not in it), `account_mode` (`default`, `unifiedAccount`, `portfolioMargin`, `disabled`) and `whole_account_value`: in the two modes whose margin lives outside the perp account, the native account plus the USDC held outside it, else equal to `account_value`; both null on a row that does not record the mode (before 2026-11-07 20:03 UTC or from the fallback poller); there is no per-position cumulative funding. For market-wide sizes use `size_breakdown`, `open_interest` or hl_cohort_metrics. `indices`: four cohort readings of ONE symbol, all RATIOS from -1 (all short) to +1 (all long), not percents, and null (never 0) when a cohort holds no positions: `latest` is the newest 5-minute snapshot and `series` the settled hourly rows, newest first, data from 2026-04-07 (the first hour cohort labels are correct; `data_from`) (`hours` sizes the window, `limit` caps the rows, `has_more` says older rows exist). `smi` = long share of the 3x smart / 2x smart / smart wallets minus long share of the rekt / 2x rekt / 3x rekt wallets; `wsi` = long share of the 4x whale .. whale wallets minus long share of the 2x shrimp / shrimp wallets; `whale_bias` and `smart_bias` = (long - short) / (long + short) over those whale / smart wallets (`latest` only). `latest.smi` and `latest.smart_bias` rank wallets by today's PnL grading (`latest.label_basis` is `current`), the hourly `series` by each hour's own grading (top-level `label_basis` is `point_in_time`). `large_fills`: one symbol's fills of at least `min_usd` (from $50,000) of the last `hours` (up to 24), newest first, the website's Whale Activity feed: `ts`, `wallet`, `direction` (`buy` | `sell`), `size_token`, `size_usd`, `price`, `order_type` (`market` = crossed the book, `limit` = rested), `size_cohort`, `pnl_cohort` (graded at the fill's own hour where that hour is labelled, else today; `pnl_cohort_basis` says which). The source keeps only the newest 200 fills over $50k per symbol, so on a busy symbol it reaches back minutes, not a day: `covered_from` is how far back the answer reaches (the oldest fill held when `truncated` is true, else the start of the `hours` window) and `truncated` is true when that cap may have cut older fills inside `hours` (they may all be below `min_usd`). `limit` defaults to 200, everything the source holds per symbol; `has_more` is true when a lower `limit` cut matching rows. Liquidations are not flagged. Notional is USD. `hourly`: an hourly panel of up to 64 `symbols` at once, the close (from fills) beside open interest, funding rate a
Hyperliquid builder codes (front-ends and bots that attach their address to an order and take a slice of the taker fee), by `view`. `leaderboard`: builders ranked by fee revenue, routed volume, unique users or fills over a window. `stats`: venue-wide builder economics. `profile`: one builder's totals with per-symbol and per-dex breakdowns, user-volume deciles and lifetime totals. `users`: the wallets routing through one builder. `fills`: its raw routed fills (sum `fee_usd`; `fee` is in its own `fee_token`). `series`: fee, volume, users and fills per hour or day (`users` is NOT additive across buckets). `fee_usd` is the builder's own cut, `trader_fee_usd` what the trader paid; every `*_pct` is percentage points 0-100. History depth differs by builder: compare `active_days` and `window` before comparing windows. Same data as GET /v1/hyperliquid/builders and its sub-routes.
| Parameter | Type | Description |
|---|---|---|
| end | string | ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z. Used by view: fills, series. |
| side | string | `buy` or `sell`. Omit for both. Used by view: fills. |
| sort | string | `leaderboard`: `fee` (the builder's own cut), `volume`, `users` or `fills`. `users`: `volume`, `fees` or `pnl` (the TRADERS' signed realized PnL, not the builder's). Default by view: leaderboard fee, users volume. Used by view: leaderboard, users. |
| view | string | What to read. `leaderboard`: builders ranked by fee revenue, volume, users or fills. `stats`: venue-wide builder-code economics. `profile`: one builder's totals with per-symbol and per-dex breakdowns. `users`: the wallets routing through one builder, ranked. `fills`: one builder's raw routed fills, … |
| limit | ["integer","string"] | Rows per page. Default by view: leaderboard 50, users 100, fills 100, series 500. Max by view: leaderboard 500, users 1000, fills 5000, series 2000. Used by view: leaderboard, users, fills, series. |
Hyperliquid vaults across the platform, by `view`. `list`: one row per vault family (HLP and its sub-vaults are one row) with current TVL, APR (our 30-day share-price return, annualised) and the window's PnL, return, net flow, volume and fills, plus `leverage` (gross notional / equity) and the leader's and top-5 depositors' shares; `q` searches by name or address. A family is measured from the first day all its open vaults are recorded (`start`, `partial`); its flows are the parent's. `stats`: platform TVL, deposits, withdrawals and net flow over the window, vaults created per month. `flows`: deposits and withdrawals of at least `min_usd` across all vaults, newest first. A window ends on the newest recorded day; one shorter than asked says `partial`. Money is USD, `*_pct` percentage points. Same data as GET /v1/hyperliquid/vaults, /vaults/stats and /vaults/flows.
| Parameter | Type | Description |
|---|---|---|
| q | string | Search, 2-64 characters: a case-insensitive part of the vault name, or an address prefix starting `0x` (a sub-vault's address finds its family). Used by view: list. |
| sort | string | Ranking: `tvl`, `apr`, `pnl`, `return`, `net_flow`, `volume`, `age`, `leverage` or `top5_share` (the five largest depositors' share). Used by view: list. |
| type | string | `all`, `deposit`, `withdraw`, `distribution` or `commission`. Used by view: flows. |
| view | string | What to read. `list`: every vault family with TVL, APR, the window's PnL, return, net flow and volume, leverage and depositor concentration; `q` searches by name or address. `stats`: platform TVL, flows over the window and vaults created per month. `flows`: deposits and withdrawals across all vaults… |
| limit | ["integer","string"] | Rows per page. Default by view: list 50, flows 100. Max by view: list 500, flows 1000. Used by view: list, flows. |
One Hyperliquid vault by address, by `view`. `profile`: TVL, APR, leverage, leader and top-5 shares, active depositors and all five windows (7d, 30d, 90d, 365d, all). `depositors`: every current depositor (not only the largest 100) with equity, PnL on the current position, all-time PnL, entry time, lockup end and PnL rank. `flows`: the vault's own ledger rows, newest first. `series`: equity, chained share price (`nav`), net flow and PnL per hour or day, oldest first (for a parent vault, its whole family). Its fills, trades and positions: hl_wallet and hl_wallet_activity with the vault address. Same data as GET /v1/hyperliquid/vaults/{vault} and its sub-routes.
| Parameter | Type | Description |
|---|---|---|
| end | string | ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z. Used by view: series. |
| sort | string | Ranking: `share`, `pnl` (on the current position), `all_time_pnl` (since the first deposit) or `entered` (entry time). Used by view: depositors. |
| type | string | `all`, `deposit`, `withdraw`, `distribution` or `commission`. Used by view: flows. |
| view | string | What to read. `profile`: TVL, APR, leverage, depositor concentration and all five windows. `depositors`: current depositors with their equity, PnL, entry and lockup, largest share first. `flows`: the vault's own deposits, withdrawals, distributions and commissions, newest first. `series`: equity, sh… |
| limit | ["integer","string"] | Rows per page. Default by view: depositors 100, flows 100, series 500. Max by view: depositors 1000, flows 1000, series 5000. Used by view: depositors, flows, series. |
| order | string |
Hyperliquid standing orders, by `view`. `open`: every order resting at one instant (`at`, default the newest snapshot) for a `symbol` and/or a `wallet`, in key order, each with its owner's `sizeCohort`, `pnlCohort` and `pnlCumUsd` (without `at` the current labels, with `at` those of the hour before the snapshot's own hour), optionally one cohort's, with `snapshotTs` and `source`: `l4_5m` = the node's 5-minute order snapshot (from 2026-10-23 21:45 UTC), `state_12m` = rebuilt from the ~12-minute checkpoints (from 2026-07-29; before the 5-minute feed, or while it is stalled), where short-lived orders can be missing. `wallet`: what became of one wallet's orders in a window, newest placement first: each order seen resting or filled in it, its fills in the window and a `status` (open, filled, partially_filled, canceled_or_expired); `notes` says what a snapshot cannot tell. `clusters`: one symbol's standing orders within `range_pct` of the mid of the best resting bid and ask, bucketed by price (bids and asks by limit price, take-profit and stop-loss by trigger price; trailing stops are not bucketed), optionally one cohort's. `book`: one symbol's order book at one instant, the resting limit orders summed per price (`px`, `sz`, `n` orders), `levels` a side, bids highest first and asks lowest first; `l4_5m` from 2026-11-13 08:40 UTC, `state_12m` from 2026-07-28, and `snapshotTs` is the snapshot's own time. `squeeze`: one perp's price ladder at one instant, per bucket the resting book (size and USD value), the stop orders that would trade into it when triggered and the open positions that would be liquidated into it, and `pressure` = that forced selling over the USD value of the resting bids below the mid, forced buying over the asks above it (above 1: a squeeze); `cohort` keeps one cohort's stops and liquidations. `book_cohorts`: which cohorts own the resting book within `band_bps` of the mid over time, per point and cohort the bid and ask notional and its share, each owner labelled as of that 5-minute snapshot. `open`, `clusters`, `book`, `book_cohorts` and `walls` read the perp books unless `market=spot`. `walls`: the large orders (at least `min_usd`, default $1M; a stop or take-profit at its trigger price) of a `symbol` and/or a `wallet` whose last sighting falls in a window (default the last 24 hours, at most 7 days), newest first, each with `outcome` (`filled`, `partially_filled`, `pulled` = left the book with no fill, `open`, or `unknown` while the fills are not yet stored), `filled_usd`, `lifetime_s`, `near_touch` (the other side of the book within `touch_bps` of its price when it was last seen; null where that snapshot's book is not stored: 5-minute snapshots before 2026-11-13 08:40 UTC) and its owner's labels (current for an open wall, else those of the hour before it was last seen: each row's `label_basis`). `order_stats`: one wallet's walls of at least `min_usd` (default $100k) in a window (default and at most 7 days) in totals and for its 20 busiest symbols: counts per outcome, `pulled_share` (pulled / walls that left the book with a known outcome), `cancel_to_fill_ratio` (pulled / filled), `pulled_near_touch_share` (over its newest 1,000 pulled walls), `median_lifetime_s`, `total_wall_usd` and `filled_usd`. Same data as GET /v1/hyperliquid/orders, /wallets/{address}/orders, /symbols/{symbol}/order-clusters, /symbols/{symbol}/book, /symbols/{symbol}/squeeze-map, /symbols/{symbol}/book-cohorts, /walls and /wallets/{address}/order-stats.
Hyperliquid TWAP orders, one row per status line, newest first. A line is a status CHANGE (`activated`, `waitingForTrigger`, then `finished`, `terminated` or `stopped`), not a slice fill: `executed_size` and `executed_notional_usd` are the cumulative totals when the line was written. Rejected placements (`error`) are hidden unless `status=error`. Across all wallets the window defaults to the last 24 hours and is at most 31 days; with `wallet` or `twap_id` neither applies. `order=asc` follows the feed: pass each `nextCursor` back and stop on an empty page. Same data as GET /v1/hyperliquid/twaps; with `wallet` it is GET /v1/hyperliquid/wallets/{address}/twaps (one feed: the cursors are interchangeable).
| Parameter | Type | Description |
|---|---|---|
| end | string | ISO-8601 UTC upper bound. Default: now. A window wider than 31 days is refused unless `wallet` or `twap_id` is given. |
| limit | ["integer","string"] | Rows per page. Max 5000. |
| order | string | `desc` (default, newest first) or `asc`, oldest first: the mode for FOLLOWING the feed. Pass each `nextCursor` back verbatim and stop on an EMPTY page, not on a null cursor (an `asc` page with rows always carries one). A row written late with an older key is not seen by a poller already past it: re-… |
| start | string | ISO-8601 UTC lower bound. Default: the 24 hours before `end`, unless `wallet` or `twap_id` is given. |
| cursor | string | `nextCursor` from the previous page, verbatim. It pins the call that returned it: send the same `order`, filters, `start` and `end` again, or the call is refused. |
| status | string | One status. Default: every status except `error` (a rejected placement, not an order); `error` shows those rows. |
Hyperliquid deposits, withdrawals, transfers and vault events ACROSS wallets, newest first, with `wallet` and `amount_usd` (USD) on every row; `min_usd` keeps the large ones (most events are small transfers). A transfer between two wallets is one row per affected wallet with the same `hash`. Without `wallet` the window defaults to the last 24 hours and is at most 31 days. `order=asc` follows the feed: pass each `nextCursor` back and stop on an empty page. One wallet's own ledger is also hl_wallet_activity view=ledger. Same data as GET /v1/hyperliquid/ledger.
| Parameter | Type | Description |
|---|---|---|
| end | string | ISO-8601 UTC upper bound. Default: now. A window wider than 31 days is refused unless `wallet` is given. |
| limit | ["integer","string"] | Rows per page. Max 5000. |
| order | string | `desc` (default, newest first) or `asc`, oldest first: the mode for FOLLOWING the feed. Pass each `nextCursor` back verbatim and stop on an EMPTY page, not on a null cursor (an `asc` page with rows always carries one). A row written late with an older key is not seen by a poller already past it: re-… |
| start | string | ISO-8601 UTC lower bound. Default: the 24 hours before `end`, unless `wallet` is given. |
| cursor | string | `nextCursor` from the previous page, verbatim. It pins the call that returned it: send the same `order`, filters, `start` and `end` again, or the call is refused. |
| wallet | string | One wallet, 0x followed by 40 hex characters, any case. With it there is no default window and no 31-day cap. |
| min_usd |
Hyperliquid positions whose leverage or margin mode differs between two consecutive complete position snapshots, newest first: one row per wallet and symbol with the previous and the new leverage, margin mode, side, size and entry price. `ts` is when the later snapshot was written, not when the venue changed the setting; positions are captured about every 12 minutes, so changes arrive in batches. Without `wallet` the window defaults to the last 24 hours and is at most 31 days. `order=asc` follows the feed (stop on an empty page). Same data as GET /v1/hyperliquid/leverage-changes.
| Parameter | Type | Description |
|---|---|---|
| end | string | ISO-8601 UTC upper bound. Default: now. A window wider than 31 days is refused unless `wallet` is given. |
| limit | ["integer","string"] | Rows per page. Max 5000. |
| order | string | `desc` (default, newest first) or `asc`, oldest first: the mode for FOLLOWING the feed. Pass each `nextCursor` back verbatim and stop on an EMPTY page, not on a null cursor (an `asc` page with rows always carries one). A row written late with an older key is not seen by a poller already past it: re-… |
| start | string | ISO-8601 UTC lower bound. Default: the 24 hours before `end`, unless `wallet` is given. |
| change | string | `up` (leverage rose), `down` (leverage fell) or `mode` (only the margin mode, `cross` or `isolated`, changed). Omit for every change. |
| cursor | string | `nextCursor` from the previous page, verbatim. It pins the call that returned it: send the same `order`, filters, `start` and `end` again, or the call is refused. |
One Hyperliquid wallet's CLOSED round-trip trades, newest close first, keyset-paged: per trade the symbol, direction, `open_ts` / `close_ts`, entry and exit price, the largest size held (`max_size_usd`), traded `volume_usd`, `realized_pnl` and `total_fee` in USD and the fill count. A trade still open is not listed. For statistics over these trades use hl_wallet view=trades_summary; for the raw fills hl_wallet_activity view=fills. Same data as GET /v1/hyperliquid/wallets/{address}/trades.
| Parameter | Type | Description |
|---|---|---|
| end | string | ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z. Bounds the close time. |
| limit | ["integer","string"] | Trades per page, newest close first. Max 5000. |
| start | string | ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. Bounds the close time. |
| cursor | string | `nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. |
| symbol | string | Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. Omit for all symbols. |
| address * | string | Hyperliquid wallet address: 0x followed by 40 hex characters, any case. |
Hyperliquid venue-wide hourly series, newest hour first, by `view`. `ecosystem`: perp equity, open interest and position counts per hour. `volume`: traded perp notional per hour, of the whole venue (builder-DEX perps included; spot and outcome markets left out) or of one `symbol`: `volume` counts each trade ONCE (one side), the figure the candles report, while `n_fills` counts fill records, two per trade. Money is USD. Keyset-paged with `cursor`. Same data as GET /v1/hyperliquid/stats and /stats/volume.
| Parameter | Type | Description |
|---|---|---|
| end | string | ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z. |
| view | string | What to read. `ecosystem`: hourly venue-wide perp equity, open interest and position counts, newest first. `volume`: hourly perp volume of the whole venue or one symbol, newest first. Default `ecosystem`. |
| limit | ["integer","string"] | Hourly rows per page, newest first. Max 5000. |
| start | string | ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. |
| cursor | string | `nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. |
| symbol | string | Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. `volume` only; omit for the whole venue (perps, builder-DEX perps included; spot and outcome markets are left out). Used by view: volume. |
The HYPE holder leaderboard: each wallet's spot HYPE balance plus staked HYPE, largest first, valued at one current HYPE price, with its `pnl_cohort` resolved at query time (`label_basis` is `current`; balances are last-known, so a stale balance can sit beside a fresh label) and `account_value`, the wallet's perp account value in USD (null for a holder with no perp account on record, never 0). Keyset-paged with `cursor`. Same data as GET /v1/hyperliquid/hype/holders.
| Parameter | Type | Description |
|---|---|---|
| limit | ["integer","string"] | Holders per page. Max 500. |
| order | string | `desc` (largest holders first, the default) or `asc`. |
| cursor | string | `nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. |
{
"name": "hl_hype_holders",
"title": "Hyperliquid Hype Holders",
"description": "The HYPE holder leaderboard: each wallet's spot HYPE balance plus staked HYPE, largest first, valued at one current HYPE price, with its `pnl_cohort` resolved at query time (`label_basis` is `current`; balances are last-known, so a stale balance can sit beside a fresh label) and `account_value`, the wallet's perp account value in USD (null for a holder with no perp account on record, never 0). Keyset-paged with `cursor`. Same data as GET /v1/hyperliquid/hype/holders.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"limit": {
"type": [
"integer",
"string"
],
"default": 100,
"maximum": 500,
"description": "Holders per page. Max 500."
},
"order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc",
"description": "`desc` (largest holders first, the default) or `asc`."
},
"cursor": {
"type": "string",
"description": "`nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page."
}
}
},
"annotations": {
"title": "Hyperliquid Hype Holders",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Polymarket markets, by `view`. `trending` (default): top prediction-market events ranked by 24h volume. Returns market title, slug, category, current Yes/No mid quotes, 24h volume, and end_date. Filter by category (Crypto | Sports | Politics | Pop-Culture | Tech | all). Use for 'what's hot on Polymarket' or 'top crypto prediction markets'. `search`: the recorded markets whose slug contains every word of `query` (any order, case-insensitive: 'bitcoin up or down' finds bitcoin-up-or-down-…), optionally only active or only closed ones, newest end_date first, paged with `limit` and `offset`; rows {active, closed, condition_id, end_date (epoch), neg_risk, slug, tick_size, token_ids}, `active` / `closed` derived from the on-chain resolution and Polymarket's own flag (a filter on them is the slower read). `market`: one market by `condition_id` in that row shape, a list of 0 or 1 rows, from the recorded markets or else Polymarket's full catalogue (`source` says which; an unknown id is `[]`). Same data as GET /v1/polymarket/markets and /markets/{condition_id}.
| Parameter | Type | Description |
|---|---|---|
| view | string | `trending` (default): top by 24h volume; `search`: filter the recorded markets; `market`: one market by condition_id. |
| limit | ["integer","string"] | Max markets: `trending` default 10, max 30; `search` default 50, max 100 (a larger value is clamped). |
| query | string | `search` only: case-insensitive substring of the market slug. |
| active | ["boolean","string"] | `search` only: true = only active markets, false = only closed ones; omit for all. Not together with `closed`. |
| closed | ["boolean","string"] | `search` only: the complement of `active` (true = only closed). Not together with `active`. |
Deep-dive on one Polymarket market by condition_id: question, category, outcomes with their clob_token_ids, 24h and total volume, liquidity, a price series per outcome, the top 30 holders per side, the last 100 trades (with wallets), tape stats and resolution status. There is no live quote or smart-money block here: use polymarket_orderbook for quotes and polymarket_smart_money for the cohort. Use after polymarket_markets when the user asks about a specific market.
| Parameter | Type | Description |
|---|---|---|
| condition_id * | string | Market condition_id (hex string) |
{
"name": "polymarket_market_detail",
"title": "Polymarket Market Detail",
"description": "Deep-dive on one Polymarket market by condition_id: question, category, outcomes with their clob_token_ids, 24h and total volume, liquidity, a price series per outcome, the top 30 holders per side, the last 100 trades (with wallets), tape stats and resolution status. There is no live quote or smart-money block here: use polymarket_orderbook for quotes and polymarket_smart_money for the cohort. Use after polymarket_markets when the user asks about a specific market.",
"inputSchema": {
"type": "object",
"required": [
"condition_id"
],
"properties": {
"condition_id": {
"type": "string",
"description": "Market condition_id (hex string)"
}
}
},
"annotations": {
"title": "Polymarket Market Detail",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Profile a Polymarket trader: realized P&L (24h / 7d / 30d / all-time), hit-rate on resolved markets, total volume, top categories traded, and recent positions. Use when the user gives a Polymarket wallet address. Also returns `correlated`: up to 8 other wallets that trade the same markets (each sharing at least 3 markets and $500 of volume with this one, compared over its 1,000 largest markets), most shared markets first, each with proxy_wallet, pseudonym, display_name, shared_markets, overlap_volume_usd, overlap_trades and last_seen; `[]` = none qualifies. Same data as GET /v1/polymarket/wallets/{address} plus /wallets/{address}/correlated.
| Parameter | Type | Description |
|---|---|---|
| window | string | Window for windowed metrics (default all) |
| address * | string | Polymarket wallet address (0x-prefixed) |
{
"name": "polymarket_wallet",
"title": "Polymarket Wallet",
"description": "Profile a Polymarket trader: realized P&L (24h / 7d / 30d / all-time), hit-rate on resolved markets, total volume, top categories traded, and recent positions. Use when the user gives a Polymarket wallet address. Also returns `correlated`: up to 8 other wallets that trade the same markets (each sharing at least 3 markets and $500 of volume with this one, compared over its 1,000 largest markets), most shared markets first, each with proxy_wallet, pseudonym, display_name, shared_markets, overlap_volume_usd, overlap_trades and last_seen; `[]` = none qualifies. Same data as GET /v1/polymarket/wallets/{address} plus /wallets/{address}/correlated.",
"inputSchema": {
"type": "object",
"required": [
"address"
],
"properties": {
"window": {
"enum": [
"24h",
"7d",
"30d",
"all"
],
"type": "string",
"default": "all",
"description": "Window for windowed metrics (default all)"
},
"address": {
"type": "string",
"description": "Polymarket wallet address (0x-prefixed)"
}
}
},
"annotations": {
"title": "Polymarket Wallet",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Full multi-source label cascade for one ETH wallet. Returns labels from several third-party label providers and the heuristic classifier with per-source attribution and a consensus entity/type. Source provider_e covers addresses that are, control or funded Polymarket wallets (category pm_wallet / pm_owner / pm_funder, with n_wallets, volume_usd, realized_pnl_usd, top_wallet and its public name) and mass payers of those wallets (bridge, exchange, batch_sender, campaign, pm_rewards_payer, ...), with basis onchain_fact or behaviour_inferred / behaviour_corroborated (a guess from behaviour) and evidence; it answers for an address on any EVM chain, and never feeds the consensus. found is true when any source knows the address. Use when the user asks 'what do you know about this address', 'who labeled this wallet' or 'is this a Polymarket trader'.
| Parameter | Type | Description |
|---|---|---|
| address * | string | Wallet address (0x-prefixed hex) |
{
"name": "wallet_label_provenance",
"title": "Wallet Label Provenance",
"description": "Full multi-source label cascade for one ETH wallet. Returns labels from several third-party label providers and the heuristic classifier with per-source attribution and a consensus entity/type. Source provider_e covers addresses that are, control or funded Polymarket wallets (category pm_wallet / pm_owner / pm_funder, with n_wallets, volume_usd, realized_pnl_usd, top_wallet and its public name) and mass payers of those wallets (bridge, exchange, batch_sender, campaign, pm_rewards_payer, ...), with basis onchain_fact or behaviour_inferred / behaviour_corroborated (a guess from behaviour) and evidence; it answers for an address on any EVM chain, and never feeds the consensus. found is true when any source knows the address. Use when the user asks 'what do you know about this address', 'who labeled this wallet' or 'is this a Polymarket trader'.",
"inputSchema": {
"type": "object",
"required": [
"address"
],
"properties": {
"address": {
"type": "string",
"description": "Wallet address (0x-prefixed hex)"
}
}
},
"annotations": {
"title": "Wallet Label Provenance",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Top holders of an ERC-20 token by cumulative net inflow USD. Returns wallet, net flow USD, volume USD, tx count, first/last seen dates, and known labels. Use when the user asks 'top holders of X' or 'who holds the most of token Y'. sort='flow' (default) ranks by cumulative net inflow USD, a flow and not a holding. sort='balance' ranks by the on-chain balanceOf among candidate wallets chosen by net inflow and by volume (a holder outside both is not in it) and adds balance, value_usd, supply_pct, balance_basis, balance_approximate and candidate_coverage to each row; balance_basis is 'chain' for a balance read from the chain ('unsupported' means the row is still ranked by flow, as for a chain's native coin), balance_approximate is true when a candidate's balance could not be read or the total supply is unknown, and candidate_coverage is the share of the total supply the candidates' balances add up to. sort='balance' is not available on every chain (the error names it). exclude_exchanges=true drops wallets labelled as an exchange.
| Parameter | Type | Description |
|---|---|---|
| sort | string | flow = cumulative net inflow USD (default); balance = on-chain balanceOf among candidate wallets |
| chain | string | Chain (default ethereum) |
| limit | ["integer","string"] | Max holders (default 10, max 50) |
| token_address * | string | ERC-20 token contract address (0x-prefixed) |
| exclude_exchanges | boolean | Drop wallets labelled as an exchange (default false) |
Register an HTTPS webhook as an alert delivery channel for the current user. We POST signed JSON to the URL when alerts fire, and once right now: a signed `test` event whose result comes back as `test` ({ok, status} or {ok, error}); a failing test does not refuse the channel. Every POST is signed with HMAC-SHA256: pass your own `secret` (>=16 chars) or we generate one and return it as `secret` in this answer (show it to the user now; it is shown at registration and again any time on Account -> Alerts -> channels, Show secret; alerts_rotate_webhook_secret issues a new one). The test is signed with that secret, so a receiver that checks signatures answers 401/403 until it has it: if your receiver needs the secret first, install it and call alerts_test_webhook. Recipients verify by computing HMAC-SHA256(secret, '{X-Vike-Timestamp}.{body}') over the RAW body and comparing it, in constant time, to EVERY `sig=` value of X-Vike-Signature: accept the delivery if ANY of them matches (during a secret rotation the header carries two). Replays should be rejected if timestamp is more than ~5 min old. Payload, headers and a verification example: https://vike.io/data/api#mcp-alerts
| Parameter | Type | Description |
|---|---|---|
| url * | string | Webhook URL, https:// only. Must be reachable from our server. |
| secret | string | Optional HMAC secret (>=16 chars). If omitted, we generate one and return it as `secret` in the answer. |
{
"name": "alerts_register_webhook",
"title": "Alerts Register Webhook",
"description": "Register an HTTPS webhook as an alert delivery channel for the current user. We POST signed JSON to the URL when alerts fire, and once right now: a signed `test` event whose result comes back as `test` ({ok, status} or {ok, error}); a failing test does not refuse the channel. Every POST is signed with HMAC-SHA256: pass your own `secret` (>=16 chars) or we generate one and return it as `secret` in this answer (show it to the user now; it is shown at registration and again any time on Account -> Alerts -> channels, Show secret; alerts_rotate_webhook_secret issues a new one). The test is signed with that secret, so a receiver that checks signatures answers 401/403 until it has it: if your receiver needs the secret first, install it and call alerts_test_webhook. Recipients verify by computing HMAC-SHA256(secret, '{X-Vike-Timestamp}.{body}') over the RAW body and comparing it, in constant time, to EVERY `sig=` value of X-Vike-Signature: accept the delivery if ANY of them matches (during a secret rotation the header carries two). Replays should be rejected if timestamp is more than ~5 min old. Payload, headers and a verification example: https://vike.io/data/api#mcp-alerts",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Webhook URL, https:// only. Must be reachable from our server."
},
"secret": {
"type": "string",
"description": "Optional HMAC secret (>=16 chars). If omitted, we generate one and return it as `secret` in the answer."
}
}
},
"annotations": {
"title": "Alerts Register Webhook",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}Rotate the signing secret of one of the user's webhook channels (ids from alerts_list_channels). A new secret is generated and returned as `secret` (show it to the user now; it is shown again any time on Account -> Alerts -> channels, Show secret). When the channel had a secret, the old one keeps signing for 24 hours (`previous_secret_valid_until`): until then every delivery carries TWO `sig=` values in X-Vike-Signature (the new secret's first, the old one's second). A receiver must accept a delivery if ANY `sig=` value matches its secret; one that compares a single value rejects deliveries during those 24 hours. Rotating again inside them ends the first overlap. A legacy channel that had no secret rotates without overlap (`previous_secret_valid_until` is null, one `sig=`). Install the new secret, then call alerts_test_webhook to check it.
| Parameter | Type | Description |
|---|---|---|
| channel_id * | ["integer","string"] | The webhook channel id (from alerts_list_channels). |
{
"name": "alerts_rotate_webhook_secret",
"title": "Alerts Rotate Webhook Secret",
"description": "Rotate the signing secret of one of the user's webhook channels (ids from alerts_list_channels). A new secret is generated and returned as `secret` (show it to the user now; it is shown again any time on Account -> Alerts -> channels, Show secret). When the channel had a secret, the old one keeps signing for 24 hours (`previous_secret_valid_until`): until then every delivery carries TWO `sig=` values in X-Vike-Signature (the new secret's first, the old one's second). A receiver must accept a delivery if ANY `sig=` value matches its secret; one that compares a single value rejects deliveries during those 24 hours. Rotating again inside them ends the first overlap. A legacy channel that had no secret rotates without overlap (`previous_secret_valid_until` is null, one `sig=`). Install the new secret, then call alerts_test_webhook to check it.",
"inputSchema": {
"type": "object",
"required": [
"channel_id"
],
"properties": {
"channel_id": {
"type": [
"integer",
"string"
],
"description": "The webhook channel id (from alerts_list_channels)."
}
}
},
"annotations": {
"title": "Alerts Rotate Webhook Secret",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}Send the signed `test` event to one of the user's webhook channels again (ids from alerts_list_channels), for example after the receiver installed a new secret from alerts_register_webhook or alerts_rotate_webhook_secret. Signed like a real delivery: the current secret and, inside a rotation's 24 hours, the previous one too (two `sig=` values; accept if ANY matches). Returns {ok, channel_id, test}, where `test` is {ok, status} when the endpoint answered (ok = HTTP 2xx) or {ok: false, error: timeout | network | ssrf_refused | ...}. Nothing is queued, retried or stored.
| Parameter | Type | Description |
|---|---|---|
| channel_id * | ["integer","string"] | The webhook channel id (from alerts_list_channels). |
{
"name": "alerts_test_webhook",
"title": "Alerts Test Webhook",
"description": "Send the signed `test` event to one of the user's webhook channels again (ids from alerts_list_channels), for example after the receiver installed a new secret from alerts_register_webhook or alerts_rotate_webhook_secret. Signed like a real delivery: the current secret and, inside a rotation's 24 hours, the previous one too (two `sig=` values; accept if ANY matches). Returns {ok, channel_id, test}, where `test` is {ok, status} when the endpoint answered (ok = HTTP 2xx) or {ok: false, error: timeout | network | ssrf_refused | ...}. Nothing is queued, retried or stored.",
"inputSchema": {
"type": "object",
"required": [
"channel_id"
],
"properties": {
"channel_id": {
"type": [
"integer",
"string"
],
"description": "The webhook channel id (from alerts_list_channels)."
}
}
},
"annotations": {
"title": "Alerts Test Webhook",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Raw per-wallet transfer list (single transactions, not aggregates). Filter by direction (in/out/all), days back, min USD, and optionally a specific token and, for that token, an amount range in whole tokens. Returns time, tx_hash, from, to, token_address, symbol, amount (whole tokens; null when the token's decimals are unknown), value_usd, direction, block. Use when the user asks 'show me recent transfers for X' / 'last 100 transactions of wallet Y' / forensic audit queries.
| Parameter | Type | Description |
|---|---|---|
| days | ["integer","string"] | Days back (default 30, max 365) |
| chain | string | Chain (default ethereum) |
| limit | ["integer","string"] | Max transactions (default 50, max 500) |
| address * | string | Wallet address (0x-prefixed) |
| min_usd | ["number","string"] | Filter dust below this USD value (default 0) |
| direction | string | Transfer direction (default all) |
| max_amount | ["number","string"] | Only transfers of at most this many tokens (whole tokens, not raw units, up to 1e18). Needs token_address (an amount across different tokens means nothing) and that token's decimals known, else an error. With min_usd, both must hold. Omit for no ceiling |
| min_amount | ["number","string"] |
Compare two wallets: shared counterparties (both wallets transacted with these addresses) + shared tokens (both wallets touched these tokens) within a window. Use when the user asks 'are these two wallets related' / 'what do X and Y have in common'.
| Parameter | Type | Description |
|---|---|---|
| chain | string | Chain (default ethereum) |
| limit | ["integer","string"] | Max shared items per category (default 10, max 50) |
| window | string | Window (default 30d) |
| address_a * | string | First wallet |
| address_b * | string | Second wallet |
{
"name": "wallet_compare",
"title": "Wallet Compare",
"description": "Compare two wallets: shared counterparties (both wallets transacted with these addresses) + shared tokens (both wallets touched these tokens) within a window. Use when the user asks 'are these two wallets related' / 'what do X and Y have in common'.",
"inputSchema": {
"type": "object",
"required": [
"address_a",
"address_b"
],
"properties": {
"chain": {
"enum": [
"ethereum",
"bsc",
"base",
"hyperevm"
],
"type": "string",
"default": "ethereum",
"description": "Chain (default ethereum)"
},
"limit": {
"type": [
"integer",
"string"
],
"default": 10,
"description": "Max shared items per category (default 10, max 50)"
},
"window": {
"enum": [
"24h",
"7d",
"30d",
"90d",
"180d",
"all"
],
"type": "string",
"default": "30d",
"description": "Window (default 30d)"
},
"address_a": {
"type": "string",
"description": "First wallet"
},
"address_b": {
"type": "string",
"description": "Second wallet"
}
}
},
"annotations": {
"title": "Wallet Compare",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Trace a wallet's money through counterparties. direction=out follows where funds went, in where they came from, both (default) either way. At each hop, expand to the top N counterparties by USD volume in that direction. Returns nodes + edges of the resulting graph. Use when the user asks 'where did funds from X go' (out) / 'who funded Y' (in) / 'follow the money 3 hops from Z' / wallet investigation.
| Parameter | Type | Description |
|---|---|---|
| chain | string | Chain (default ethereum) |
| depth | ["integer","string"] | Hops to follow (1-5, default 2) |
| width | ["integer","string"] | Top N counterparties per hop (1-10, default 5) |
| window | string | Window (default 30d) |
| address * | string | Root wallet to trace from |
| min_usd | ["number","string"] | Minimum USD per transfer to follow (default 10000) |
| direction | string | out = where funds went, in = where they came from, both = either (default both) |
{
"name": "wallet_trace",
"title": "Wallet Trace",
"description": "Trace a wallet's money through counterparties. direction=out follows where funds went, in where they came from, both (default) either way. At each hop, expand to the top N counterparties by USD volume in that direction. Returns nodes + edges of the resulting graph. Use when the user asks 'where did funds from X go' (out) / 'who funded Y' (in) / 'follow the money 3 hops from Z' / wallet investigation.",
"inputSchema": {
"type": "object",
"required": [
"address"
],
"properties": {
"chain": {
"enum": [
"ethereum",
"bsc",
"base",
"hyperevm"
],
"type": "string",
"default": "ethereum",
"description": "Chain (default ethereum)"
},
"depth": {
"type": [
"integer",
"string"
],
"default": 2,
"description": "Hops to follow (1-5, default 2)"
},
"width": {
"type": [
"integer",
"string"
],
"default": 5,
"description": "Top N counterparties per hop (1-10, default 5)"
},
"window": {
"enum": [
"24h",
"7d",
"30d",
"90d",
"all"
],
"type": "string",
"default": "30d",
"description": "Window (default 30d)"
},
"address": {
"type": "string",
"description": "Root wallet to trace from"
},
"min_usd": {
"type": [
"number",
"string"
],
"default": 10000,
"description": "Minimum USD per transfer to follow (default 10000)"
},
"direction": {
"enum": [
"both",
"out",
"in"
],
"type": "string",
"default": "both",
"description": "out = where funds went, in = where they came from, both = either (default both)"
}
}
},
"annotations": {
"title": "Wallet Trace",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Bulk label + 30d summary lookup for many addresses in one call. Caps at 100 addresses. Returns one row per input address in input order, with: entity, wallet_type, risk_flag, 30d net flow, 30d volume, 30d tx count, read from `chain`'s own tables. The 30d fields are live and null only for an address with no label (found: false). A row whose address source provider_e knows also carries provider_e: a list of that source's labels (the same entries wallet_label_provenance returns for source='provider_e'), on any chain; it never changes entity, wallet_type or found. Use when the user pastes a CSV of addresses or asks to enrich a list.
| Parameter | Type | Description |
|---|---|---|
| chain | string | Chain (default ethereum) |
| addresses * | array | Wallet addresses (0x-prefixed). Max 100. |
{
"name": "wallet_batch_labels",
"title": "Wallet Batch Labels",
"description": "Bulk label + 30d summary lookup for many addresses in one call. Caps at 100 addresses. Returns one row per input address in input order, with: entity, wallet_type, risk_flag, 30d net flow, 30d volume, 30d tx count, read from `chain`'s own tables. The 30d fields are live and null only for an address with no label (found: false). A row whose address source provider_e knows also carries provider_e: a list of that source's labels (the same entries wallet_label_provenance returns for source='provider_e'), on any chain; it never changes entity, wallet_type or found. Use when the user pastes a CSV of addresses or asks to enrich a list.",
"inputSchema": {
"type": "object",
"required": [
"addresses"
],
"properties": {
"chain": {
"enum": [
"ethereum",
"bsc",
"base",
"hyperevm"
],
"type": "string",
"default": "ethereum",
"description": "Chain (default ethereum)"
},
"addresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "Wallet addresses (0x-prefixed). Max 100."
}
}
},
"annotations": {
"title": "Wallet Batch Labels",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Discover tokens by activity within a window. Rank by volume, net inflow, holder count, or smart-money inflow. Filters: min volume USD, min holders, smart-money-only. Use when the user asks 'what tokens are trending today' / 'find tokens with smart money accumulating' / 'rising tokens under $100M cap'.
| Parameter | Type | Description |
|---|---|---|
| sort | string | Sort metric (default volume) |
| chain | string | Chain (default ethereum) |
| limit | ["integer","string"] | Max tokens (default 20, max 100) |
| window | string | Window (default 24h) |
| min_holders | ["integer","string"] | Filter tokens below this holder count |
| min_volume_usd | ["number","string"] | Filter tokens below this 24h volume |
| smart_money_only | ["boolean","string"] | Restrict to smart-money cohort flows. ethereum only: other chains (and sort=smart_inflow on them) are a 400 |
{
"name": "token_screener",
"title": "Token Screener",
"description": "Discover tokens by activity within a window. Rank by volume, net inflow, holder count, or smart-money inflow. Filters: min volume USD, min holders, smart-money-only. Use when the user asks 'what tokens are trending today' / 'find tokens with smart money accumulating' / 'rising tokens under $100M cap'.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"sort": {
"enum": [
"volume",
"net_inflow",
"holders",
"smart_inflow"
],
"type": "string",
"default": "volume",
"description": "Sort metric (default volume)"
},
"chain": {
"enum": [
"ethereum",
"bsc",
"base",
"hyperevm"
],
"type": "string",
"default": "ethereum",
"description": "Chain (default ethereum)"
},
"limit": {
"type": [
"integer",
"string"
],
"default": 20,
"description": "Max tokens (default 20, max 100)"
},
"window": {
"enum": [
"24h",
"7d",
"30d",
"90d"
],
"type": "string",
"default": "24h",
"description": "Window (default 24h)"
},
"min_holders": {
"type": [
"integer",
"string"
],
"description": "Filter tokens below this holder count"
},
"min_volume_usd": {
"type": [
"number",
"string"
],
"description": "Filter tokens below this 24h volume"
},
"smart_money_only": {
"type": [
"boolean",
"string"
],
"default": false,
"description": "Restrict to smart-money cohort flows. ethereum only: other chains (and sort=smart_inflow on them) are a 400"
}
}
},
"annotations": {
"title": "Token Screener",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Top trading partners of an ETH/BSC/Base/HyperEVM wallet by combined transfer volume. Returns counterparty address, total volume, amount sent/received, tx count, first/last seen, and labels (when known). Use when the user asks 'who does this wallet trade with' / 'main counterparties of X'.
| Parameter | Type | Description |
|---|---|---|
| chain | string | Chain (default ethereum) |
| limit | ["integer","string"] | Max counterparties (default 10, max 50) |
| window | string | Window (default 30d) |
| address * | string | Wallet address (0x-prefixed) |
{
"name": "wallet_counterparties",
"title": "Wallet Counterparties",
"description": "Top trading partners of an ETH/BSC/Base/HyperEVM wallet by combined transfer volume. Returns counterparty address, total volume, amount sent/received, tx count, first/last seen, and labels (when known). Use when the user asks 'who does this wallet trade with' / 'main counterparties of X'.",
"inputSchema": {
"type": "object",
"required": [
"address"
],
"properties": {
"chain": {
"enum": [
"ethereum",
"bsc",
"base",
"hyperevm"
],
"type": "string",
"default": "ethereum",
"description": "Chain (default ethereum)"
},
"limit": {
"type": [
"integer",
"string"
],
"default": 10,
"description": "Max counterparties (default 10, max 50)"
},
"window": {
"enum": [
"24h",
"7d",
"30d",
"90d",
"180d",
"all"
],
"type": "string",
"default": "30d",
"description": "Window (default 30d)"
},
"address": {
"type": "string",
"description": "Wallet address (0x-prefixed)"
}
}
},
"annotations": {
"title": "Wallet Counterparties",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Daily net-flow series for a wallet over the last N days (proxy for daily PnL). Returns per-day net inflow USD + cumulative + gross volume + tx count. NOTE: this is net inflow USD, not true realized PnL (which would require WAC accounting per token). Useful as a directional indicator.
| Parameter | Type | Description |
|---|---|---|
| days | ["integer","string"] | Days back (default 30, max 365) |
| chain | string | Chain (default ethereum) |
| address * | string | Wallet address (0x-prefixed) |
{
"name": "wallet_pnl_history",
"title": "Wallet PnL History",
"description": "Daily net-flow series for a wallet over the last N days (proxy for daily PnL). Returns per-day net inflow USD + cumulative + gross volume + tx count. NOTE: this is net inflow USD, not true realized PnL (which would require WAC accounting per token). Useful as a directional indicator.",
"inputSchema": {
"type": "object",
"required": [
"address"
],
"properties": {
"days": {
"type": [
"integer",
"string"
],
"default": 30,
"description": "Days back (default 30, max 365)"
},
"chain": {
"enum": [
"ethereum",
"bsc",
"base",
"hyperevm"
],
"type": "string",
"default": "ethereum",
"description": "Chain (default ethereum)"
},
"address": {
"type": "string",
"description": "Wallet address (0x-prefixed)"
}
}
},
"annotations": {
"title": "Wallet PnL History",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Current token balances for a wallet on Ethereum, BSC, Base and HyperEVM, read from the chain at request time. Returns per-holding (chain, symbol, balance, USD value, USD price). On base and hyperevm, symbol, name, balance and USD exist only for tokens we map and price (about 170 on base, about 50 on hyperevm). Any other token is listed, with its address and balance_raw and the rest null, only when min_usd=0 is passed: the default floor of $1 keeps priced tokens only. A non-zero native balance is always listed, with a USD value where a price exists; HyperCore (spot or perp accounts) is not included. Use when the user asks 'what tokens does this wallet hold' / 'current portfolio of X' — pair with wallet_label_provenance for institutional context.
| Parameter | Type | Description |
|---|---|---|
| chains | array | Chains to scan: ethereum, bsc, base, hyperevm (default: all four). Any other chain is reported in chain_errors |
| address * | string | Wallet address (0x-prefixed) |
| min_usd | ["number","string"] | Filter dust below this USD value (default 1.0) |
{
"name": "wallet_token_balances",
"title": "Wallet Token Balances",
"description": "Current token balances for a wallet on Ethereum, BSC, Base and HyperEVM, read from the chain at request time. Returns per-holding (chain, symbol, balance, USD value, USD price). On base and hyperevm, symbol, name, balance and USD exist only for tokens we map and price (about 170 on base, about 50 on hyperevm). Any other token is listed, with its address and balance_raw and the rest null, only when min_usd=0 is passed: the default floor of $1 keeps priced tokens only. A non-zero native balance is always listed, with a USD value where a price exists; HyperCore (spot or perp accounts) is not included. Use when the user asks 'what tokens does this wallet hold' / 'current portfolio of X' — pair with wallet_label_provenance for institutional context.",
"inputSchema": {
"type": "object",
"required": [
"address"
],
"properties": {
"chains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Chains to scan: ethereum, bsc, base, hyperevm (default: all four). Any other chain is reported in chain_errors"
},
"address": {
"type": "string",
"description": "Wallet address (0x-prefixed)"
},
"min_usd": {
"type": [
"number",
"string"
],
"default": 1,
"description": "Filter dust below this USD value (default 1.0)"
}
}
},
"annotations": {
"title": "Wallet Token Balances",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Reverse ENS lookup: turn a 0x address into a human-readable name like 'vitalik.eth'. Returns null if the address has no ENS name set. Use whenever you have an address and want to display a friendlier identifier.
| Parameter | Type | Description |
|---|---|---|
| address * | string | EVM wallet address (0x-prefixed, 42 chars) |
{
"name": "wallet_ens",
"title": "Wallet ENS",
"description": "Reverse ENS lookup: turn a 0x address into a human-readable name like 'vitalik.eth'. Returns null if the address has no ENS name set. Use whenever you have an address and want to display a friendlier identifier.",
"inputSchema": {
"type": "object",
"required": [
"address"
],
"properties": {
"address": {
"type": "string",
"description": "EVM wallet address (0x-prefixed, 42 chars)"
}
}
},
"annotations": {
"title": "Wallet ENS",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}The earliest inbound transfers of a wallet, from our own transfer tables, as TWO separate answers: `first_native_in` (the first plain send of the chain's coin to the wallet, at least `min_native` WHOLE coins; `amount` in whole coins, `amount_wei` exact in wei) and `first_token_in` (the first token transfer priced at `min_usd` USD or more; `amount` in whole tokens). Each carries the sender, its label (entity, wallet_type, label_confidence), time, tx_hash, block and `amount_usd` in plain dollars (null = no USD price). This is NOT proof of who funded the wallet: native rows hold top-level sends only (coin moved by a contract call or a bridge is absent), history starts on a different date per chain (`coverage.history_from`), and the sender may be an exchange or a relay. `found` is false when neither exists. On hyperevm, protocol system addresses appear as senders and come back with wallet_type 'system' (no entity name). Use when the user asks 'who funded this wallet' / 'where did its first coins come from', and pass the coverage caveats on.
| Parameter | Type | Description |
|---|---|---|
| chain | string | Chain (default ethereum) |
| address * | string | Wallet address (0x-prefixed) |
| min_usd | ["number","string"] | Floor for the token side in USD. Token transfers priced below it, or with no USD price, are skipped. Default 1; 0 = no floor (unpriced tokens, mostly spam, included). |
| min_native | ["number","string"] | Dust floor for the native coin in WHOLE coins (ETH, BNB or HYPE; 0.01 means 0.01 coin, not wei). Inbound native transfers below it are skipped. Default 0.0001; 0 = no floor (the very first inbound, probing dust included). |
Which centralised exchanges a wallet sent to and received from over a window, computed from our transfers joined to the addresses the chain's label table marks as exchanges. Returns `exchanges` [{entity, sent_usd, recv_usd, sent_share, transfers, first_seen, last_seen, addresses, label_confidence, label_sources}] with USD in plain dollars (priced transfers only), and `activity` totals over ALL counterparties so shares can be checked. `pattern` is "sweeps_to_single_cex" when >=90% of the wallet's outgoing USD went to one exchange across >=3 outgoing transfers: an OBSERVED pattern, not a claim that the address is a deposit address. Exchange figures are a lower bound (an exchange address we have not labelled is invisible; labels are sparse on hyperevm) and labels are a consensus with a stated confidence, not a certainty. A very active wallet is refused with a message to narrow `window`. `found` is false when the wallet has no priced transfer in the window. Use when the user asks 'which exchanges does this wallet use' / 'does it send to an exchange'.
| Parameter | Type | Description |
|---|---|---|
| chain | string | Chain (default ethereum) |
| window | string | Look-back window (default 365d). A very active wallet may be refused over a long window: narrow it |
| address * | string | Wallet address (0x-prefixed) |
{
"name": "wallet_exchange_usage",
"title": "Wallet Exchange Usage",
"description": "Which centralised exchanges a wallet sent to and received from over a window, computed from our transfers joined to the addresses the chain's label table marks as exchanges. Returns `exchanges` [{entity, sent_usd, recv_usd, sent_share, transfers, first_seen, last_seen, addresses, label_confidence, label_sources}] with USD in plain dollars (priced transfers only), and `activity` totals over ALL counterparties so shares can be checked. `pattern` is \"sweeps_to_single_cex\" when >=90% of the wallet's outgoing USD went to one exchange across >=3 outgoing transfers: an OBSERVED pattern, not a claim that the address is a deposit address. Exchange figures are a lower bound (an exchange address we have not labelled is invisible; labels are sparse on hyperevm) and labels are a consensus with a stated confidence, not a certainty. A very active wallet is refused with a message to narrow `window`. `found` is false when the wallet has no priced transfer in the window. Use when the user asks 'which exchanges does this wallet use' / 'does it send to an exchange'.",
"inputSchema": {
"type": "object",
"required": [
"address"
],
"properties": {
"chain": {
"enum": [
"ethereum",
"bsc",
"base",
"hyperevm"
],
"type": "string",
"default": "ethereum",
"description": "Chain (default ethereum)"
},
"window": {
"enum": [
"30d",
"90d",
"180d",
"365d",
"all"
],
"type": "string",
"default": "365d",
"description": "Look-back window (default 365d). A very active wallet may be refused over a long window: narrow it"
},
"address": {
"type": "string",
"description": "Wallet address (0x-prefixed)"
}
}
},
"annotations": {
"title": "Wallet Exchange Usage",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}The price Polymarket's crypto up/down markets resolve on: Chainlink Data Streams prices, as Polymarket's live-data socket relays them for its crypto markets, for btc, eth, sol, xrp, doge, bnb, hype or zec in USD, from 2026-11-06 09:24:15 UTC to about a minute ago (rows are stored once a minute). series=price (default) is the price, about one tick a second; series=twap60 is its 60-second time-weighted average. interval=1s (default) returns every tick; 1m, 5m, 15m, 1h, 4h or 1d return one row per bucket aligned to UTC, the FIRST tick at or after the bucket's start: the price an up/down market compares at the start and the end of its window. For a 5-minute, 15-minute or hourly market from S to E pass interval = its length (5m, 15m or 1h), from_ms=S and to_ms=E+1: two rows, the price at its start and at its end. 4-HOUR AND DAILY MARKETS FOLLOW US EASTERN TIME, off the UTC grid of the 4h and 1d buckets: pass interval=1m with from_ms=S and to_ms=S+60000, and again with from_ms=E and to_ms=E+60000. Returns {rows, has_more, next_cursor}; each row {ts_ms (bucket start, epoch ms), price_ts_ms (the tick's own time), price (USD)}. `from_ms` is inclusive and `to_ms` exclusive, both on ts_ms. While has_more is true pass next_cursor back as `cursor`; a page can hold fewer rows than `limit` while has_more is true, and within the last two minutes a page ends at the last row stored so far. About 1.6% of seconds have no row and nothing is filled in: about 600 single seconds a day, about 17 gaps a day of 2 to 5 seconds, and about 85 a day of 6 to 30 seconds that nearly always every coin skips at once; the longest, 74 seconds, was 2026-11-06 11:15:33 to 11:16:46 UTC. Compare price_ts_ms with ts_ms. A page is 100 rows by default and at most 10,000.
| Parameter | Type | Description |
|---|---|---|
| limit | ["integer","string"] | Rows per page (default 100, max 10000, as the REST route). |
| to_ms | ["integer","string"] | Bucket start, epoch milliseconds, EXCLUSIVE; must be greater than from_ms. Omit for up to now. |
| cursor | string | The previous page's next_cursor, passed back unchanged. |
ONE Polymarket market's trades WITH the wallet behind each, newest first, paged: who traded, which side, how many shares and at what price, from 2026-01-01 to a few minutes ago, read from the on-chain trade tape. Takes the market's `condition_id` (0x plus 64 hex digits, from polymarket_markets or polymarket_market_detail), NOT an outcome token id. Returns {trades, has_more, next_cursor}; while has_more is true pass next_cursor back as `cursor` for the next, older page. `from_ms` is inclusive and `to_ms` exclusive (epoch ms). A page is 100 rows by default and at most 10,000; a row is ~430 characters (a 66-character transaction hash and a 42-character wallet), so ask for what the context window holds. ONE ROW IS ONE ORDER'S FILL, NOT ONE MATCH: a match is several rows (the resting `maker` orders that were hit, plus one `taker` row for the aggressor, whose size is the sum of theirs), so never add size * price over both roles. A few percent of fills are merged away, so a count can sit slightly under the on-chain total. `proxy_wallet` is Polymarket's proxy wallet, not necessarily the person's own address. For the recorded order book (no wallets) use polymarket_tape; for one wallet's whole record use polymarket_wallet.
| Parameter | Type | Description |
|---|---|---|
| limit | ["integer","string"] | Rows per page (default 100, max 10000, as the REST route). |
| to_ms | ["integer","string"] | Trade time, epoch milliseconds, EXCLUSIVE; must be greater than from_ms. Omit for no upper bound. |
| cursor | string | The previous page's next_cursor, passed back unchanged. |
| from_ms | ["integer","string"] | Trade time, epoch MILLISECONDS, inclusive. Omit for the first trade. |
| condition_id * | string |
Detect smart-money signals on Polymarket. Two modes: 'flows' = markets with the largest net cohort inflow in the last N hours; 'mispricings' = markets where cohort bought meaningfully below current mid (potential edge). Cohort is wallets with $1k+ realized PnL over 5+ resolved markets.
| Parameter | Type | Description |
|---|---|---|
| mode | string | Signal type (default flows) |
| hours | ["integer","string"] | Lookback window in hours (default 24) |
| limit | ["integer","string"] | Max rows (default 10, max 20) |
| category | string | Category filter (default all) |
{
"name": "polymarket_smart_money",
"title": "Polymarket Smart Money",
"description": "Detect smart-money signals on Polymarket. Two modes: 'flows' = markets with the largest net cohort inflow in the last N hours; 'mispricings' = markets where cohort bought meaningfully below current mid (potential edge). Cohort is wallets with $1k+ realized PnL over 5+ resolved markets.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"mode": {
"enum": [
"flows",
"mispricings"
],
"type": "string",
"default": "flows",
"description": "Signal type (default flows)"
},
"hours": {
"type": [
"integer",
"string"
],
"default": 24,
"description": "Lookback window in hours (default 24)"
},
"limit": {
"type": [
"integer",
"string"
],
"default": 10,
"description": "Max rows (default 10, max 20)"
},
"category": {
"type": "string",
"default": "all",
"description": "Category filter (default all)"
}
}
},
"annotations": {
"title": "Polymarket Smart Money",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Raw Polymarket L2 event tape for ONE time window (at most 24 hours) on one or more outcome tokens, oldest first, from the recorded order-book feed. `token_id` / `token_ids` are ERC-1155 OUTCOME token ids (long decimal strings: read them off `clob_token_ids` in polymarket_market_detail or `outcomes[].token_id` in polymarket_markets); a market's condition_id (0x...) will NOT work. Event types: `trade` (price = probability in [0, 1], size = shares, side = buy | sell), `price_change`, `book` (the whole ladder in `bids` / `asks`, JSON carried as strings), `tick_size_change` (the new tick in `tick_size`, a field no other row has; from November 2026, earlier days have none), `status`. Always pass `event_type`: without it a page is mostly price_change and book rows. Returns {events, has_more, next_cursor}; pass next_cursor back as `cursor` for the next page. A 0 in `best_bid`, `best_ask`, `price` or `size` on a row type that does not populate it means absent, not a price of 0; `best_bid` and `best_ask` are recorded only since 2026-11-05 18:02 UTC, on `price_change` and `book` rows. The tape carries no wallet addresses. `to_ms` is EXCLUSIVE here, unlike `to` in polymarket_ohlcv.
| Parameter | Type | Description |
|---|---|---|
| limit | ["integer","string"] | Events per page (default 100, max 50000, as REST /events). |
| to_ms * | ["integer","string"] | Required. Window end, epoch MILLISECONDS, EXCLUSIVE. Must be greater than `from_ms` and at most 86400000 (24 hours) after it. |
| cursor | string | `next_cursor` from the previous page; resumes strictly after it. |
| from_ms * | ["integer","string"] | Required. Window start, epoch MILLISECONDS, inclusive. |
| token_id | string |
Order-book snapshot for ONE Polymarket outcome token: the nearest full-book snapshot at or before `ts` (the latest when omitted), flattened to price levels. `token_id` is the ERC-1155 OUTCOME token id (decimal string from `clob_token_ids` in polymarket_market_detail or `outcomes[].token_id` in polymarket_markets); a condition_id (0x...) will NOT work. Returns rows {as_of_ts (epoch ms, the snapshot actually used), side ('ask' | 'bid'), level (1 = best), price (probability in [0, 1]), size (shares)}, all asks before all bids. A book can be one-sided, so fewer than 2 x depth rows is normal. Each (side, level) appears once. `as_of_ts` can be old for a quiet or finished market, so check it before quoting a spread. [] means no snapshot at or before `ts`, or a token that was never recorded.
| Parameter | Type | Description |
|---|---|---|
| ts | ["integer","string"] | As-of epoch MILLISECONDS; the nearest snapshot at or before it is used. Omit for the latest. |
| depth | ["integer","string"] | Levels per side, 1 to 25 (default 25). |
| token_id * | string | Required. The outcome token id (decimal string). |
{
"name": "polymarket_orderbook",
"title": "Polymarket Orderbook",
"description": "Order-book snapshot for ONE Polymarket outcome token: the nearest full-book snapshot at or before `ts` (the latest when omitted), flattened to price levels. `token_id` is the ERC-1155 OUTCOME token id (decimal string from `clob_token_ids` in polymarket_market_detail or `outcomes[].token_id` in polymarket_markets); a condition_id (0x...) will NOT work. Returns rows {as_of_ts (epoch ms, the snapshot actually used), side ('ask' | 'bid'), level (1 = best), price (probability in [0, 1]), size (shares)}, all asks before all bids. A book can be one-sided, so fewer than 2 x depth rows is normal. Each (side, level) appears once. `as_of_ts` can be old for a quiet or finished market, so check it before quoting a spread. [] means no snapshot at or before `ts`, or a token that was never recorded.",
"inputSchema": {
"type": "object",
"required": [
"token_id"
],
"properties": {
"ts": {
"type": [
"integer",
"string"
],
"description": "As-of epoch MILLISECONDS; the nearest snapshot at or before it is used. Omit for the latest."
},
"depth": {
"type": [
"integer",
"string"
],
"default": 25,
"description": "Levels per side, 1 to 25 (default 25)."
},
"token_id": {
"type": "string",
"description": "Required. The outcome token id (decimal string)."
}
}
},
"annotations": {
"title": "Polymarket Orderbook",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Tape summary for ONE Polymarket outcome token: recorded events (`total_events`), `trades`, `trade_volume` in outcome SHARES (not USD), `snapshots`, and the first / last recorded timestamps (`first_ms` / `last_ms`, epoch ms). `token_id` is the ERC-1155 OUTCOME token id (decimal string from `clob_token_ids` in polymarket_market_detail or `outcomes[].token_id` in polymarket_markets); a condition_id (0x...) will NOT work. Always returns ONE row: a token that was never recorded answers all zeros with total_events = 0, which means 'never recorded', not 'quiet'.
| Parameter | Type | Description |
|---|---|---|
| token_id * | string | Required. The outcome token id (decimal string). |
{
"name": "polymarket_market_stats",
"title": "Polymarket Market Stats",
"description": "Tape summary for ONE Polymarket outcome token: recorded events (`total_events`), `trades`, `trade_volume` in outcome SHARES (not USD), `snapshots`, and the first / last recorded timestamps (`first_ms` / `last_ms`, epoch ms). `token_id` is the ERC-1155 OUTCOME token id (decimal string from `clob_token_ids` in polymarket_market_detail or `outcomes[].token_id` in polymarket_markets); a condition_id (0x...) will NOT work. Always returns ONE row: a token that was never recorded answers all zeros with total_events = 0, which means 'never recorded', not 'quiet'.",
"inputSchema": {
"type": "object",
"required": [
"token_id"
],
"properties": {
"token_id": {
"type": "string",
"description": "Required. The outcome token id (decimal string)."
}
}
},
"annotations": {
"title": "Polymarket Market Stats",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}On-chain resolution of ONE Polymarket market, keyed by its `condition_id` (the market's 0x... hex id from polymarket_markets or polymarket_market_detail; an outcome token id matches nothing here). Returns [] or one row {condition_id, slug, question, outcomes, winning_index, winning_outcome, winning_token_id, token_ids, payouts, resolved_block, resolved_ts_ms (epoch ms), market_known}. market_known false means the market list has no row for it: slug, question, outcomes, token_ids, winning_outcome and winning_token_id are then empty, the on-chain fields still exact. [] means the chain has not resolved this condition, NOT that the market is open: a market can be cancelled or voided with no on-chain resolution, so read polymarket_market_detail for the market's own status.
| Parameter | Type | Description |
|---|---|---|
| condition_id * | string | Required. The market's condition id (0x-prefixed hex). |
{
"name": "polymarket_settlement",
"title": "Polymarket Settlement",
"description": "On-chain resolution of ONE Polymarket market, keyed by its `condition_id` (the market's 0x... hex id from polymarket_markets or polymarket_market_detail; an outcome token id matches nothing here). Returns [] or one row {condition_id, slug, question, outcomes, winning_index, winning_outcome, winning_token_id, token_ids, payouts, resolved_block, resolved_ts_ms (epoch ms), market_known}. market_known false means the market list has no row for it: slug, question, outcomes, token_ids, winning_outcome and winning_token_id are then empty, the on-chain fields still exact. [] means the chain has not resolved this condition, NOT that the market is open: a market can be cancelled or voided with no on-chain resolution, so read polymarket_market_detail for the market's own status.",
"inputSchema": {
"type": "object",
"required": [
"condition_id"
],
"properties": {
"condition_id": {
"type": "string",
"description": "Required. The market's condition id (0x-prefixed hex)."
}
}
},
"annotations": {
"title": "Polymarket Settlement",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}On-chain resolutions of MANY Polymarket markets in one call, oldest resolution first, paged: the list form of polymarket_settlement (same row fields), for 'which markets resolved in this window', 'every settled BTC 5-minute market' or a backtest set. `from_ms` is inclusive and `to_ms` exclusive (epoch ms, on resolution time); `slug_prefix` (lowercase letters, digits and `-`, e.g. `btc-updown-5m-`) keeps one family of markets. Returns {settlements, has_more, next_cursor}; while has_more is true pass next_cursor back as `cursor` for the next page. Only markets the chain resolved appear: a cancelled or voided market with no on-chain resolution is not here. Pages are rebuilt every 5 minutes, so a market that resolved in the last 5 minutes may not be listed yet; polymarket_settlement is always current.
| Parameter | Type | Description |
|---|---|---|
| limit | ["integer","string"] | Rows per page (default 100, max 5000). |
| to_ms | ["integer","string"] | Resolution time, epoch ms, exclusive; must be greater than from_ms. Omit for no upper bound. |
| cursor | string | The previous page's next_cursor. |
| from_ms | ["integer","string"] | Resolution time, epoch ms, inclusive. Omit for the first resolution. |
| slug_prefix | string | Only markets whose slug starts with this, e.g. `btc-updown-5m-`. |
{
"name": "polymarket_settlements_bulk",
"title": "Polymarket Settlements Bulk",
"description": "On-chain resolutions of MANY Polymarket markets in one call, oldest resolution first, paged: the list form of polymarket_settlement (same row fields), for 'which markets resolved in this window', 'every settled BTC 5-minute market' or a backtest set. `from_ms` is inclusive and `to_ms` exclusive (epoch ms, on resolution time); `slug_prefix` (lowercase letters, digits and `-`, e.g. `btc-updown-5m-`) keeps one family of markets. Returns {settlements, has_more, next_cursor}; while has_more is true pass next_cursor back as `cursor` for the next page. Only markets the chain resolved appear: a cancelled or voided market with no on-chain resolution is not here. Pages are rebuilt every 5 minutes, so a market that resolved in the last 5 minutes may not be listed yet; polymarket_settlement is always current.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"limit": {
"type": [
"integer",
"string"
],
"default": 100,
"description": "Rows per page (default 100, max 5000)."
},
"to_ms": {
"type": [
"integer",
"string"
],
"description": "Resolution time, epoch ms, exclusive; must be greater than from_ms. Omit for no upper bound."
},
"cursor": {
"type": "string",
"description": "The previous page's next_cursor."
},
"from_ms": {
"type": [
"integer",
"string"
],
"description": "Resolution time, epoch ms, inclusive. Omit for the first resolution."
},
"slug_prefix": {
"type": "string",
"description": "Only markets whose slug starts with this, e.g. `btc-updown-5m-`."
}
}
},
"annotations": {
"title": "Polymarket Settlements Bulk",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Index of the bulk Polymarket L2 archive: one Parquet file per UTC day and stream (book_events, trades, l1_quotes), either multi-asset ('flat') or per asset and tenor ('family', e.g. btc + 5m). view='datasets' (default) lists files, filtered and paged, with `bytes` and `rows` where recorded; view='url' resolves exactly one file to a download link (give `date` and `stream`, plus `asset` and `tenor` together for a family file). This tool never downloads anything: the link is valid for 7 days (`expires_at`) and needs no API key, so fetch it yourself and do not share it. `asset` and `tenor` match family files ONLY, so supplying either hides every flat file. Returns {datasets, limit, offset, total} for 'datasets', one dataset row for 'url'.
| Parameter | Type | Description |
|---|---|---|
| date | string | view=url only. Required there. The UTC day, YYYY-MM-DD. |
| view | string | datasets = list files (default); url = resolve one file. |
| asset | string | Family files only, e.g. `btc`. With view=url give it together with `tenor`, or neither. |
| limit | ["integer","string"] | view=datasets only. Files per page (default 50, max 1000; `total` counts every match). |
| tenor | string | Family files only, e.g. `5m`. Pairs with `asset`. |
| offset | ["integer","string"] | view=datasets only. Skip this many matching files (default 0). |
| stream | string | One stream. Required for view=url. |
Leaderboard of Polymarket wallets ranked by realized P&L, hit rate, volume or trade count, for all time or over a window, optionally within one market category. The same board vike.io/polymarket shows. Returns rows {rank, proxy_wallet, pseudonym, display_name, realized_pnl_usd (lifetime, USD, resolved markets only), realized_pnl_window_usd (USD over `window`, by resolution time), resolved_markets, hit_rate, hit_rate_ci, volume_all_usd, volume_window_usd (USD), trades_all, trades_window, avg_trade_usd, markets, first_seen, last_seen (UTC), tags}. `hit_rate` is a FRACTION from 0 to 1 (0.62 = 62%), volume-weighted (the share of the wallet's resolved dollar volume that sat in markets it won), not a count of wins; it is null, never 0, when the wallet has no resolved volume. `hit_rate_ci` is the +/- half-width of the 95% Wilson interval, also a fraction: read hit_rate +/- hit_rate_ci and distrust a hit_rate with a wide one; a near-100% rate on a sliver of P&L is an arbitrage pattern, not skill. `min_resolved` defaults to 20 so a hit rate rests on a real sample; 0 lists thinner wallets. `tags` are whale (lifetime volume $100k or more), bot (average trade under $20 over 100+ trades), hot / cold (lifetime P&L of +/-$1,000 on 5+ resolved markets). The top of a category is often bots with tens of thousands of resolved markets: check `tags` and `avg_trade_usd`, or pass min_avg_usd=20 to drop every bot-tagged wallet. `first_seen` is the wallet's first trade in the recorded tape, which starts on 2026-01-01, so it does not show that a wallet is new. The 24h / 7d / 30d windows are rebuilt hourly (hour-granular) and a market's resolution time can be corrected later, so a windowed figure can be revised; window=all is not affected. Page with `limit` and `offset`; ties break on the wallet address. Addresses are public on-chain data; this tool names no one.
| Parameter | Type | Description |
|---|---|---|
| sort | string | Default: realized_pnl_window when `window` is 24h, 7d or 30d, realized_pnl when it is all. realized_pnl: lifetime USD, largest first, whatever the window. realized_pnl_asc: biggest losers first. realized_pnl_window / realized_pnl_window_asc: P&L inside `window`. hit_rate: highest first, nulls last; … |
| limit | ["integer","string"] |
Open interest of one perpetual-futures symbol on each venue Vike polls: aster, binance, bitget, bybit, hyperliquid, kucoin, okx. `oi_usd` is USD NOTIONAL (open contracts x mark price when polled), not contracts or coins. Without `hours`: the newest print per venue and its age in seconds; `venues` printed within the last hour, `stale_venues` went silent (last print within 30 days) and must NOT be summed in. With `hours` (1-168): an hourly series per venue, the last print in each UTC hour. Venues are polled roughly every 5-8 minutes. `symbol` is the canonical base asset ('BTC', not 'BTCUSDT'). A symbol no venue lists returns empty lists and a note, never zeros.
| Parameter | Type | Description |
|---|---|---|
| hours | ["integer","string"] | Omit for the latest print per venue. 1 to 168 for an hourly series over that many hours. |
| symbol * | string | Required. Base asset, e.g. 'BTC', 'ETH', 'SOL' (not 'BTCUSDT'). |
| exchange | string | Only this venue (lower case), e.g. 'binance'. Omit for every venue. |
{
"name": "perp_open_interest",
"title": "Perp Open Interest",
"description": "Open interest of one perpetual-futures symbol on each venue Vike polls: aster, binance, bitget, bybit, hyperliquid, kucoin, okx. `oi_usd` is USD NOTIONAL (open contracts x mark price when polled), not contracts or coins. Without `hours`: the newest print per venue and its age in seconds; `venues` printed within the last hour, `stale_venues` went silent (last print within 30 days) and must NOT be summed in. With `hours` (1-168): an hourly series per venue, the last print in each UTC hour. Venues are polled roughly every 5-8 minutes. `symbol` is the canonical base asset ('BTC', not 'BTCUSDT'). A symbol no venue lists returns empty lists and a note, never zeros.",
"inputSchema": {
"type": "object",
"required": [
"symbol"
],
"properties": {
"hours": {
"type": [
"integer",
"string"
],
"description": "Omit for the latest print per venue. 1 to 168 for an hourly series over that many hours."
},
"symbol": {
"type": "string",
"description": "Required. Base asset, e.g. 'BTC', 'ETH', 'SOL' (not 'BTCUSDT')."
},
"exchange": {
"type": "string",
"description": "Only this venue (lower case), e.g. 'binance'. Omit for every venue."
}
}
},
"annotations": {
"title": "Perp Open Interest",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Long/short positioning that perp venues publish for one symbol: binance, bybit, gate, okx. The venues do NOT measure the same thing, so every row carries `basis`: binance = top traders by POSITIONS; okx and gate = top traders by ACCOUNTS; bybit = ALL accounts. Compare a venue with itself over time, never as a like-for-like average across venues. `long_share` / `short_share` are fractions of 1 (0.63 = 63 %); `long_short_ratio` = long / short (1.72 = 1.72 longs per short; above 1 is long-heavy). Without `hours`: the newest 5-minute print per venue and its age in seconds (`venues` printed within the last hour, `stale_venues` went silent). With `hours` (1-168): an hourly `long_short_ratio` series per venue, the last print in each UTC hour. Covers about 40 major symbols only; any other symbol returns empty lists and a note, never zeros. `symbol` is the canonical base asset ('BTC').
| Parameter | Type | Description |
|---|---|---|
| hours | ["integer","string"] | Omit for the latest print per venue. 1 to 168 for an hourly series over that many hours. |
| symbol * | string | Required. Base asset, e.g. 'BTC', 'ETH', 'SOL' (not 'BTCUSDT'). |
| exchange | string | Only this venue (lower case), e.g. 'okx'. Omit for every venue. |
{
"name": "perp_long_short",
"title": "Perp Long Short",
"description": "Long/short positioning that perp venues publish for one symbol: binance, bybit, gate, okx. The venues do NOT measure the same thing, so every row carries `basis`: binance = top traders by POSITIONS; okx and gate = top traders by ACCOUNTS; bybit = ALL accounts. Compare a venue with itself over time, never as a like-for-like average across venues. `long_share` / `short_share` are fractions of 1 (0.63 = 63 %); `long_short_ratio` = long / short (1.72 = 1.72 longs per short; above 1 is long-heavy). Without `hours`: the newest 5-minute print per venue and its age in seconds (`venues` printed within the last hour, `stale_venues` went silent). With `hours` (1-168): an hourly `long_short_ratio` series per venue, the last print in each UTC hour. Covers about 40 major symbols only; any other symbol returns empty lists and a note, never zeros. `symbol` is the canonical base asset ('BTC').",
"inputSchema": {
"type": "object",
"required": [
"symbol"
],
"properties": {
"hours": {
"type": [
"integer",
"string"
],
"description": "Omit for the latest print per venue. 1 to 168 for an hourly series over that many hours."
},
"symbol": {
"type": "string",
"description": "Required. Base asset, e.g. 'BTC', 'ETH', 'SOL' (not 'BTCUSDT')."
},
"exchange": {
"type": "string",
"description": "Only this venue (lower case), e.g. 'okx'. Omit for every venue."
}
}
},
"annotations": {
"title": "Perp Long Short",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Index of the Hyperliquid Parquet archive and download links to its files. One file per UTC day for `fills` (every fill), `positions` (every 5-minute snapshot of every open position), `positions_hourly` (every position as last seen in each hour), `cohorts_hourly` (the hourly cohort matrix of every asset) and `wallets_hourly` (each wallet's native perp account per hour), from 2026-05-01, plus `latest`, one `positions` file of the current open positions replaced every 5 minutes. view='datasets' (default) lists the published days with each file's `rows` and `bytes`, the column `schema` of every dataset and the free samples' folder. view='url' resolves exactly ONE file (`dataset` and `date`) to a link valid for 7 days (`expires_at`) that needs no API key: this tool never downloads anything, so fetch it yourself and do not share it. A day appears once it is complete (the early UTC morning after). Same data as GET /v1/hyperliquid/archive/datasets and /archive/url.
| Parameter | Type | Description |
|---|---|---|
| date | string | view=url only, required there: a published UTC day, YYYY-MM-DD, or `latest` (`positions` only: the current open positions). |
| view | string | datasets = the index (default); url = a link to one file. |
| dataset | string | view=url only, required there: `fills`, `positions`, `positions_hourly`, `cohorts_hourly` or `wallets_hourly`. |
{
"name": "hl_archive",
"title": "Hyperliquid Archive",
"description": "Index of the Hyperliquid Parquet archive and download links to its files. One file per UTC day for `fills` (every fill), `positions` (every 5-minute snapshot of every open position), `positions_hourly` (every position as last seen in each hour), `cohorts_hourly` (the hourly cohort matrix of every asset) and `wallets_hourly` (each wallet's native perp account per hour), from 2026-05-01, plus `latest`, one `positions` file of the current open positions replaced every 5 minutes. view='datasets' (default) lists the published days with each file's `rows` and `bytes`, the column `schema` of every dataset and the free samples' folder. view='url' resolves exactly ONE file (`dataset` and `date`) to a link valid for 7 days (`expires_at`) that needs no API key: this tool never downloads anything, so fetch it yourself and do not share it. A day appears once it is complete (the early UTC morning after). Same data as GET /v1/hyperliquid/archive/datasets and /archive/url.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"date": {
"type": "string",
"description": "view=url only, required there: a published UTC day, YYYY-MM-DD, or `latest` (`positions` only: the current open positions)."
},
"view": {
"enum": [
"datasets",
"url"
],
"type": "string",
"default": "datasets",
"description": "datasets = the index (default); url = a link to one file."
},
"dataset": {
"enum": [
"fills",
"positions",
"positions_hourly",
"cohorts_hourly",
"wallets_hourly"
],
"type": "string",
"description": "view=url only, required there: `fills`, `positions`, `positions_hourly`, `cohorts_hourly` or `wallets_hourly`."
}
}
},
"annotations": {
"title": "Hyperliquid Archive",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Search everything vike knows by name, symbol or address in one call, the same search as the vike.io search box. Sections: `tokens` (live price, 24h change and the page to open), `hl_markets` (Hyperliquid builder markets such as xyz:GOLD), `wallets` (labelled entities and wallets on Ethereum, BSC, Base and HyperEVM; an entity row has `wallet_count` and `url`, the vike.io page listing its wallets, and an `address` only when it is one wallet; a type word such as `cex`, `bridge` or `hacker` lists that type's biggest entities), `traders`, `vaults` and `builders` (Hyperliquid), `polymarket` (Polymarket wallets by name, pseudonym or address, with the owner of an account or the accounts a personal wallet owns), `markets` (open Polymarket markets holding every word, several markets of one event as one row {event_slug, title, markets_n}; closed ones only when nothing else matched), `predictfun` (open Predict.fun markets on BNB Chain whose title or question holds every word, the busiest (24 h volume) first, then the newest, each {market_id, title, question, status, url}; closed and resolved ones only when nothing else matched; a pasted address that has traded there is one {address, url} row) and `did_you_mean` (coins one typo away when no token matched). `q` may be free text, a 0x address (also inside a pasted URL), an ENS name (searched as the address it points to) or a polymarket.com link. Each section holds at most `limit` rows; a section whose read fails comes back empty rather than failing the call. `url` fields are vike.io paths. Use it to turn a name into an address or id before calling another tool. Same data as GET /v1/search.
| Parameter | Type | Description |
|---|---|---|
| q * | string | What to look for, 1 to 256 characters: a name, symbol, label, address, ENS name or polymarket.com link. Filter words may go with it or alone: `chain:base` (eth, bsc, base, hyperevm), `type:cex` (an entity type), `pnl>1m` or `pnl<-100k` (traders' all-time PnL; k, m, b). |
| limit | ["integer","string"] | Rows per section, 1 to 20 (default 5). |
How to use the vike WebSocket stream (wss://stream.vike.io/v1/stream/<path>), read off the server's own registry: every path (hl, hl-cohorts, onchain, polymarket) with its channels; per channel its filter keys, each a list (with its maximum length), one value, a number (min_usd and the other min_ keys) or a boolean (contract: true or false, not a string), with the allowed values or the server's own message for a bad one, and its defaults (hl.fills: min_usd 1000 unless given); the REST catch-up route of each path; the limits (ONE connection per API key per path and THREE per account per path, newest wins with close 4410; 100 subscriptions per connection; a ping every 15 s); the close codes; cursor retention (3 days) and the subscribe message's shape. Check a filter with stream_check_filter and read missed events with stream_events.
No parameters.
{
"name": "stream_info",
"title": "Stream Info",
"description": "How to use the vike WebSocket stream (wss://stream.vike.io/v1/stream/<path>), read off the server's own registry: every path (hl, hl-cohorts, onchain, polymarket) with its channels; per channel its filter keys, each a list (with its maximum length), one value, a number (min_usd and the other min_ keys) or a boolean (contract: true or false, not a string), with the allowed values or the server's own message for a bad one, and its defaults (hl.fills: min_usd 1000 unless given); the REST catch-up route of each path; the limits (ONE connection per API key per path and THREE per account per path, newest wins with close 4410; 100 subscriptions per connection; a ping every 15 s); the close codes; cursor retention (3 days) and the subscribe message's shape. Check a filter with stream_check_filter and read missed events with stream_events.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {}
},
"annotations": {
"title": "Stream Info",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Validate a stream subscribe message (or a `channel` + `filter`) with the SAME validator the stream server runs, without connecting. Returns {valid: true, url, subscribe} with the filter exactly as the server will apply it (values normalised, lists sorted, defaults added: hl.fills gets min_usd 1000 unless given), or {valid: false, code, message} with the server's own error (`bad_subscription` naming the key, `unknown_channel` listing the path's channels). `path` checks the channel against the endpoint the connection would use (a channel of another path is `unknown_channel` there). Costs nothing.
| Parameter | Type | Description |
|---|---|---|
| path | string | The endpoint the connection would use. Default: the channel's own path. |
| filter | ["object","string"] | The filter object, e.g. `{"wallet": ["0x..."], "min_usd": 50000}`. Used when `message` is not given. |
| channel | string | A stream channel, e.g. `hl.fills`, `hl.liquidations`, `chain.transfers`, `pm.trades`; stream_info lists them all. Used when `message` is not given. |
| message | ["object","string"] | A whole subscribe message, e.g. `{"action": "subscribe", "id": "w1", "channel": "hl.fills", "filter": {"coin": ["BTC"]}}`. Or give `channel` and `filter` instead. |
{
"name": "stream_check_filter",
"title": "Stream Check Filter",
"description": "Validate a stream subscribe message (or a `channel` + `filter`) with the SAME validator the stream server runs, without connecting. Returns {valid: true, url, subscribe} with the filter exactly as the server will apply it (values normalised, lists sorted, defaults added: hl.fills gets min_usd 1000 unless given), or {valid: false, code, message} with the server's own error (`bad_subscription` naming the key, `unknown_channel` listing the path's channels). `path` checks the channel against the endpoint the connection would use (a channel of another path is `unknown_channel` there). Costs nothing.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"path": {
"enum": [
"hl",
"hl-cohorts",
"onchain",
"polymarket"
],
"type": "string",
"description": "The endpoint the connection would use. Default: the channel's own path."
},
"filter": {
"type": [
"object",
"string"
],
"description": "The filter object, e.g. `{\"wallet\": [\"0x...\"], \"min_usd\": 50000}`. Used when `message` is not given."
},
"channel": {
"type": "string",
"description": "A stream channel, e.g. `hl.fills`, `hl.liquidations`, `chain.transfers`, `pm.trades`; stream_info lists them all. Used when `message` is not given."
},
"message": {
"type": [
"object",
"string"
],
"description": "A whole subscribe message, e.g. `{\"action\": \"subscribe\", \"id\": \"w1\", \"channel\": \"hl.fills\", \"filter\": {\"coin\": [\"BTC\"]}}`. Or give `channel` and `filter` instead."
}
}
},
"annotations": {
"title": "Stream Check Filter",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Stored events of ONE stream channel after a cursor, oldest first, with the stream's own filters: the REST catch-up of wss://stream.vike.io, for what a socket missed or a quick look without a socket. Returns {events: [{cursor, event}], next_cursor, has_more}; `event` is byte for byte what the WebSocket frame carried. An idle window of the on-demand channel is an item {cursor, gap} in its place. Pass next_cursor back as `cursor` for the next page; a page at the end returns the channel head, so an empty page on a quiet channel returns the same cursor. Events are kept 3 days: an older cursor is refused with a resume cursor in the message. `since_ms` starts at an ARRIVAL time instead of a cursor. Delivery is at least once: dedupe on event.event_id. hl.fills without min_usd is min_usd 1000, as on the socket (0 = every fill). Every channel stream_info lists is accepted, including one the stream does not run yet (a subscribe there answers unknown_channel): its pages are empty, like a quiet channel's. Same data as GET /v1/{hyperliquid,onchain,polymarket}/stream-events.
| Parameter | Type | Description |
|---|---|---|
| limit | ["integer","string"] | Events per page, 1 to 1000 (default 200). |
| cursor | string | `next_cursor` of the previous page or the `cursor` of a stream frame. Omit (and omit since_ms) for the oldest retained event. |
| filter | ["object","string"] | The channel's filter keys as on a subscribe, e.g. `{"coin": ["BTC"], "min_usd": 100000}`. An unknown or channel-foreign key is refused. |
| channel * | string | A stream channel, e.g. `hl.fills`, `hl.liquidations`, `chain.transfers`, `pm.trades`; stream_info lists them all. Required. |
| since_ms | ["integer","string"] | Epoch MILLISECONDS: start after this arrival time instead of a cursor. Not together with `cursor`. |
Your own recent stream connections (this account only, every API key and OAuth app of it), newest first: path, url, api_key_id (or oauth_client_id), connected_at, `state` open or closed, the subscribe count and, once closed, closed_at, duration_s, the channels, close_code (4410 = replaced by a newer connection) and events_sent. RECONSTRUCTED from the connect, subscribe and close records the stream writes, not read from the stream's live state, and it may lag a few seconds: `open` means no close has been recorded yet (a server crash records none), and an open connection's channels are named only when it closes. Use it to see why a socket was closed or whether two programs share a key (each closes the other with 4410). `truncated` is true when only the newest records of the window could be read.
| Parameter | Type | Description |
|---|---|---|
| hours | ["integer","string"] | How far back to look, 1 to 720 hours (default 168, a week). A connection opened before it is not listed. |
| limit | ["integer","string"] | Connections to return, newest first, 1 to 1000 (default 50). |
{
"name": "stream_connections",
"title": "Stream Connections",
"description": "Your own recent stream connections (this account only, every API key and OAuth app of it), newest first: path, url, api_key_id (or oauth_client_id), connected_at, `state` open or closed, the subscribe count and, once closed, closed_at, duration_s, the channels, close_code (4410 = replaced by a newer connection) and events_sent. RECONSTRUCTED from the connect, subscribe and close records the stream writes, not read from the stream's live state, and it may lag a few seconds: `open` means no close has been recorded yet (a server crash records none), and an open connection's channels are named only when it closes. Use it to see why a socket was closed or whether two programs share a key (each closes the other with 4410). `truncated` is true when only the newest records of the window could be read.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"hours": {
"type": [
"integer",
"string"
],
"default": 168,
"description": "How far back to look, 1 to 720 hours (default 168, a week). A connection opened before it is not listed."
},
"limit": {
"type": [
"integer",
"string"
],
"default": 50,
"description": "Connections to return, newest first, 1 to 1000 (default 50)."
}
}
},
"annotations": {
"title": "Stream Connections",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Everything we know about ONE address in one call: a wallet checker / address lookup. Each part is its own block: `ens` (reverse ENS name), `tags` (names attached to the address, e.g. a token's name), `labels` (per chain: entity and wallet type), `label_sources` (which source claimed what about the address, read for Ethereum; third-party providers are named provider_a to provider_e), `label_origins` (BNB Chain, Base, HyperEVM: the origins each chain's label records and what each claimed, `origin` one of third_party (provider_a), model (our heuristic, with its source, confidence (null = not scored) and tier), cross_chain (copied from the same address's label on `from_chain`) or unknown; a claim can differ from the label), `onchain` (transfer count per chain where the address is active), `code` (per chain, the code found at the address when last checked: contract, eip7702 delegated wallet, safe multisig or proxy; a chain absent means no code when checked, or not checked), `token` (name, symbol and chain when it is a token contract), `first_funder` (per chain: the earliest inbound coin and priced token transfers we hold, with sender and label; not proof of who funded the wallet), `exchanges` (per chain: the centralised exchanges it sent to and received from over 365 days, a lower bound), `hl_trader`, `hl_vault`, `hl_builder` (its Hyperliquid identity), `polymarket` (the Polymarket account at this address, its owner, and the accounts it owns), `predictfun` (its Predict.fun fills, counted up to 100,000, first and last trade in epoch ms, and its realized P&L and volume from the leaderboard once ranked; null when it never traded there), and `summary` (plain observed facts read off the blocks, never a verdict such as 'safe'). first_funder and exchanges cover every chain the address has transfers on, or only `chain`. A block missing from the answer could not be read; an empty one means we looked and found nothing. Use when the user pastes an address and asks 'whose wallet is this', 'what is this address' or 'check this wallet'; for one chain's funder or exchanges with other floors or windows, use wallet_first_funder / wallet_exchange_usage.
| Parameter | Type | Description |
|---|---|---|
| chain | string | Read first_funder and exchanges on this chain only (default: every chain the address has transfers on) |
| address |
A wallet's per-token positions on one chain with real profit and loss. Per token: token_address, symbol, name, bought_qty and bought_usd, sold_qty and sold_usd, avg_buy_price and avg_sell_price (USD per token), realized_pnl_usd, balance (read from the chain at request time), price_usd (latest daily price), value_usd and unrealized_pnl_usd = balance x (price_usd - avg_buy_price), null when either is unknown. Bought and sold are the wallet's priced inbound and outbound transfers of the token (a swap, a move between its own wallets and an exchange deposit all count); a transfer with no USD price (a mint, a pre-listing airdrop) is neither. Realized PnL is average cost: only units that were bought are realized, the chain's coin and its wrapped token (WETH, WBNB, WHYPE) are one position under the zero address, and Ethereum stablecoins and disabled tokens are left out. `totals` cover EVERY token the wallet traded, not only the rows returned: realized_pnl_usd, unrealized_pnl_usd (over the tokens where it is known), tokens_traded, tokens_profitable and `as_of`, when the wallet's lifetime PnL in the wallet rankings was last recomputed (updated nightly at 04:00 UTC); the positions count trades up to the latest priced transfers, so the two differ only when the wallet traded since. USD in plain dollars. `found` is false for a wallet with no priced trade. Use when the user asks 'what did this wallet make on each token' / 'is it in profit' / 'what is it holding and at what cost'; wallet_pnl_history is a daily net-flow series, not this.
| Parameter | Type | Description |
|---|---|---|
| sort | string | Rank positions by realized PnL, unrealized PnL or current value (default realized). Unknown values sort last |
| chain | string | Chain (default ethereum) |
| limit | ["integer","string"] | Positions returned (default 20, max 100); totals always cover every token |
| order | string | desc = biggest first (default), asc = biggest losses first |
What happened in one transaction, by hash: `status` (success, failed, pending; unknown for Ethereum transactions before October 2017), `block`, `time`, `from` and `to` (each with its label: entity, wallet_type, label_confidence), `value` (the chain's coin sent at the top level: `amount` in whole coins, `amount_wei` exact, `amount_usd`), `fee` (gas_used, gas price and the fee in the chain's coin) and `token_transfers`: every ERC-20 transfer in it with token_address, symbol, decimals, from and to (labelled), `amount` in whole tokens, `amount_raw` exact and `amount_usd`. `usd_basis` says how each USD value was priced: transfer_time (the price at the transaction's minute) or latest_daily_price (only for a transaction from the last 24 hours not priced yet); null = no price. NFT transfers and internal (contract-call) coin transfers are not listed. `found` is false when the hash does not exist on that chain: the same hash format is used on every EVM chain, so try the chain it was sent on. Use when the user pastes a transaction hash or asks 'what happened in this transaction' / 'did it go through'.
| Parameter | Type | Description |
|---|---|---|
| chain | string | Chain (default ethereum) |
| tx_hash * | string | Transaction hash: 0x followed by 64 hex characters |
{
"name": "transaction_lookup",
"title": "Transaction Lookup",
"description": "What happened in one transaction, by hash: `status` (success, failed, pending; unknown for Ethereum transactions before October 2017), `block`, `time`, `from` and `to` (each with its label: entity, wallet_type, label_confidence), `value` (the chain's coin sent at the top level: `amount` in whole coins, `amount_wei` exact, `amount_usd`), `fee` (gas_used, gas price and the fee in the chain's coin) and `token_transfers`: every ERC-20 transfer in it with token_address, symbol, decimals, from and to (labelled), `amount` in whole tokens, `amount_raw` exact and `amount_usd`. `usd_basis` says how each USD value was priced: transfer_time (the price at the transaction's minute) or latest_daily_price (only for a transaction from the last 24 hours not priced yet); null = no price. NFT transfers and internal (contract-call) coin transfers are not listed. `found` is false when the hash does not exist on that chain: the same hash format is used on every EVM chain, so try the chain it was sent on. Use when the user pastes a transaction hash or asks 'what happened in this transaction' / 'did it go through'.",
"inputSchema": {
"type": "object",
"required": [
"tx_hash"
],
"properties": {
"chain": {
"enum": [
"ethereum",
"bsc",
"base",
"hyperevm"
],
"type": "string",
"default": "ethereum",
"description": "Chain (default ethereum)"
},
"tx_hash": {
"type": "string",
"description": "Transaction hash: 0x followed by 64 hex characters"
}
}
},
"annotations": {
"title": "Transaction Lookup",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Predict.fun (prediction markets on BNB Chain) at a glance: open markets, and the USD volume, number of matches and number of wallets over the last 24 whole fill hours, ending with the newest hour built (`newest_trade_ts`, epoch ms, is the newest fill counted; rebuilt hourly, so up to ~1.5 h behind the live tape). Volume counts each match once, on the side that took liquidity.
No parameters.
{
"name": "predictfun_overview",
"title": "Predict.fun Overview",
"description": "Predict.fun (prediction markets on BNB Chain) at a glance: open markets, and the USD volume, number of matches and number of wallets over the last 24 whole fill hours, ending with the newest hour built (`newest_trade_ts`, epoch ms, is the newest fill counted; rebuilt hourly, so up to ~1.5 h behind the live tape). Volume counts each match once, on the side that took liquidity.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"title": "Predict.fun Overview",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Predict.fun markets with each one's 24-hour USD volume, matches and wallets (the 24 whole fill hours ending with the newest hour built, up to ~1.5 h behind the live tape), largest volume first (or newest first). Filter by `status` (open, closed, resolved) and `q` (a substring of the title or question). Returns {markets, next_cursor, as_of_ts}; each market has `market_id` (what the other predictfun tools take), `condition_id`, `title`, `question`, `status`, `trading_status`, `category_slug`, `created_at` (epoch ms).
| Parameter | Type | Description |
|---|---|---|
| q | string | Case-insensitive substring of the title or question. |
| sort | string | `volume_24h` (default) or `newest`. A cursor works only with its own sort. |
| limit | ["integer","string"] | Rows (default 20, max 100). |
| cursor | string | A previous page's `next_cursor`, unchanged, to read the next page. |
| status | string | Only markets in this state. Default: all. |
{
"name": "predictfun_markets",
"title": "Predict.fun Markets",
"description": "Predict.fun markets with each one's 24-hour USD volume, matches and wallets (the 24 whole fill hours ending with the newest hour built, up to ~1.5 h behind the live tape), largest volume first (or newest first). Filter by `status` (open, closed, resolved) and `q` (a substring of the title or question). Returns {markets, next_cursor, as_of_ts}; each market has `market_id` (what the other predictfun tools take), `condition_id`, `title`, `question`, `status`, `trading_status`, `category_slug`, `created_at` (epoch ms).",
"inputSchema": {
"type": "object",
"properties": {
"q": {
"type": "string",
"description": "Case-insensitive substring of the title or question."
},
"sort": {
"enum": [
"volume_24h",
"newest"
],
"type": "string",
"description": "`volume_24h` (default) or `newest`. A cursor works only with its own sort."
},
"limit": {
"type": [
"integer",
"string"
],
"default": 20,
"description": "Rows (default 20, max 100)."
},
"cursor": {
"type": "string",
"description": "A previous page's `next_cursor`, unchanged, to read the next page."
},
"status": {
"enum": [
"open",
"closed",
"resolved"
],
"type": "string",
"description": "Only markets in this state. Default: all."
}
}
},
"annotations": {
"title": "Predict.fun Markets",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}One Predict.fun market by `market_id`: the market (title, question, status, category, fees, and `details`, Predict.fun's own record of it), its outcomes (token ids, names, WON/LOST once resolved, each one's last price) and stats (24-hour and total USD volume, 24-hour matches and wallets, `last_price` of the first outcome, Yes). The 24 hours are whole fill hours ending with the newest hour built (up to ~1.5 h behind the live tape). An unknown id is an error.
| Parameter | Type | Description |
|---|---|---|
| market_id * | ["integer","string"] | The Predict.fun market id (`market_id` from predictfun_markets). Required. |
{
"name": "predictfun_market_detail",
"title": "Predict.fun Market Detail",
"description": "One Predict.fun market by `market_id`: the market (title, question, status, category, fees, and `details`, Predict.fun's own record of it), its outcomes (token ids, names, WON/LOST once resolved, each one's last price) and stats (24-hour and total USD volume, 24-hour matches and wallets, `last_price` of the first outcome, Yes). The 24 hours are whole fill hours ending with the newest hour built (up to ~1.5 h behind the live tape). An unknown id is an error.",
"inputSchema": {
"type": "object",
"required": [
"market_id"
],
"properties": {
"market_id": {
"type": [
"integer",
"string"
],
"description": "The Predict.fun market id (`market_id` from predictfun_markets). Required."
}
}
},
"annotations": {
"title": "Predict.fun Market Detail",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}The newest recorded order book of one Predict.fun market, priced on its first outcome (Yes): `bids` highest first and `asks` lowest first as [price, quantity], orders matched but not yet settled (`pending_*`), the last settled order, `ts` (Predict.fun's time) and `recorded_ts` (ours), epoch ms. Books are recorded for the ~1,000 most active open markets; none in 30 days is an error.
| Parameter | Type | Description |
|---|---|---|
| market_id * | ["integer","string"] | The Predict.fun market id (`market_id` from predictfun_markets). Required. |
{
"name": "predictfun_market_book",
"title": "Predict.fun Market Book",
"description": "The newest recorded order book of one Predict.fun market, priced on its first outcome (Yes): `bids` highest first and `asks` lowest first as [price, quantity], orders matched but not yet settled (`pending_*`), the last settled order, `ts` (Predict.fun's time) and `recorded_ts` (ours), epoch ms. Books are recorded for the ~1,000 most active open markets; none in 30 days is an error.",
"inputSchema": {
"type": "object",
"required": [
"market_id"
],
"properties": {
"market_id": {
"type": [
"integer",
"string"
],
"description": "The Predict.fun market id (`market_id` from predictfun_markets). Required."
}
}
},
"annotations": {
"title": "Predict.fun Market Book",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}One Predict.fun market's on-chain fills with the wallet behind each, newest first: ts (epoch ms), tx_hash, wallet, counterparty, role (maker/taker), side (BUY/SELL of token_id), outcome, size (shares), price (0-1), usd, fee. Returns {trades, next_cursor}. One row is one ORDER's fill, not one match: a match is a `maker` row per resting order hit plus one `taker` row for the order that took them (whose amounts are theirs added up), so add `usd` over ONE role, never both.
| Parameter | Type | Description |
|---|---|---|
| limit | ["integer","string"] | Rows (default 100, max 10000). |
| cursor | string | A previous page's `next_cursor`, unchanged, to read the next page. |
| market_id * | ["integer","string"] | The Predict.fun market id (`market_id` from predictfun_markets). Required. |
{
"name": "predictfun_market_trades",
"title": "Predict.fun Market Trades",
"description": "One Predict.fun market's on-chain fills with the wallet behind each, newest first: ts (epoch ms), tx_hash, wallet, counterparty, role (maker/taker), side (BUY/SELL of token_id), outcome, size (shares), price (0-1), usd, fee. Returns {trades, next_cursor}. One row is one ORDER's fill, not one match: a match is a `maker` row per resting order hit plus one `taker` row for the order that took them (whose amounts are theirs added up), so add `usd` over ONE role, never both.",
"inputSchema": {
"type": "object",
"required": [
"market_id"
],
"properties": {
"limit": {
"type": [
"integer",
"string"
],
"default": 100,
"description": "Rows (default 100, max 10000)."
},
"cursor": {
"type": "string",
"description": "A previous page's `next_cursor`, unchanged, to read the next page."
},
"market_id": {
"type": [
"integer",
"string"
],
"description": "The Predict.fun market id (`market_id` from predictfun_markets). Required."
}
}
},
"annotations": {
"title": "Predict.fun Market Trades",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}One wallet's Predict.fun fills, newest first, each with its market (`market_id`, `market_title`) and `outcome`; otherwise the rows of predictfun_market_trades. Returns {trades, next_cursor}. One row is one ORDER's fill, not one match: a match is a `maker` row per resting order hit plus one `taker` row for the order that took them (whose amounts are theirs added up), so add `usd` over ONE role, never both.
| Parameter | Type | Description |
|---|---|---|
| limit | ["integer","string"] | Rows (default 100, max 10000). |
| cursor | string | A previous page's `next_cursor`, unchanged, to read the next page. |
| address * | string | The wallet, 0x and 40 hex digits. Required. |
{
"name": "predictfun_wallet_trades",
"title": "Predict.fun Wallet Trades",
"description": "One wallet's Predict.fun fills, newest first, each with its market (`market_id`, `market_title`) and `outcome`; otherwise the rows of predictfun_market_trades. Returns {trades, next_cursor}. One row is one ORDER's fill, not one match: a match is a `maker` row per resting order hit plus one `taker` row for the order that took them (whose amounts are theirs added up), so add `usd` over ONE role, never both.",
"inputSchema": {
"type": "object",
"required": [
"address"
],
"properties": {
"limit": {
"type": [
"integer",
"string"
],
"default": 100,
"description": "Rows (default 100, max 10000)."
},
"cursor": {
"type": "string",
"description": "A previous page's `next_cursor`, unchanged, to read the next page."
},
"address": {
"type": "string",
"description": "The wallet, 0x and 40 hex digits. Required."
}
}
},
"annotations": {
"title": "Predict.fun Wallet Trades",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}One wallet's Predict.fun positions and P&L, per outcome token: net shares, cost, proceeds, mark (last price), value (net x 1 won, x 0 lost, x mark while open), pnl = proceeds - cost + value, state (open, won, lost, uncatalogued); totals over ALL positions with realized (resolved) and unrealized (open) P&L. At most 500 positions are listed (open first, then the largest |pnl|): `positions_total` counts them all, `truncated` says some were left out. Exchange fills only: shares split, merged, redeemed or transferred are not seen.
| Parameter | Type | Description |
|---|---|---|
| address * | string | The wallet, 0x and 40 hex digits. Required. |
{
"name": "predictfun_wallet_positions",
"title": "Predict.fun Wallet Positions",
"description": "One wallet's Predict.fun positions and P&L, per outcome token: net shares, cost, proceeds, mark (last price), value (net x 1 won, x 0 lost, x mark while open), pnl = proceeds - cost + value, state (open, won, lost, uncatalogued); totals over ALL positions with realized (resolved) and unrealized (open) P&L. At most 500 positions are listed (open first, then the largest |pnl|): `positions_total` counts them all, `truncated` says some were left out. Exchange fills only: shares split, merged, redeemed or transferred are not seen.",
"inputSchema": {
"type": "object",
"required": [
"address"
],
"properties": {
"address": {
"type": "string",
"description": "The wallet, 0x and 40 hex digits. Required."
}
}
},
"annotations": {
"title": "Predict.fun Wallet Positions",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Every Predict.fun wallet ranked by realized P&L (default), volume or fills over a window, or by today's unrealized P&L; each row carries realized and unrealized P&L, open value, open and resolved positions (outcome tokens), volume and fills for every window. Rebuilt hourly. Returns {rows, window, sort, label_basis, as_of_ts}; page with `offset` (max 1000).
| Parameter | Type | Description |
|---|---|---|
| sort | string | Default `realized`. `unrealized` takes window `all` only. |
| limit | ["integer","string"] | Rows (default 20, max 50). |
| offset | ["integer","string"] | Rows to skip, 0 to 1000. |
| window | string | Default `all`. |
{
"name": "predictfun_leaderboard",
"title": "Predict.fun Leaderboard",
"description": "Every Predict.fun wallet ranked by realized P&L (default), volume or fills over a window, or by today's unrealized P&L; each row carries realized and unrealized P&L, open value, open and resolved positions (outcome tokens), volume and fills for every window. Rebuilt hourly. Returns {rows, window, sort, label_basis, as_of_ts}; page with `offset` (max 1000).",
"inputSchema": {
"type": "object",
"properties": {
"sort": {
"enum": [
"realized",
"unrealized",
"volume",
"fills"
],
"type": "string",
"description": "Default `realized`. `unrealized` takes window `all` only."
},
"limit": {
"type": [
"integer",
"string"
],
"default": 20,
"description": "Rows (default 20, max 50)."
},
"offset": {
"type": [
"integer",
"string"
],
"default": 0,
"description": "Rows to skip, 0 to 1000."
},
"window": {
"enum": [
"all",
"1d",
"7d",
"30d"
],
"type": "string",
"description": "Default `all`."
}
}
},
"annotations": {
"title": "Predict.fun Leaderboard",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Where one Predict.fun wallet's money came from and went: its USDT deposits (`in`) and withdrawals (`out`) on BNB Chain, newest first, each with the counterparty address and our label for it, such as cex/binance; transfers with Predict.fun's own contracts (trading, splits, merges, redemptions) are left out. Returns {flows, totals, next_cursor, as_of_ts}; totals cover the whole history since 2025-11-21: deposited, withdrawn, net, and the first deposit with its sender (`first_funder`). It is the wallet's whole USDT traffic outside Predict.fun (a wallet also used elsewhere carries that activity too); dust under one cent and per-transaction fees are left out.
| Parameter | Type | Description |
|---|---|---|
| limit | ["integer","string"] | Rows (default 100, max 10000). |
| cursor | string | A previous page's `next_cursor`, unchanged, to read the next page. |
| address * | string | The wallet, 0x and 40 hex digits. Required. |
{
"name": "predictfun_wallet_flows",
"title": "Predict.fun Wallet Flows",
"description": "Where one Predict.fun wallet's money came from and went: its USDT deposits (`in`) and withdrawals (`out`) on BNB Chain, newest first, each with the counterparty address and our label for it, such as cex/binance; transfers with Predict.fun's own contracts (trading, splits, merges, redemptions) are left out. Returns {flows, totals, next_cursor, as_of_ts}; totals cover the whole history since 2025-11-21: deposited, withdrawn, net, and the first deposit with its sender (`first_funder`). It is the wallet's whole USDT traffic outside Predict.fun (a wallet also used elsewhere carries that activity too); dust under one cent and per-transaction fees are left out.",
"inputSchema": {
"type": "object",
"required": [
"address"
],
"properties": {
"limit": {
"type": [
"integer",
"string"
],
"default": 100,
"description": "Rows (default 100, max 10000)."
},
"cursor": {
"type": "string",
"description": "A previous page's `next_cursor`, unchanged, to read the next page."
},
"address": {
"type": "string",
"description": "The wallet, 0x and 40 hex digits. Required."
}
}
},
"annotations": {
"title": "Predict.fun Wallet Flows",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Your own request usage: your plan and, for the month, the minute and the hour, the request limit and what is used of it. `plan` is free, starter, requests, requests_plus or custom, or null when no plan limit covers your account. `month` {limit, used, remaining, resets_at (the first day of next month, 00:00 UTC)}, all null when no monthly limit applies; free accounts on one IP address share one monthly allowance, and `used` counts it so. `minute` {limit}; `hour` {limit, used}, counted per API key. The counts trail by up to about a minute. Free: 0 credits, never counted toward the month. Same data as GET /v1/account/usage.
No parameters.
{
"name": "account_usage",
"title": "Account Usage",
"description": "Your own request usage: your plan and, for the month, the minute and the hour, the request limit and what is used of it. `plan` is free, starter, requests, requests_plus or custom, or null when no plan limit covers your account. `month` {limit, used, remaining, resets_at (the first day of next month, 00:00 UTC)}, all null when no monthly limit applies; free accounts on one IP address share one monthly allowance, and `used` counts it so. `minute` {limit}; `hour` {limit, used}, counted per API key. The counts trail by up to about a minute. Free: 0 credits, never counted toward the month. Same data as GET /v1/account/usage.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"title": "Account Usage",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
| hide_contracts | ["boolean","string"] | Leave out the contracts we know of (the website's 'Hide pools & routers'): wallets labelled as a pool, router, vault, bridge or staking contract, and addresses with contract code that bought and sold within 1% of each other (pass-through). Contract code is checked only for the wallets our pages rank… |
{
"name": "token_transfers",
"title": "Token Transfers",
"description": "Get who bought and sold a specific token in a given period, ranked by net USD. tab=bought lists the top NET buyers (bought more than sold), tab=sold the top NET sellers, largest first, with quantities and USD values. Wallets that only pass the token through (routers, pools: bought ~= sold) are not listed; a row can still be a contract (a pool, vault or settlement contract), and `title` names the known ones; `hide_contracts` leaves out the contracts we know of. bought / sold / net_tokens are whole tokens, usd_spent / usd_received USD. net_usd = usd_received - usd_spent, so a net buyer's is NEGATIVE: its net USD bought is -net_usd.",
"inputSchema": {
"type": "object",
"required": [
"token_address"
],
"properties": {
"tab": {
"enum": [
"bought",
"sold"
],
"type": "string",
"default": "sold",
"description": "Net buyers or net sellers (default sold)"
},
"chain": {
"enum": [
"ethereum",
"bsc",
"base",
"hyperevm",
"all"
],
"type": "string",
"default": "ethereum",
"description": "Chain (default ethereum)"
},
"period": {
"enum": [
"1h",
"24h",
"7d",
"30d"
],
"type": "string",
"default": "24h",
"description": "Lookback period (default 24h)"
},
"max_amount": {
"type": [
"number",
"string"
],
"description": "Count only transfers of at most this many tokens (whole tokens, not raw units, up to 1e18). Applied to each transfer BEFORE a wallet's totals are summed, so bought, sold and the USD columns add up only those transfers and a wallet ranks on them alone. Omit for no ceiling"
},
"min_amount": {
"type": [
"number",
"string"
],
"description": "Count only transfers of at least this many tokens (whole tokens, not raw units, up to 1e18). Applied to each transfer BEFORE a wallet's totals are summed, so bought, sold and the USD columns add up only those transfers and a wallet ranks on them alone. Omit for no floor"
},
"token_address": {
"type": "string",
"description": "Token contract address (0x-prefixed)"
},
"hide_contracts": {
"type": [
"boolean",
"string"
],
"default": false,
"description": "Leave out the contracts we know of (the website's 'Hide pools & routers'): wallets labelled as a pool, router, vault, bridge or staking contract, and addresses with contract code that bought and sold within 1% of each other (pass-through). Contract code is checked only for the wallets our pages rank, so a contract outside that set can still appear; one that mostly buys or sells (a vault, a smart wallet) stays. Default false."
}
}
},
"annotations": {
"title": "Token Transfers",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| symbol | string | HL asset: perp ticker (BTC), spot token (HYPE) or raw spot index (@107). Required by `candles` and `export`. |
| interval | string | Candle width. Default 1h; `latest` takes 1m only, its default. |
{
"name": "hl_ohlcv",
"title": "Hyperliquid OHLCV",
"description": "Historical OHLCV candles for a Hyperliquid market, aggregated from HL's own executed fills, by `view`. `candles` (default): one symbol's bars. Pass `symbol` as the HL asset (BTC, ETH, HYPE); `market` picks perps or HL spot and `dex` picks a builder-deployed HIP-3 perp DEX (default HL, the core venue). Buckets are left-aligned UTC and the window is half-open [start, end). Returns candles as {ts (epoch ms, UTC), open, high, low, close, volume, volume_usd, n_trades} ascending by ts, plus `source` naming the rollup that answered. `export`: the same, with `limit` defaulting to the maximum, 5000 (the REST export streams it as NDJSON). `latest`: the newest 1-minute bar of EVERY symbol that traded in the last hour in one call (takes only `market`, `dex` and `interval`; `dex` omitted = every DEX, each row naming its own; a bar may still be forming). Same data as GET /v1/hyperliquid/ohlcv, /ohlcv/export and /ohlcv/latest.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"dex": {
"type": "string",
"description": "Perp DEX. Default HL, the core venue; the others are builder-deployed HIP-3 DEXs. On `latest`, omitted = every DEX."
},
"end": {
"type": "string",
"description": "ISO-8601 UTC or epoch ms (exclusive). Default: now."
},
"view": {
"enum": [
"candles",
"latest",
"export"
],
"type": "string",
"default": "candles",
"description": "`candles` (default): one symbol's bars; `export`: the same with `limit` defaulting to 5000; `latest`: the newest 1-minute bar of every symbol."
},
"limit": {
"type": [
"integer",
"string"
],
"description": "Max candles (default 500 on `candles`, 5000 on `export`; hard max 5000)."
},
"start": {
"type": "string",
"description": "ISO-8601 UTC or epoch ms (inclusive). Default: end - limit*interval."
},
"market": {
"enum": [
"perp",
"spot"
],
"type": "string",
"default": "perp",
"description": "Perpetual or HL spot. Default perp."
},
"symbol": {
"type": "string",
"description": "HL asset: perp ticker (BTC), spot token (HYPE) or raw spot index (@107). Required by `candles` and `export`."
},
"interval": {
"enum": [
"1m",
"5m",
"15m",
"30m",
"1h",
"4h",
"1d"
],
"type": "string",
"description": "Candle width. Default 1h; `latest` takes 1m only, its default."
}
}
},
"annotations": {
"title": "Hyperliquid OHLCV",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| Parameter | Type | Description |
|---|---|---|
| band | ["number","string"] | hl_cohort_bias and hl_liq_proximity: hysteresis, greater than 0 (default 0.1). A bias alert fires when the index reaches threshold + band (up) or threshold - band (down); a proximity alert fires when the ratio reaches threshold and re-arms below threshold - band. |
| side | string | hl_wallet_orders only: only buy or only sell orders. Leave out for both. |
| chain | string | Transfer alerts only: the chain to watch (single value). Default: eth. Ask the user to create two alerts if they want both chains. Leave out for Hyperliquid alerts. |
| index | string | hl_cohort_bias only, required: the index watched for token_symbol. smi = long share of smart wallets minus long share of rekt wallets; wsi = long share of whales minus long share of shrimp; smart_bias / whale_bias = (long - short) / (long + short) of that cohort; smi_wsi_gap = smi - wsi. Ratios run … |
| label * | string | Name for this alert (e.g. 'Big USDC moves') |
| events | array | hl_wallet_orders only: placed = a new order appeared in the book, gone = an order left it (its outcome filled, partially_filled or canceled comes from the order's own fills). Default both. Each check's orders arrive together, as one event. |
| wallet | string | One 0x + 40-hex address. Hyperliquid: the account to watch, required for hl_wallet, hl_wallet_orders and hl_liq_proximity, optional for hl_liquidation. Polymarket: the proxy wallet (the address of its vike.io/polymarket/wallet page and of polymarket_tape rows), required for pm_wallet_trade. |
| actions | array | hl_wallet only: which fills notify. Default: open, close, flip, increase ('add' is accepted for increase); reduce is opt-in. |
| address | string | Transfer alerts only: wallet to watch, one 0x + 40-hex EVM address. Matches transfers (native or token) the address sent or received on `chain`, per address_role. |
| channels | array | Which kinds of the user's enabled channels to notify. email: any alert (a Hyperliquid or Polymarket alert mails the account address). webhook: any alert (register one with alerts_register_webhook; asking for a Hyperliquid or Polymarket alert's webhook the user has not registered is an error). Discor… |
| direction | string | hl_cohort_bias: which crossings notify. pm_price_move: which moves of the market's first outcome (Yes on a yes/no market) notify. Default both. |
| threshold | ["number","string"] | hl_cohort_bias: the index level to cross (default 0). hl_liq_proximity: the share of the way from entry price to liquidation price, strictly between 0 and 1 (default 0.8). |
| alert_type | string | transfer (default), a Hyperliquid type (hl_wallet, hl_cohort_fill, hl_liquidation, hl_cohort_bias, hl_liq_proximity, hl_wallet_orders) or a Polymarket type (pm_wallet_trade, pm_market_trade, pm_price_move, pm_resolution). Fixed once created. |
| min_amount | ["number","string"] | Transfer alerts only, with token_symbol: alert when the transfer moves at least this many WHOLE tokens (1000000 USDT, 0.5 ETH), whether or not it carries a USD value. With min_value_usd or max_value_usd as well, both must hold. A token whose decimals are unknown never matches it. |
| pnl_cohorts | array | hl_cohort_fill and hl_liquidation: only wallets in these realised-PnL cohorts (the ladder runs from '3x smart' = top 1% to '3x rekt' = bottom 5%). hl_cohort_fill REQUIRES at least one PnL or size cohort; for hl_liquidation empty = any cohort. |
| address_role | string | Transfer alerts only: any = sent or received (default), from = only transfers the address sent, to = only transfers it received. Needs `address`. |
| condition_id | string | Polymarket only: the market, its 0x + 64-hex condition id. Required for pm_market_trade, pm_price_move and pm_resolution; optional for pm_wallet_trade (one market of that wallet). |
| size_cohorts | array | hl_cohort_fill and hl_liquidation: only wallets in these account-size cohorts (the ladder runs from '4x whale' = $10M+ to 'shrimp' = under $1k). hl_cohort_fill REQUIRES at least one PnL or size cohort; for hl_liquidation empty = any size. |
| token_symbol | string | Transfer: token ticker in UPPERCASE (e.g. USDC, ETH, PEPE). Hyperliquid: the perp coin as Hyperliquid names it (BTC, kPEPE, xyz:CL); required for hl_cohort_bias, optional for the rest (omit = every coin). |
| max_value_usd | ["number","string"] | Transfer alerts only: an upper bound on the transfer's USD value. A transfer worth more than this does not notify (one worth exactly this does). Like min_value_usd it needs a transfer that already carries a USD value, so an unpriced transfer never matches a rule with a bound. Keep it at or above min… |
| min_value_usd | ["number","string"] | Transfer: alert when transfer USD value >= this. Hyperliquid: a floor on the fill or liquidation size in USD (hl_wallet, hl_liquidation); required and >= 10000 for hl_cohort_fill; the order's size x price for hl_wallet_orders (>= 1000, default 10000); not used by hl_cohort_bias or hl_liq_proximity. … |
| cooldown_minutes | ["integer","string"] | Token-wide transfer alerts (no address): minimum gap between notifications. Default 60. Address alerts and Hyperliquid and Polymarket alerts notify on every event and ignore it. |
{
"name": "alerts_create",
"title": "Alerts Create",
"description": "Create an alert rule for the current user: an on-chain transfer alert (the default), a Hyperliquid or a Polymarket alert, chosen by `alert_type`. TRANSFER ('transfer'): fires when a transfer on ONE chain (eth, bsc, base or hyperevm) matches: token_symbol if given, min_value_usd if given, and, if `address` is given, that wallet on the side `address_role` says. `address` = ONE 20-byte EVM address ('0x' + 40 hex); ENS names, entity names and non-EVM addresses are refused. Without min_value_usd EVERY transfer touching the address matches (dust and unpriced tokens too); with min_value_usd or max_value_usd only transfers that already carry a USD value do. min_amount (needs token_symbol) is a floor in whole tokens, priced or not; set with a USD bound, both must hold. An alert with an `address` notifies on EVERY matching transfer: no cooldown, no daily cap. A token-wide alert (no address) sends one notification per cooldown_minutes for the newest match, at most 10 a day. HYPERLIQUID (perpetuals only; leave out chain, address, address_role and max_value_usd): hl_wallet = every fill of `wallet` (required), narrowed by `actions`, `token_symbol` (the coin) and min_value_usd; hl_cohort_fill = every fill by wallets in `pnl_cohorts` / `size_cohorts` (at least one cohort is REQUIRED, or it would match every large fill on Hyperliquid), REQUIRES min_value_usd >= 10000; hl_liquidation = every liquidation, optionally of one `wallet`, of cohorts, of one coin, above a min_value_usd floor; hl_cohort_bias = the cohort `index` of `token_symbol` (required) crossing `threshold` by `band`, filtered by `direction`; hl_liq_proximity = `wallet` (required) getting `threshold` of the way from entry to liquidation price; hl_wallet_orders = the orders of `wallet` (required) worth at least min_value_usd (size x price, default 10000, >= 1000) that are placed or gone (`events`), narrowed by `side` and `token_symbol`, from the 5-minute order-book snapshots, as one event per evaluator pass (about every 5 minutes) whose `orders` lists every one of them with its `action` (placed or gone; a gone one with its outcome filled, partially_filled or canceled) and the pass totals beside it (a pass of more than 200 orders comes as `parts` events of 200, each with its `part` and the same totals); the e-mail and webhook carry the list, the feed keeps it 1 hour (then the totals only, with `orders_removed`); private to the alert's owner. Fill and liquidation alerts notify on every event; a wallet alert once per coin, action and side of each evaluator pass (about every 10 s): the fills merged into one event, `fills` their count, min_value_usd applied to the merged total. Bias and proximity alerts notify once per crossing and re-arm after the value retreats by `band`. POLYMARKET (leave out chain, address, address_role, max_value_usd and token_symbol): pm_wallet_trade = every trade of the proxy `wallet` (required), optionally in one `condition_id` and above min_value_usd; pm_market_trade = every trade in `condition_id` (required) at or above min_value_usd (REQUIRED, >= 1000); pm_price_move = a move of 0.05 or more within 5 minutes in the price of the market's first outcome (Yes), filtered by `direction`; pm_resolution = the market resolved. Each notifies on every event. cooldown_minutes does not apply to Hyperliquid or Polymarket alerts. They are delivered by a webhook channel (register one with alerts_register_webhook) and/or e-mail, or only read with alerts_events (channels left empty); `channels` = ['email'] mails the account address: one mail per evaluator pass listing its events, and (but for hl_wallet) none after the alert's 10th event of the UTC day. `label` is the user-visible name. `channels` = ['email'], ['webhook'] or both (Discord is temporarily off and is refused). One address and one chain per transfer alert: create several alerts to watch more. Returns the new alert row including its id, its `policy` and, for a Hyperliquid or Polymarket alert, an `hl` or `pm` object.",
"inputSchema": {
"type": "object",
"required": [
"label"
],
"properties": {
"band": {
"type": [
"number",
"string"
],
"description": "hl_cohort_bias and hl_liq_proximity: hysteresis, greater than 0 (default 0.1). A bias alert fires when the index reaches threshold + band (up) or threshold - band (down); a proximity alert fires when the ratio reaches threshold and re-arms below threshold - band."
},
"side": {
"enum": [
"buy",
"sell"
],
"type": "string",
"description": "hl_wallet_orders only: only buy or only sell orders. Leave out for both."
},
"chain": {
"enum": [
"eth",
"bsc",
"base",
"hyperevm"
],
"type": "string",
"description": "Transfer alerts only: the chain to watch (single value). Default: eth. Ask the user to create two alerts if they want both chains. Leave out for Hyperliquid alerts."
},
"index": {
"enum": [
"smi",
"wsi",
"smart_bias",
"whale_bias",
"smi_wsi_gap"
],
"type": "string",
"description": "hl_cohort_bias only, required: the index watched for token_symbol. smi = long share of smart wallets minus long share of rekt wallets; wsi = long share of whales minus long share of shrimp; smart_bias / whale_bias = (long - short) / (long + short) of that cohort; smi_wsi_gap = smi - wsi. Ratios run -1..1 (smi_wsi_gap -2..2)."
},
"label": {
"type": "string",
"description": "Name for this alert (e.g. 'Big USDC moves')"
},
"events": {
"type": "array",
"items": {
"enum": [
"placed",
"gone"
],
"type": "string"
},
"description": "hl_wallet_orders only: placed = a new order appeared in the book, gone = an order left it (its outcome filled, partially_filled or canceled comes from the order's own fills). Default both. Each check's orders arrive together, as one event."
},
"wallet": {
"type": "string",
"description": "One 0x + 40-hex address. Hyperliquid: the account to watch, required for hl_wallet, hl_wallet_orders and hl_liq_proximity, optional for hl_liquidation. Polymarket: the proxy wallet (the address of its vike.io/polymarket/wallet page and of polymarket_tape rows), required for pm_wallet_trade."
},
"actions": {
"type": "array",
"items": {
"enum": [
"open",
"close",
"flip",
"increase",
"reduce"
],
"type": "string"
},
"description": "hl_wallet only: which fills notify. Default: open, close, flip, increase ('add' is accepted for increase); reduce is opt-in."
},
"address": {
"type": "string",
"description": "Transfer alerts only: wallet to watch, one 0x + 40-hex EVM address. Matches transfers (native or token) the address sent or received on `chain`, per address_role."
},
"channels": {
"type": "array",
"items": {
"enum": [
"email",
"webhook"
],
"type": "string"
},
"description": "Which kinds of the user's enabled channels to notify. email: any alert (a Hyperliquid or Polymarket alert mails the account address). webhook: any alert (register one with alerts_register_webhook; asking for a Hyperliquid or Polymarket alert's webhook the user has not registered is an error). Discord is temporarily off and is refused, as is any other type. A kind the user has no enabled channel of is dropped from a transfer alert, and a transfer alert left with no channel e-mails the account address: call alerts_list_channels to see what is set up. Whatever the channels, every match is recorded as an event in the feed read with alerts_events (kept 15 days), so leave channels empty for a Hyperliquid or Polymarket alert you will only read there."
},
"direction": {
"enum": [
"up",
"down",
"both"
],
"type": "string",
"description": "hl_cohort_bias: which crossings notify. pm_price_move: which moves of the market's first outcome (Yes on a yes/no market) notify. Default both."
},
"threshold": {
"type": [
"number",
"string"
],
"description": "hl_cohort_bias: the index level to cross (default 0). hl_liq_proximity: the share of the way from entry price to liquidation price, strictly between 0 and 1 (default 0.8)."
},
"alert_type": {
"enum": [
"transfer",
"hl_wallet",
"hl_cohort_bias",
"hl_cohort_fill",
"hl_liquidation",
"hl_liq_proximity",
"hl_wallet_orders",
"pm_wallet_trade",
"pm_market_trade",
"pm_price_move",
"pm_resolution"
],
"type": "string",
"default": "transfer",
"description": "transfer (default), a Hyperliquid type (hl_wallet, hl_cohort_fill, hl_liquidation, hl_cohort_bias, hl_liq_proximity, hl_wallet_orders) or a Polymarket type (pm_wallet_trade, pm_market_trade, pm_price_move, pm_resolution). Fixed once created."
},
"min_amount": {
"type": [
"number",
"string"
],
"description": "Transfer alerts only, with token_symbol: alert when the transfer moves at least this many WHOLE tokens (1000000 USDT, 0.5 ETH), whether or not it carries a USD value. With min_value_usd or max_value_usd as well, both must hold. A token whose decimals are unknown never matches it."
},
"pnl_cohorts": {
"type": "array",
"items": {
"enum": [
"3x smart",
"2x smart",
"smart",
"3x winner",
"2x winner",
"winner",
"loser",
"2x loser",
"3x loser",
"rekt",
"2x rekt",
"3x rekt"
],
"type": "string"
},
"description": "hl_cohort_fill and hl_liquidation: only wallets in these realised-PnL cohorts (the ladder runs from '3x smart' = top 1% to '3x rekt' = bottom 5%). hl_cohort_fill REQUIRES at least one PnL or size cohort; for hl_liquidation empty = any cohort."
},
"address_role": {
"enum": [
"any",
"from",
"to"
],
"type": "string",
"description": "Transfer alerts only: any = sent or received (default), from = only transfers the address sent, to = only transfers it received. Needs `address`."
},
"condition_id": {
"type": "string",
"description": "Polymarket only: the market, its 0x + 64-hex condition id. Required for pm_market_trade, pm_price_move and pm_resolution; optional for pm_wallet_trade (one market of that wallet)."
},
"size_cohorts": {
"type": "array",
"items": {
"enum": [
"4x whale",
"3x whale",
"2x whale",
"whale",
"2x shark",
"shark",
"2x dolphin",
"dolphin",
"2x fish",
"fish",
"2x shrimp",
"shrimp"
],
"type": "string"
},
"description": "hl_cohort_fill and hl_liquidation: only wallets in these account-size cohorts (the ladder runs from '4x whale' = $10M+ to 'shrimp' = under $1k). hl_cohort_fill REQUIRES at least one PnL or size cohort; for hl_liquidation empty = any size."
},
"token_symbol": {
"type": "string",
"description": "Transfer: token ticker in UPPERCASE (e.g. USDC, ETH, PEPE). Hyperliquid: the perp coin as Hyperliquid names it (BTC, kPEPE, xyz:CL); required for hl_cohort_bias, optional for the rest (omit = every coin)."
},
"max_value_usd": {
"type": [
"number",
"string"
],
"description": "Transfer alerts only: an upper bound on the transfer's USD value. A transfer worth more than this does not notify (one worth exactly this does). Like min_value_usd it needs a transfer that already carries a USD value, so an unpriced transfer never matches a rule with a bound. Keep it at or above min_value_usd: a rule whose minimum is above its maximum never fires."
},
"min_value_usd": {
"type": [
"number",
"string"
],
"description": "Transfer: alert when transfer USD value >= this. Hyperliquid: a floor on the fill or liquidation size in USD (hl_wallet, hl_liquidation); required and >= 10000 for hl_cohort_fill; the order's size x price for hl_wallet_orders (>= 1000, default 10000); not used by hl_cohort_bias or hl_liq_proximity. Polymarket: a floor on the trade's USD (size x price) for pm_wallet_trade; required and >= 1000 for pm_market_trade."
},
"cooldown_minutes": {
"type": [
"integer",
"string"
],
"default": 60,
"description": "Token-wide transfer alerts (no address): minimum gap between notifications. Default 60. Address alerts and Hyperliquid and Polymarket alerts notify on every event and ignore it."
}
}
},
"annotations": {
"title": "Alerts Create",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}| wallet | string | One 0x + 40-hex address. Hyperliquid: the account to watch, required for hl_wallet, hl_wallet_orders and hl_liq_proximity, optional for hl_liquidation. Polymarket: the proxy wallet (the address of its vike.io/polymarket/wallet page and of polymarket_tape rows), required for pm_wallet_trade. |
| actions | array | hl_wallet only: which fills notify. Default: open, close, flip, increase ('add' is accepted for increase); reduce is opt-in. |
| address | string | 0x + 40-hex EVM address; '' removes the wallet condition. |
| alert_id * | ["integer","string"] | The alert ID (from alerts_list). |
| channels | array |
| direction | string | hl_cohort_bias: which crossings notify. pm_price_move: which moves of the market's first outcome (Yes on a yes/no market) notify. Default both. |
| is_active | ["boolean","string"] |
| threshold | ["number","string"] | hl_cohort_bias: the index level to cross (default 0). hl_liq_proximity: the share of the way from entry price to liquidation price, strictly between 0 and 1 (default 0.8). |
| min_amount | ["number","string"] | Whole tokens of token_symbol; '' or 0 removes the amount floor. |
| pnl_cohorts | array | hl_cohort_fill and hl_liquidation: only wallets in these realised-PnL cohorts (the ladder runs from '3x smart' = top 1% to '3x rekt' = bottom 5%). hl_cohort_fill REQUIRES at least one PnL or size cohort; for hl_liquidation empty = any cohort. |
| address_role | string | one of ["any","from","to"] |
| condition_id | string | Polymarket only: the market, its 0x + 64-hex condition id. Required for pm_market_trade, pm_price_move and pm_resolution; optional for pm_wallet_trade (one market of that wallet). |
| size_cohorts | array | hl_cohort_fill and hl_liquidation: only wallets in these account-size cohorts (the ladder runs from '4x whale' = $10M+ to 'shrimp' = under $1k). hl_cohort_fill REQUIRES at least one PnL or size cohort; for hl_liquidation empty = any size. |
| token_symbol | string |
| max_value_usd | ["number","string"] |
| min_value_usd | ["number","string"] |
| cooldown_minutes | ["integer","string"] |
{
"name": "alerts_edit",
"title": "Alerts Edit",
"description": "Partial update of one of the user's alerts. Only the fields you pass are modified; pass alert_id to identify which one (get it from alerts_list). Use is_active=false to pause an alert without deleting it. `address` replaces the alert's wallet condition (one per alert; same rules as alerts_create); address='' removes it; `address_role` alone moves the existing address to that side. The fields mean what they mean in alerts_create, and a Hyperliquid alert (its type cannot change) is re-validated whole after the edit: '' or [] clears an optional field such as token_symbol or pnl_cohorts, and a field its type does not use is an error. `channels` replaces the list (email or webhook; Discord is off); [] leaves a Hyperliquid or Polymarket alert feed-only, read with alerts_events.",
"inputSchema": {
"type": "object",
"required": [
"alert_id"
],
"properties": {
"band": {
"type": [
"number",
"string"
],
"description": "hl_cohort_bias and hl_liq_proximity: hysteresis, greater than 0 (default 0.1). A bias alert fires when the index reaches threshold + band (up) or threshold - band (down); a proximity alert fires when the ratio reaches threshold and re-arms below threshold - band."
},
"side": {
"enum": [
"buy",
"sell"
],
"type": "string",
"description": "hl_wallet_orders only: only buy or only sell orders. Leave out for both."
},
"chain": {
"type": "string"
},
"index": {
"enum": [
"smi",
"wsi",
"smart_bias",
"whale_bias",
"smi_wsi_gap"
],
"type": "string",
"description": "hl_cohort_bias only, required: the index watched for token_symbol. smi = long share of smart wallets minus long share of rekt wallets; wsi = long share of whales minus long share of shrimp; smart_bias / whale_bias = (long - short) / (long + short) of that cohort; smi_wsi_gap = smi - wsi. Ratios run -1..1 (smi_wsi_gap -2..2)."
},
"label": {
"type": "string"
},
"events": {
"type": "array",
"items": {
"enum": [
"placed",
"gone"
],
"type": "string"
},
"description": "hl_wallet_orders only: placed = a new order appeared in the book, gone = an order left it (its outcome filled, partially_filled or canceled comes from the order's own fills). Default both. Each check's orders arrive together, as one event."
},
"wallet": {
"type": "string",
"description": "One 0x + 40-hex address. Hyperliquid: the account to watch, required for hl_wallet, hl_wallet_orders and hl_liq_proximity, optional for hl_liquidation. Polymarket: the proxy wallet (the address of its vike.io/polymarket/wallet page and of polymarket_tape rows), required for pm_wallet_trade."
},
"actions": {
"type": "array",
"items": {
"enum": [
"open",
"close",
"flip",
"increase",
"reduce"
],
"type": "string"
},
"description": "hl_wallet only: which fills notify. Default: open, close, flip, increase ('add' is accepted for increase); reduce is opt-in."
},
"address": {
"type": "string",
"description": "0x + 40-hex EVM address; '' removes the wallet condition."
},
"alert_id": {
"type": [
"integer",
"string"
],
"description": "The alert ID (from alerts_list)."
},
"channels": {
"type": "array",
"items": {
"enum": [
"email",
"webhook"
],
"type": "string"
}
},
"direction": {
"enum": [
"up",
"down",
"both"
],
"type": "string",
"description": "hl_cohort_bias: which crossings notify. pm_price_move: which moves of the market's first outcome (Yes on a yes/no market) notify. Default both."
},
"is_active": {
"type": [
"boolean",
"string"
]
},
"threshold": {
"type": [
"number",
"string"
],
"description": "hl_cohort_bias: the index level to cross (default 0). hl_liq_proximity: the share of the way from entry price to liquidation price, strictly between 0 and 1 (default 0.8)."
},
"min_amount": {
"type": [
"number",
"string"
],
"description": "Whole tokens of token_symbol; '' or 0 removes the amount floor."
},
"pnl_cohorts": {
"type": "array",
"items": {
"enum": [
"3x smart",
"2x smart",
"smart",
"3x winner",
"2x winner",
"winner",
"loser",
"2x loser",
"3x loser",
"rekt",
"2x rekt",
"3x rekt"
],
"type": "string"
},
"description": "hl_cohort_fill and hl_liquidation: only wallets in these realised-PnL cohorts (the ladder runs from '3x smart' = top 1% to '3x rekt' = bottom 5%). hl_cohort_fill REQUIRES at least one PnL or size cohort; for hl_liquidation empty = any cohort."
},
"address_role": {
"enum": [
"any",
"from",
"to"
],
"type": "string"
},
"condition_id": {
"type": "string",
"description": "Polymarket only: the market, its 0x + 64-hex condition id. Required for pm_market_trade, pm_price_move and pm_resolution; optional for pm_wallet_trade (one market of that wallet)."
},
"size_cohorts": {
"type": "array",
"items": {
"enum": [
"4x whale",
"3x whale",
"2x whale",
"whale",
"2x shark",
"shark",
"2x dolphin",
"dolphin",
"2x fish",
"fish",
"2x shrimp",
"shrimp"
],
"type": "string"
},
"description": "hl_cohort_fill and hl_liquidation: only wallets in these account-size cohorts (the ladder runs from '4x whale' = $10M+ to 'shrimp' = under $1k). hl_cohort_fill REQUIRES at least one PnL or size cohort; for hl_liquidation empty = any size."
},
"token_symbol": {
"type": "string"
},
"max_value_usd": {
"type": [
"number",
"string"
]
},
"min_value_usd": {
"type": [
"number",
"string"
]
},
"cooldown_minutes": {
"type": [
"integer",
"string"
]
}
}
},
"annotations": {
"title": "Alerts Edit",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}{
"name": "hl_perp_top_traders",
"title": "Hyperliquid Perp Top Traders",
"description": "Rank top Hyperliquid perp wallets by PnL / ROI / win rate / volume / trade count within a time window. Use for questions like 'top HL traders with win rate > 75%' or 'best HL perp wallets last 7d'. Data comes from the same pipeline that backs vike.io/hyperliquid/wallets. Use win_rate expressed as percent (0-100). roi_pct is window realized PnL over the CURRENT account value (a unified or portfolio-margin wallet's whole value, native + builder + USDC outside them; perp_account_value is the native perp account and account_mode default, unifiedAccount, portfolioMargin or disabled) and max_drawdown_pct is account-level and all-time (null when the wallet has too little equity history to say, and for unified and portfolio-margin wallets), both in percent (12.5 = 12.5%).",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"size": {
"type": [
"integer",
"string"
],
"default": 20,
"description": "Number of traders (default 20, max 100)"
},
"sort": {
"enum": [
"pnl",
"roi",
"win_rate",
"volume",
"trade_count",
"drawdown",
"account_value",
"long_pnl",
"short_pnl"
],
"type": "string",
"default": "pnl",
"description": "Sort metric (default pnl)"
},
"order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc",
"description": "Sort direction (default desc)"
},
"window": {
"enum": [
"1d",
"7d",
"30d",
"all"
],
"type": "string",
"default": "30d",
"description": "Time window (default 30d)"
},
"min_trades": {
"type": [
"integer",
"string"
],
"default": 3,
"description": "Minimum trade count (default 3)"
},
"min_volume": {
"type": [
"number",
"string"
],
"default": 0,
"description": "Minimum volume USD (default 0 = no filter)"
},
"min_win_rate": {
"type": [
"number",
"string"
],
"default": 0,
"description": "Minimum win rate as percent 0-100 (default 0 = no filter)"
}
}
},
"annotations": {
"title": "Hyperliquid Perp Top Traders",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "hl_position_match",
"title": "Hyperliquid Position Match",
"description": "Reverse-lookup a Hyperliquid open position from share-card details (symbol + side + leverage + entry price). Given the info shown on a HL trader's share card, return wallet(s) with matching open positions, ranked by entry-price proximity. Useful for 'whose share card is this?' or 'who has a 25x ETH long open at $3,200?'. Walks tight (±0.05%) -> loose (±0.5%) -> fallback (±1.0%) entry bands and requires leverage within ±0.5. Reads from the latest position snapshot (freshness-gated to the newest 15-minute window).",
"inputSchema": {
"type": "object",
"required": [
"symbol",
"side",
"leverage",
"entry_price"
],
"properties": {
"side": {
"enum": [
"long",
"short"
],
"type": "string",
"description": "Position side"
},
"limit": {
"type": [
"integer",
"string"
],
"default": 50,
"description": "Max matches to return (default 50, max 500)"
},
"symbol": {
"type": "string",
"description": "Asset symbol (e.g. BTC, ETH, SOL)"
},
"leverage": {
"type": [
"number",
"string"
],
"description": "Leverage from share card (e.g. 5, 10, 25); 0 finds positions with no leverage recorded"
},
"mark_price": {
"type": [
"number",
"string"
],
"description": "Optional current mark price; sharpens the tie-break when multiple wallets share the same entry."
},
"entry_price": {
"type": [
"number",
"string"
],
"description": "Entry price from share card"
}
}
},
"annotations": {
"title": "Hyperliquid Position Match",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| string |
| ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. The hour in progress is never returned. |
| cursor | string | Cursor over HOURS: `nextCursor` from the previous page, verbatim. |
| symbol * | string | Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. Required: an all-symbol matrix is refused. |
| grading | string | Which PnL grading labels each wallet (axis `pnl` or `pnl_unrealized` only): `realized` (default on `pnl`), `realized-pit` (a control rebuilt once a day through 23:00 of the last complete UTC day, so a recent window comes back 1 to 25 hours short; read `freshness.behind_hours`) or `unrealized`. For l… |
| include | string | Comma list of `volume`, `median_pnl`; default none. Adds to the NEWEST hour's rows `volume_24h_usd` (USD the cohort's wallets filled in this symbol in the last 24 hours; on `size` only wallets holding it now count; null if they filled nothing or the cohort is empty) and `median_realized_pnl_usd` (US… |
| label_basis | string | `point_in_time` returns each hour's cohort label AS IT WAS: use it for every backtest (axis=pnl). Every field is served while each hour of the page carries that label on its rows: every hour from 2026-08-06 09:00 UTC and most earlier ones. A page reaching an hour without it (all of April 2026, about… |
| opened_within | string | Only positions opened within this window BEFORE EACH HOUR (rolling per bucket, not relative to now): `24h`, `7d`, `30d` or `all`. Applied on `size`, `tier`, `pnl_abs` and `pnl` with the default label basis; REFUSED (anything but `all`) with `axis=pnl_unrealized`, `grading=unrealized` or `realized-pi… |
{
"name": "hl_cohort_metrics",
"title": "Hyperliquid Cohort Metrics",
"description": "Hourly long/short positioning of ONE Hyperliquid perp split by cohort: every bucket of one ladder, every hour, in one call (the matrix behind 'are whales / smart money long or short BTC'). `axis` picks the ladder: `size` (account value), `pnl` (percentile of cumulative realized PnL), `pnl_abs` (realized PnL in dollar bands), `pnl_unrealized` (currently onside), `tier` (each position's own notional). Data from 2026-04-07 (the first hour cohort labels are correct); an older `start` is served from there and the envelope says `data_from`. Rows are hour x cohort: `n_wallets` (wallets in the cohort holding the symbol), notional in USD (`total_position_value`, `total_position_value_long`) and `bias` = (long - short) / (long + short), a fraction from -1 (all short) to +1 (all long), not a percent. BACKTESTS: by default the `pnl` cohort is TODAY's grading applied to past hours (look-ahead); pass label_basis=point_in_time for each hour's label as it was, and read `label_computed` and `freshness` in the envelope. The hour in progress is never included. The response holds about `hours` x 12-13 rows: pass a small `hours` (1-24) for a current read and page older data with `cursor`. With `include` (`volume`, `median_pnl`; `size` or `pnl` axis) the newest hour's rows also carry each cohort's 24-hour fill volume and the median realized PnL of its wallets, in USD, computed at request time. Same data as GET /v1/hl-cohorts/symbols/{symbol}/cohort-metrics.",
"inputSchema": {
"type": "object",
"required": [
"symbol"
],
"properties": {
"end": {
"type": "string",
"description": "ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z."
},
"axis": {
"enum": [
"size",
"pnl",
"pnl_abs",
"tier",
"trade_size",
"pnl_unrealized"
],
"type": "string",
"default": "size",
"description": "Ladder to split by: `size` (account value), `pnl` (percentile of cumulative realized PnL), `pnl_abs` (realized PnL in dollar bands), `tier` (each position's own notional bucket; `trade_size` is an alias of it), `pnl_unrealized` (currently onside)."
},
"hours": {
"type": [
"integer",
"string"
],
"default": 168,
"maximum": 8760,
"description": "Number of hourly buckets, newest first; the response holds about this many x 12-13 cohort rows. Pass 1-24 for a current read. Max 8760."
},
"start": {
"type": "string",
"description": "ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. The hour in progress is never returned."
},
"cursor": {
"type": "string",
"description": "Cursor over HOURS: `nextCursor` from the previous page, verbatim."
},
"symbol": {
"type": "string",
"description": "Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. Required: an all-symbol matrix is refused."
},
"grading": {
"enum": [
"realized",
"realized-pit",
"unrealized"
],
"type": "string",
"description": "Which PnL grading labels each wallet (axis `pnl` or `pnl_unrealized` only): `realized` (default on `pnl`), `realized-pit` (a control rebuilt once a day through 23:00 of the last complete UTC day, so a recent window comes back 1 to 25 hours short; read `freshness.behind_hours`) or `unrealized`. For live trading use `realized` with label_basis=point_in_time."
},
"include": {
"type": "string",
"description": "Comma list of `volume`, `median_pnl`; default none. Adds to the NEWEST hour's rows `volume_24h_usd` (USD the cohort's wallets filled in this symbol in the last 24 hours; on `size` only wallets holding it now count; null if they filled nothing or the cohort is empty) and `median_realized_pnl_usd` (USD, median cumulative realized PnL over the DISTINCT wallets holding the symbol now; null if none does). The median is a sampled quantile: exact up to 8,192 wallets in a cohort, an estimate above it; the asset page's pnl-axis \"Med Lifetime\" counts positions rather than wallets, so it can differ slightly. Both are current figures, not that hour's, and null on `unknown`. Only `axis=size` or `axis=pnl` with the default grading; refused with opened_within, cursor or a past `end`."
},
"label_basis": {
"enum": [
"current",
"point_in_time"
],
"type": "string",
"description": "`point_in_time` returns each hour's cohort label AS IT WAS: use it for every backtest (axis=pnl). Every field is served while each hour of the page carries that label on its rows: every hour from 2026-08-06 09:00 UTC and most earlier ones. A page reaching an hour without it (all of April 2026, about 365 hours from May to 2026-08-06 08:00) comes from the hourly aggregate, where position_count*, total_unrealized_pnl and total_position_size* are null, named in `unavailable_fields`. Without it a `pnl` cohort is TODAY's grading applied to past hours (look-ahead). `size`, `tier` and `pnl_unrealized` are always point-in-time; `pnl_abs` is always today's bands (look-ahead, never for a backtest); a conflicting value is refused."
},
"opened_within": {
"enum": [
"24h",
"7d",
"30d",
"all"
],
"type": "string",
"default": "all",
"description": "Only positions opened within this window BEFORE EACH HOUR (rolling per bucket, not relative to now): `24h`, `7d`, `30d` or `all`. Applied on `size`, `tier`, `pnl_abs` and `pnl` with the default label basis; REFUSED (anything but `all`) with `axis=pnl_unrealized`, `grading=unrealized` or `realized-pit`, and `label_basis=point_in_time`, whose stored sources sum position age away."
}
}
},
"annotations": {
"title": "Hyperliquid Cohort Metrics",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| end | string | ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z. `history` only: with no `start`, the window is the `hours` newest hours at or before it. Used by view: history. |
| axis | string | Cohort ladder: `size` = account-value tiers in USD, `pnl` = percentile rank of cumulative realized PnL (NOT dollars), `pnl_abs` = dollar bands of that same PnL. Per-position `trade_size` / `tier` is refused here. `history` serves history for `size` and `pnl` only, and requires `axis`. Default by vie… |
| view | string | What to read. `segments`: the catalogue of every cohort bucket with its bounds and what the ladder measures. `cohorts`: the flat label sets, i.e. the exact spellings every `cohort` parameter accepts. `summary`: what ONE cohort holds right now across all symbols. `heatmap`: the whole symbol x cohort … |
| hours | ["integer","string"] | `history` only: window length in hours when `start` is omitted, ending at `end` or now. Max 8760. Used by view: history. |
| limit | ["integer","string"] | `history` only: max hourly rows, newest first; `has_more` says older ones exist, page back with `end` = the oldest `ts` minus 1 second. Max 5000. Used by view: history. |
| start | string | ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. `history` only; hours before 2026-04-07 are never returned. Used by view: history. |
| cohort | string | One label on `axis`, spelled exactly as `hl_segments` view=cohorts lists it, e.g. `whale` (size) or `3x smart` (pnl). Used by view: summary, history. Required by view: summary, history. |
| include | string | `history` only: comma list, only `leverage`; default none (nothing extra is read). Adds to every hourly row `perp_bias` = (long - short) / equity, `equity_exposure` = (long + short) / equity and `equity_covered_share` = main-dex notional of the counted wallets / main-dex notional of the whole cohort… |
| opened_within | string | Only positions opened within this window: `24h`, `7d`, `30d` or `all`; positions with no known open time are left out of every bounded window. Used by view: summary, heatmap. |
{
"name": "hl_segments",
"title": "Hyperliquid Segments",
"description": "The Hyperliquid cohort vocabulary and its latest-snapshot positioning, by `view`. `cohorts`: the label sets per ladder, the exact spellings every `cohort` parameter accepts. `segments`: the catalogue with bounds, ranks and what each ladder measures (`size` is account value in USD; `pnl` is a percentile rank of cumulative realized PnL, not dollars; `pnl_abs` is dollars). `summary`: everything ONE cohort holds right now across all symbols: long/short notional in USD, `bias` a fraction from -1 to +1, `pct_wallets_in_profit` a FRACTION from 0 to 1 despite its name, `exposure_ratio` = notional / margin used, `perp_bias` = (long - short) / equity and `equity_exposure` = (long + short) / equity: positions on the main dex over the native perp account value, plus for a unified or portfolio-margin wallet the USDC it holds outside it (each wallet once, the whole account even under `opened_within`); builder-DEX positions are not included; wallets without a known positive equity are left out of perp_bias, equity_exposure and this share's numerator, see `equity_covered_share` (main-dex notional of the counted wallets / of the whole cohort). Unbounded ratios (above 1 = over 1x; null when equity <= 0); that equity is not `total_equity`, so perp_bias x total_equity != total_long_usd - total_short_usd. `heatmap`: the whole symbol x cohort board (large: every symbol with open interest; empty cells are omitted). Positions are the latest 5-minute snapshot. `history`: ONE cohort (`cohort` + `axis`, both required; `axis` is `size` or `pnl` only) hour by hour, summed over all symbols, newest first, from 2026-04-07: `long_usd` and `short_usd` in USD, `bias` = (long - short) / (long + short), a RATIO from -1 to +1 (null when both are 0), `position_count` = open positions, NOT wallets. Each hour carries the cohort label it had then (`label_basis` is `point_in_time`; `pnl` labels are daily before 2026-08-06, see `label_computed`). `hours` sizes the window, `limit` caps the rows, `has_more` says older rows exist. With `include=leverage` each hour also carries `perp_bias`, `equity_exposure` and `equity_covered_share`, the three `summary` ratios of that hour (null before 2026-08-11 and for a missing hour; `perp_bias` and `equity_exposure` are also null where no wallet has a known positive equity, and `equity_covered_share` is 0 when none is counted). An unknown cohort for the axis is an error. Same data as GET /v1/hl-cohorts/{cohorts, segments, segments/{cohort}/summary, heatmap, segments/{cohort}/history}.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"end": {
"type": "string",
"description": "ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z. `history` only: with no `start`, the window is the `hours` newest hours at or before it. Used by view: history."
},
"axis": {
"enum": [
"size",
"pnl",
"pnl_abs"
],
"type": "string",
"description": "Cohort ladder: `size` = account-value tiers in USD, `pnl` = percentile rank of cumulative realized PnL (NOT dollars), `pnl_abs` = dollar bands of that same PnL. Per-position `trade_size` / `tier` is refused here. `history` serves history for `size` and `pnl` only, and requires `axis`. Default by view: summary size, heatmap size. Used by view: summary, heatmap, history. Required by view: history."
},
"view": {
"enum": [
"segments",
"cohorts",
"summary",
"heatmap",
"history"
],
"type": "string",
"default": "segments",
"description": "What to read. `segments`: the catalogue of every cohort bucket with its bounds and what the ladder measures. `cohorts`: the flat label sets, i.e. the exact spellings every `cohort` parameter accepts. `summary`: what ONE cohort holds right now across all symbols. `heatmap`: the whole symbol x cohort board at the latest snapshot. `history`: ONE cohort's hourly long, short and bias summed over all symbols, newest first (axis size or pnl only). Default `segments`."
},
"hours": {
"type": [
"integer",
"string"
],
"default": 168,
"maximum": 8760,
"description": "`history` only: window length in hours when `start` is omitted, ending at `end` or now. Max 8760. Used by view: history."
},
"limit": {
"type": [
"integer",
"string"
],
"default": 5000,
"maximum": 5000,
"description": "`history` only: max hourly rows, newest first; `has_more` says older ones exist, page back with `end` = the oldest `ts` minus 1 second. Max 5000. Used by view: history."
},
"start": {
"type": "string",
"description": "ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. `history` only; hours before 2026-04-07 are never returned. Used by view: history."
},
"cohort": {
"type": "string",
"description": "One label on `axis`, spelled exactly as `hl_segments` view=cohorts lists it, e.g. `whale` (size) or `3x smart` (pnl). Used by view: summary, history. Required by view: summary, history."
},
"include": {
"type": "string",
"description": "`history` only: comma list, only `leverage`; default none (nothing extra is read). Adds to every hourly row `perp_bias` = (long - short) / equity, `equity_exposure` = (long + short) / equity and `equity_covered_share` = main-dex notional of the counted wallets / main-dex notional of the whole cohort: unbounded ratios (above 1 = more than 1x of equity), main-dex positions of wallets with a known positive equity, each wallet once, over that equity: the native perp account, plus from the 2026-11-07 20:00 UTC hour on the USDC a unified or portfolio-margin wallet holds outside it (earlier hours stay native, so the two ratios step down there); builder-DEX positions are not included. An hour with no stored row, and any hour before `leverage.data_from` (2026-08-11), is null on all three (never 0). `perp_bias` and `equity_exposure` are also null when no counted wallet has a positive equity; `equity_covered_share` is null when the cohort holds no main-dex notional and a real 0 when it holds some but no wallet is counted. Hours rebuilt from fills rather than read from snapshots are null. An unknown token is refused. Used by view: history."
},
"opened_within": {
"enum": [
"24h",
"7d",
"30d",
"all"
],
"type": "string",
"default": "all",
"description": "Only positions opened within this window: `24h`, `7d`, `30d` or `all`; positions with no known open time are left out of every bounded window. Used by view: summary, heatmap."
}
}
},
"annotations": {
"title": "Hyperliquid Segments",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| Bounds the open-positions block ONLY (equity, lifetime and metrics are wallet-level totals with nothing per-position to filter): `24h`, `7d`, `30d` or `all`. Used by view: summary. |
{
"name": "hl_wallet",
"title": "Hyperliquid Wallet",
"description": "One Hyperliquid wallet, by `view`. `summary`: live equity, open positions, both cohort labels, the risk metrics of the window (`win_rate` is a FRACTION from 0 to 1; `max_drawdown_pct` and `pnl_pct` are percents, `pnl_pct` is null under $1 of equity), cumulative realized PnL since inception and lifetime deposits and withdrawals, all money in USD; `equity.account_value` is the wallet's whole value in the venue's unified and portfolio-margin modes (native perp account + builder accounts + USDC outside them, free spot tokens left out; those modes also read null on the drawdown fields), else the native perp account; `equity.perp_account_value` is always the native perp account and `equity.account_mode` is `default`, `unifiedAccount`, `portfolioMargin` or `disabled`; `open_positions.perp_bias` = (long - short) / `equity.perp_account_value` and `equity_exposure` = (long + short) / it, native perp account only: positions on the main dex over the native perp account value; builder-DEX positions are not included. Unbounded ratios, null with no main-dex position or no positive equity. `trades_summary`: closed round-trip trade statistics overall and per symbol, medians as well as means. An address we hold nothing for (`summary`) or that never traded (`trades_summary`) is an error, never a block of zeros. Find addresses with hl_leaderboard, hl_perp_top_traders or hl_position_match. Same data as GET /v1/hyperliquid/wallets/{address} and /wallets/{address}/trades/summary.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"view": {
"enum": [
"summary",
"trades_summary"
],
"type": "string",
"default": "summary",
"description": "What to read. `summary`: equity, open positions, cohort labels, risk metrics and lifetime flow. `trades_summary`: closed-trade statistics overall and per symbol. Default `summary`."
},
"window": {
"enum": [
"1d",
"7d",
"30d",
"all"
],
"type": "string",
"default": "all",
"description": "Window of the risk metrics and trade statistics, by trade time: `1d`, `7d`, `30d` or `all`."
},
"address": {
"type": "string",
"description": "Hyperliquid wallet address: 0x followed by 40 hex characters, any case. Required."
},
"opened_within": {
"enum": [
"24h",
"7d",
"30d",
"all"
],
"type": "string",
"default": "all",
"description": "Bounds the open-positions block ONLY (equity, lifetime and metrics are wallet-level totals with nothing per-position to filter): `24h`, `7d`, `30d` or `all`. Used by view: summary."
}
}
},
"annotations": {
"title": "Hyperliquid Wallet",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| symbol | string | Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. Omit for all symbols. Used by view: fills, funding. |
| window | string | Window of the builder-routed flow: `1d`, `7d`, `30d` or `all`. Used by view: builders. |
| address | string | Hyperliquid wallet address: 0x followed by 40 hex characters, any case. Required. |
| event_type | string | One ledger event type; an unknown value is refused, not answered with an empty list. Used by view: ledger. |
{
"name": "hl_wallet_activity",
"title": "Hyperliquid Wallet Activity",
"description": "A Hyperliquid wallet's event history, by `view`. `fills`: raw fills, newest first (`size_usd`, `closed_pnl` in USD; `fee` is in its own `fee_token`). `funding`: funding payments, `payment_usd` signed from the wallet's side (negative = the wallet PAID). `ledger`: deposits, withdrawals, transfers and vault events with `amount_usd`. `builders`: the builder codes the wallet's flow is routed through, by volume (`share_of_volume` is of its builder-routed volume only, not of all its trading). Keyset-paged: pass `nextCursor` back; it is null on the last page. Same data as GET /v1/hyperliquid/wallets/{address}/{fills, funding, ledger, builders}.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"end": {
"type": "string",
"description": "ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z. Used by view: fills, funding, ledger."
},
"side": {
"enum": [
"buy",
"sell"
],
"type": "string",
"description": "`buy` or `sell`. Omit for both. Used by view: fills."
},
"view": {
"enum": [
"fills",
"funding",
"ledger",
"builders"
],
"type": "string",
"default": "fills",
"description": "What to read. `fills`: raw fills, newest first. `funding`: funding paid and received, newest first. `ledger`: deposits, withdrawals, transfers and vault events, newest first. `builders`: which builder codes the wallet's flow is routed through, by volume. Default `fills`."
},
"limit": {
"type": [
"integer",
"string"
],
"description": "Rows per page, newest first. Default by view: fills 100, funding 100, ledger 100, builders 50. Max by view: fills 5000, funding 5000, ledger 5000, builders 500."
},
"start": {
"type": "string",
"description": "ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. Used by view: fills, funding, ledger."
},
"cursor": {
"type": "string",
"description": "`nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page."
},
"symbol": {
"type": "string",
"description": "Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. Omit for all symbols. Used by view: fills, funding."
},
"window": {
"enum": [
"1d",
"7d",
"30d",
"all"
],
"type": "string",
"default": "all",
"description": "Window of the builder-routed flow: `1d`, `7d`, `30d` or `all`. Used by view: builders."
},
"address": {
"type": "string",
"description": "Hyperliquid wallet address: 0x followed by 40 hex characters, any case. Required."
},
"event_type": {
"enum": [
"deposit",
"withdraw",
"send",
"spotTransfer",
"internalTransfer",
"subAccountTransfer",
"accountClassTransfer",
"vaultDeposit",
"vaultWithdraw",
"vaultCreate",
"vaultDistribution",
"vaultLeaderCommission",
"borrowLend",
"rewardsClaim"
],
"type": "string",
"description": "One ledger event type; an unknown value is refused, not answered with an empty list. Used by view: ledger."
}
}
},
"annotations": {
"title": "Hyperliquid Wallet Activity",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| ["integer","string"] |
| Rows per page. Max 500. |
| order | string | `desc` (best first) or `asc`. Used by view: ranking. |
| cohort | string | One label on `axis`, spelled exactly as `hl_segments` view=cohorts lists it, e.g. `whale` (size) or `3x smart` (pnl). Omit for no cohort filter. Used by view: ranking. |
| cursor | string | `nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. Resend the same window / sort / order / axis / cohort with it. |
| window | string | Window: `1d`, `7d`, `30d` or `all`. The trades CLOSED in the current UTC day and the 1, 7, 30 or 365 days before it: PnL, trade counts, win rates and tags are what was realized in it. |
| min_trades | ["integer","string"] | Minimum closed trades in the window. Default 3, the floor hl_perp_top_traders applies; pass 0 for no floor (view `flow_adjusted` then still needs at least one). |
| min_volume | ["number","string"] | Minimum total volume in USD. Used by view: ranking. |
| min_win_rate | ["number","string"] | Minimum win rate as a FRACTION from 0 to 1 (0.6 = 60%), compared with the `win_rate` the rows show; 60 is refused, not read as 60%. hl_perp_top_traders takes a percent instead. Max 1. Used by view: ranking. |
{
"name": "hl_leaderboard",
"title": "Hyperliquid Leaderboard",
"description": "Rank Hyperliquid wallets with the full risk set, by `view`. `ranking`: precomputed per-window metrics sorted on any of 20 keys (PnL, ROI, win rate, Calmar, profit factor, drawdown, streaks, ...), filtered by cohort and by minimum trades / win rate / volume, cursor-paged. A window is what was REALIZED in it (the trades closed in it) and a wallet needs 3 closed trades in it unless `min_trades` says otherwise (0 = no floor). `flow_adjusted`: ranks FILLS-DERIVED realized trading PnL, which excludes deposits by construction, with deposits, withdrawals and daily attribution returned beside it, both of the NATIVE perp account only (`flow_unbalanced` marks rows whose attributed block is off the fills; `attributed` and `flow_unbalanced` are null for a wallet now in unified or portfolio-margin mode, whose native account follows margin). `account_value` and `roi` use the wallet's whole value in those two modes, which read null on the drawdown fields; `perp_account_value` and `account_mode` show the native account and the mode. UNITS differ from hl_perp_top_traders: here `win_rate` and `min_win_rate` are FRACTIONS (0.6 = 60%), there percents; `max_drawdown_pct` and `pnl_pct` are percents, and `pnl_pct` is null under $1 of equity (prefer it to the raw `roi`); money is USD. Same data as GET /v1/hyperliquid/leaderboard and /leaderboard/flow-adjusted.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"axis": {
"enum": [
"size",
"pnl",
"pnl_abs"
],
"type": "string",
"default": "size",
"description": "Cohort ladder: `size` = account-value tiers in USD, `pnl` = percentile rank of cumulative realized PnL (NOT dollars), `pnl_abs` = dollar bands of that same PnL. Selects the ladder `cohort` filters on. Used by view: ranking."
},
"sort": {
"enum": [
"pnl",
"realized_pnl",
"roi",
"volume",
"trades",
"win_rate",
"long_win_rate",
"short_win_rate",
"account_value",
"profit_factor",
"expectancy",
"calmar",
"recovery_factor",
"max_drawdown",
"current_drawdown",
"avg_leverage",
"avg_duration",
"fees",
"win_streak",
"loss_streak"
],
"type": "string",
"default": "pnl",
"description": "Ranking metric; an unknown key is refused, never replaced by a default. Used by view: ranking."
},
"view": {
"enum": [
"ranking",
"flow_adjusted"
],
"type": "string",
"default": "ranking",
"description": "What to read. `ranking`: traders ranked on any of 20 metrics with the full risk set. `flow_adjusted`: traders ranked on fills-derived trading PnL, deposits reported beside it. Default `ranking`."
},
"limit": {
"type": [
"integer",
"string"
],
"default": 25,
"maximum": 500,
"description": "Rows per page. Max 500."
},
"order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc",
"description": "`desc` (best first) or `asc`. Used by view: ranking."
},
"cohort": {
"type": "string",
"description": "One label on `axis`, spelled exactly as `hl_segments` view=cohorts lists it, e.g. `whale` (size) or `3x smart` (pnl). Omit for no cohort filter. Used by view: ranking."
},
"cursor": {
"type": "string",
"description": "`nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. Resend the same window / sort / order / axis / cohort with it."
},
"window": {
"enum": [
"1d",
"7d",
"30d",
"all"
],
"type": "string",
"default": "30d",
"description": "Window: `1d`, `7d`, `30d` or `all`. The trades CLOSED in the current UTC day and the 1, 7, 30 or 365 days before it: PnL, trade counts, win rates and tags are what was realized in it."
},
"min_trades": {
"type": [
"integer",
"string"
],
"default": 3,
"description": "Minimum closed trades in the window. Default 3, the floor hl_perp_top_traders applies; pass 0 for no floor (view `flow_adjusted` then still needs at least one)."
},
"min_volume": {
"type": [
"number",
"string"
],
"default": 0,
"description": "Minimum total volume in USD. Used by view: ranking."
},
"min_win_rate": {
"type": [
"number",
"string"
],
"default": 0,
"maximum": 1,
"description": "Minimum win rate as a FRACTION from 0 to 1 (0.6 = 60%), compared with the `win_rate` the rows show; 60 is refused, not read as 60%. hl_perp_top_traders takes a percent instead. Max 1. Used by view: ranking."
}
}
},
"annotations": {
"title": "Hyperliquid Leaderboard",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| limit | ["integer","string"] | Rows per page, newest first. Max by view: fills 5000, risk 500. Used by view: fills, risk. |
| start | string | ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. Used by view: fills. |
| cohort | string | One label on `axis`, spelled exactly as `hl_segments` view=cohorts lists it, e.g. `whale` (size) or `3x smart` (pnl). Omit for all wallets. Used by view: risk. |
| cursor | string | `nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. Used by view: fills. |
| symbol | string | Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. Used by view: fills, heatmap. Required by view: heatmap. |
| wallet | string | One wallet, to ask whether it has been liquidated. Used by view: fills. |
| direction | string | The side of the position that was CLOSED: `long` = longs liquidated (price fell), `short` = shorts liquidated. Used by view: fills. |
| min_value_usd | ["number","string"] | `risk` only: smallest total open notional in USD a symbol needs to be ranked. Default 0 (no floor), so thin micro-cap markets can lead; raise it to keep only markets big enough for a cascade to matter. Used by view: risk. |
{
"name": "hl_liquidations",
"title": "Hyperliquid Liquidations",
"description": "Hyperliquid liquidations, by `view`. `fills`: liquidation events, newest first, filtered by symbol, wallet, side and time. Since 2026-08-03 rows are EXACT, the liquidated wallet's own fill from the node (`liq_ts` the fill's millisecond, sizes what it closed, `mark_price` the venue's mark); older rows are INFERRED from ~5-minute position snapshots (a position over $100 whose mark was within 5% of its liquidation price and which is gone from the next snapshot; `liq_ts` is that snapshot's time and size/mark are the last values seen; a hand close that near liquidation counts, partial liquidations are missed); `direction` is the side of the position that was CLOSED (long = longs liquidated, price fell) and each row's `pnl_cohort` carries a `pnl_cohort_basis` saying how it was labelled. `risk`: per symbol, the share of open notional close to liquidation: `percent_risk` is a FRACTION from 0 to 1 despite its name, ranked by that fraction, so thin micro-cap markets can top it (read `total_value_usd`, or pass `min_value_usd`). `heatmap`: one symbol, where its open positions' own liquidation prices cluster, in equal-width price bins weighted by notional USD; positions outside +-50% of mark or without a liquidation price are left out and counted under `coverage`. Same data as GET /v1/hyperliquid/{liquidations, liquidations/risk, symbols/{symbol}/liquidation-heatmap}.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"end": {
"type": "string",
"description": "ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z. Used by view: fills."
},
"axis": {
"enum": [
"size",
"pnl",
"pnl_abs"
],
"type": "string",
"default": "size",
"description": "Cohort ladder: `size` = account-value tiers in USD, `pnl` = percentile rank of cumulative realized PnL (NOT dollars), `pnl_abs` = dollar bands of that same PnL. Used by view: risk."
},
"bins": {
"type": [
"integer",
"string"
],
"default": 50,
"maximum": 500,
"description": "Number of equal-width price bins, minimum 5. The window is fixed at +-50% around the mark price. Max 500. Used by view: heatmap."
},
"view": {
"enum": [
"fills",
"risk",
"heatmap"
],
"type": "string",
"default": "fills",
"description": "What to read. `fills`: liquidation events, newest first: exact from the node's fills since 2026-08-03, inferred from position snapshots before. `risk`: per symbol, the share of open notional close to liquidation. `heatmap`: where one symbol's open positions would liquidate, binned by price. Default `fills`."
},
"limit": {
"type": [
"integer",
"string"
],
"default": 100,
"description": "Rows per page, newest first. Max by view: fills 5000, risk 500. Used by view: fills, risk."
},
"start": {
"type": "string",
"description": "ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. Used by view: fills."
},
"cohort": {
"type": "string",
"description": "One label on `axis`, spelled exactly as `hl_segments` view=cohorts lists it, e.g. `whale` (size) or `3x smart` (pnl). Omit for all wallets. Used by view: risk."
},
"cursor": {
"type": "string",
"description": "`nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. Used by view: fills."
},
"symbol": {
"type": "string",
"description": "Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. Used by view: fills, heatmap. Required by view: heatmap."
},
"wallet": {
"type": "string",
"description": "One wallet, to ask whether it has been liquidated. Used by view: fills."
},
"direction": {
"enum": [
"long",
"short"
],
"type": "string",
"description": "The side of the position that was CLOSED: `long` = longs liquidated (price fell), `short` = shorts liquidated. Used by view: fills."
},
"min_value_usd": {
"type": [
"number",
"string"
],
"default": 0,
"description": "`risk` only: smallest total open notional in USD a symbol needs to be ranked. Default 0 (no floor), so thin micro-cap markets can lead; raise it to keep only markets big enough for a cascade to matter. Used by view: risk."
}
}
},
"annotations": {
"title": "Hyperliquid Liquidations",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| Parameter | Type | Description |
|---|---|---|
| end | string | ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z. On `positions` it needs `start` and is refused without it. On `hourly` it is exclusive and defaults to now. On `funding_rates` it is inclusive and needs `symbol`. Used by view: symbol_metrics, positions, indices, hourly, funding_rates. |
| axis | string | Cohort ladder: `size` = account-value tiers in USD, `pnl` = percentile rank of cumulative realized PnL (NOT dollars), `pnl_abs` = dollar bands of that same PnL. On `symbol_metrics` omit it to sum all cohorts; with `cohort` it slices one, and a `pnl` slice uses TODAY's grading for past hours (look-ah… |
| days | ["integer","string"] | Window length in days back from `end`, 1 to 400. `start` overrides it. Used by view: hourly. |
| sort | string | `positions`: `size` = the biggest current positions of ONE `symbol` first (by notional, then wallet, then direction), each row carrying the wallet's native `account_value`, `whole_account_value` and `account_mode`. Needs `symbol`, `limit` at most 500, no `cursor` and no `start`/`end`. Omit it for ke… |
| view | string | What to read. `open_interest`: open interest per symbol beside the venue's own figure. `symbol_metrics`: the hourly open-interest, position-count and bias series of one symbol. `size_breakdown`: one symbol's positioning by position-size bucket. `positions`: individual position rows in key order (not… |
| hours | ["integer","string"] | `indices`: window length in hours when `start` is omitted, ending at `end` or now. `large_fills`: how far back to look, at most 24. Default by view: indices 168, large_fills 24. Max by view: indices 8760, large_fills 24. Used by view: indices, large_fills. |
| limit | ["integer","string"] | Rows per page. On `indices`: max hourly rows, newest first; `has_more` says older ones exist, page back with `end` = the oldest `ts` minus 1 second. On `large_fills`: max fills, newest first; the source holds at most 200 per symbol, which is the default, and `has_more` says a lower `limit` cut rows.… |
| order | string | `funding_rates` only: `desc` (default: the board largest first, a history newest hour first) or `asc`. Used by view: funding_rates. |
| start | string | ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. On `positions`, setting it switches to history (`end` alone does not). On `hourly` (also epoch seconds or ms) it is inclusive and overrides `days`. On `funding_rates` it bounds a `symbol`'s history (inclusive) and is refused without `symbol`. Used… |
| cohort | string | One label on `axis`, spelled exactly as `hl_segments` view=cohorts lists it, e.g. `whale` (size) or `3x smart` (pnl). Omit for all wallets. Used by view: symbol_metrics, positions. |
| cursor | string | `nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. Refused with `sort=size`. On `funding_rates` resend the same `symbol`, `sort` and `order`. Used by view: symbol_metrics, positions, funding_rates. |
| symbol | string | Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. On `positions` it is a filter; bound a historical read by it or by `wallet`. On `funding_rates` it switches from the board of every perp to that perp's hourly history; HIP-3 markets (`xyz:TSLA`) includ… |
| wallet | string | One wallet's positions only. Used by view: positions. |
| min_usd | ["number","string"] | `large_fills` only: smallest fill in USD. 50000 is also the minimum: nothing smaller is held. Used by view: large_fills. |
| symbols | string | Comma-separated perp tickers, e.g. `BTC,ETH,SOL`; at most 64. Used by view: hourly. Required by view: hourly. |
| open_only | ["boolean","string"] | `true` (default) = the latest open positions. Passing `start` switches to the historical snapshots whatever this says; `false` without `start` is refused. Used by view: positions. |
| resolution | string | `positions` history only (needs `start`): `5m` = every snapshot, ~5 minutes apart; `1h` = the last snapshot of each hour, ~12x fewer rows. Default `1h` when `wallet` is given, `5m` otherwise; a `5m` read of one wallet is limited to 48 hours. Used by view: positions. |
| label_basis | string | `current` only: this series resolves the cohort label at query time, so `point_in_time` is refused by name; use hl_cohort_metrics for it. Used by view: symbol_metrics. |
| opened_within | string | Only positions opened within this window: `24h`, `7d`, `30d` or `all`; positions with no known open time are left out of every bounded window. Used by view: symbol_metrics. |
{
"name": "hl_market",
"title": "Hyperliquid Market",
"description": "Hyperliquid market positioning, by `view`. `open_interest`: open interest per symbol at the latest snapshot beside the venue's own figure, so the two can be reconciled. `symbol_metrics`: the hourly open-interest, position-count and `bias` series (a fraction from -1 to +1) of ONE symbol, all cohorts summed or one cohort sliced; the newest row is `provisional` (the hour in progress). A cohort slice has data from 2026-04-07 (the first hour cohort labels are correct; `data_from`), all cohorts summed the whole history. A `pnl` cohort slice here uses TODAY's grading for past hours (look-ahead): use hl_cohort_metrics with label_basis=point_in_time for research. `size_breakdown`: one symbol's positioning by position-size bucket (ten dollar ranges, empty ones zero-filled). `positions`: individual position rows, current by default or historical with `start` (and optionally `end`; `end` alone is refused; bound it by `symbol` or `wallet`). `positions` is ordered by KEY, NOT by size (current: wallet, symbol, direction; historical: symbol, snapshot time, wallet), because the cursor pages on the primary key: `limit=10` is the first ten wallets in address order, never the ten biggest. For the biggest positions of ONE symbol pass `sort=size` (current only, `limit` at most 500, no `cursor`): rows come biggest first and each carries `account_value`, the wallet's NATIVE perp account value in USD (null when unknown, never 0; a builder DEX's separate account is not in it), `account_mode` (`default`, `unifiedAccount`, `portfolioMargin`, `disabled`) and `whole_account_value`: in the two modes whose margin lives outside the perp account, the native account plus the USDC held outside it, else equal to `account_value`; both null on a row that does not record the mode (before 2026-11-07 20:03 UTC or from the fallback poller); there is no per-position cumulative funding. For market-wide sizes use `size_breakdown`, `open_interest` or hl_cohort_metrics. `indices`: four cohort readings of ONE symbol, all RATIOS from -1 (all short) to +1 (all long), not percents, and null (never 0) when a cohort holds no positions: `latest` is the newest 5-minute snapshot and `series` the settled hourly rows, newest first, data from 2026-04-07 (the first hour cohort labels are correct; `data_from`) (`hours` sizes the window, `limit` caps the rows, `has_more` says older rows exist). `smi` = long share of the 3x smart / 2x smart / smart wallets minus long share of the rekt / 2x rekt / 3x rekt wallets; `wsi` = long share of the 4x whale .. whale wallets minus long share of the 2x shrimp / shrimp wallets; `whale_bias` and `smart_bias` = (long - short) / (long + short) over those whale / smart wallets (`latest` only). `latest.smi` and `latest.smart_bias` rank wallets by today's PnL grading (`latest.label_basis` is `current`), the hourly `series` by each hour's own grading (top-level `label_basis` is `point_in_time`). `large_fills`: one symbol's fills of at least `min_usd` (from $50,000) of the last `hours` (up to 24), newest first, the website's Whale Activity feed: `ts`, `wallet`, `direction` (`buy` | `sell`), `size_token`, `size_usd`, `price`, `order_type` (`market` = crossed the book, `limit` = rested), `size_cohort`, `pnl_cohort` (graded at the fill's own hour where that hour is labelled, else today; `pnl_cohort_basis` says which). The source keeps only the newest 200 fills over $50k per symbol, so on a busy symbol it reaches back minutes, not a day: `covered_from` is how far back the answer reaches (the oldest fill held when `truncated` is true, else the start of the `hours` window) and `truncated` is true when that cap may have cut older fills inside `hours` (they may all be below `min_usd`). `limit` defaults to 200, everything the source holds per symbol; `has_more` is true when a lower `limit` cut matching rows. Liquidations are not flagged. Notional is USD. `hourly`: an hourly panel of up to 64 `symbols` at once, the close (from fills) beside open interest, funding rate a",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"end": {
"type": "string",
"description": "ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z. On `positions` it needs `start` and is refused without it. On `hourly` it is exclusive and defaults to now. On `funding_rates` it is inclusive and needs `symbol`. Used by view: symbol_metrics, positions, indices, hourly, funding_rates."
},
"axis": {
"enum": [
"size",
"pnl",
"pnl_abs"
],
"type": "string",
"description": "Cohort ladder: `size` = account-value tiers in USD, `pnl` = percentile rank of cumulative realized PnL (NOT dollars), `pnl_abs` = dollar bands of that same PnL. On `symbol_metrics` omit it to sum all cohorts; with `cohort` it slices one, and a `pnl` slice uses TODAY's grading for past hours (look-ahead: use hl_cohort_metrics with label_basis=point_in_time for research). Default by view: positions size. Used by view: symbol_metrics, positions."
},
"days": {
"type": [
"integer",
"string"
],
"default": 120,
"description": "Window length in days back from `end`, 1 to 400. `start` overrides it. Used by view: hourly."
},
"sort": {
"enum": [
"size",
"oi",
"rate",
"abs_rate"
],
"type": "string",
"description": "`positions`: `size` = the biggest current positions of ONE `symbol` first (by notional, then wallet, then direction), each row carrying the wallet's native `account_value`, `whole_account_value` and `account_mode`. Needs `symbol`, `limit` at most 500, no `cursor` and no `start`/`end`. Omit it for key order. `funding_rates` (the board, no `symbol`): `oi` (open interest in USD, the default), `rate` or `abs_rate` (the size of the rate whatever its sign). Used by view: positions, funding_rates."
},
"view": {
"enum": [
"open_interest",
"symbol_metrics",
"size_breakdown",
"positions",
"indices",
"large_fills",
"hourly",
"funding_rates"
],
"type": "string",
"default": "open_interest",
"description": "What to read. `open_interest`: open interest per symbol beside the venue's own figure. `symbol_metrics`: the hourly open-interest, position-count and bias series of one symbol. `size_breakdown`: one symbol's positioning by position-size bucket. `positions`: individual position rows in key order (not by size; `sort=size` for the biggest of one symbol), current or historical (historical rows carry `label_causal`, the previous hour's label, for a backtest without lookahead). `indices`: the smart money and whale-vs-shrimp indices plus whale and smart bias of one symbol: the newest snapshot and an hourly series. `large_fills`: one symbol's large fills (from $50k) of the last day, newest first, as the website's Whale Activity feed. `hourly`: hourly close, open interest, funding rate and premium of up to 64 symbols at once. `funding_rates`: the latest funding rate of every perp, or with `symbol` one perp's hourly funding history. Default `open_interest`."
},
"hours": {
"type": [
"integer",
"string"
],
"description": "`indices`: window length in hours when `start` is omitted, ending at `end` or now. `large_fills`: how far back to look, at most 24. Default by view: indices 168, large_fills 24. Max by view: indices 8760, large_fills 24. Used by view: indices, large_fills."
},
"limit": {
"type": [
"integer",
"string"
],
"description": "Rows per page. On `indices`: max hourly rows, newest first; `has_more` says older ones exist, page back with `end` = the oldest `ts` minus 1 second. On `large_fills`: max fills, newest first; the source holds at most 200 per symbol, which is the default, and `has_more` says a lower `limit` cut rows. Default by view: symbol_metrics 500, positions 100, indices 5000, large_fills 200, funding_rates 500. Max by view: symbol_metrics 5000, positions 5000, indices 5000, large_fills 1000, funding_rates 5000. Used by view: symbol_metrics, positions, indices, large_fills, funding_rates."
},
"order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc",
"description": "`funding_rates` only: `desc` (default: the board largest first, a history newest hour first) or `asc`. Used by view: funding_rates."
},
"start": {
"type": "string",
"description": "ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. On `positions`, setting it switches to history (`end` alone does not). On `hourly` (also epoch seconds or ms) it is inclusive and overrides `days`. On `funding_rates` it bounds a `symbol`'s history (inclusive) and is refused without `symbol`. Used by view: symbol_metrics, positions, indices, hourly, funding_rates."
},
"cohort": {
"type": "string",
"description": "One label on `axis`, spelled exactly as `hl_segments` view=cohorts lists it, e.g. `whale` (size) or `3x smart` (pnl). Omit for all wallets. Used by view: symbol_metrics, positions."
},
"cursor": {
"type": "string",
"description": "`nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. Refused with `sort=size`. On `funding_rates` resend the same `symbol`, `sort` and `order`. Used by view: symbol_metrics, positions, funding_rates."
},
"symbol": {
"type": "string",
"description": "Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. On `positions` it is a filter; bound a historical read by it or by `wallet`. On `funding_rates` it switches from the board of every perp to that perp's hourly history; HIP-3 markets (`xyz:TSLA`) included. Used by view: symbol_metrics, size_breakdown, positions, indices, large_fills, funding_rates. Required by view: symbol_metrics, size_breakdown, indices, large_fills."
},
"wallet": {
"type": "string",
"description": "One wallet's positions only. Used by view: positions."
},
"min_usd": {
"type": [
"number",
"string"
],
"default": 50000,
"description": "`large_fills` only: smallest fill in USD. 50000 is also the minimum: nothing smaller is held. Used by view: large_fills."
},
"symbols": {
"type": "string",
"description": "Comma-separated perp tickers, e.g. `BTC,ETH,SOL`; at most 64. Used by view: hourly. Required by view: hourly."
},
"open_only": {
"type": [
"boolean",
"string"
],
"default": true,
"description": "`true` (default) = the latest open positions. Passing `start` switches to the historical snapshots whatever this says; `false` without `start` is refused. Used by view: positions."
},
"resolution": {
"enum": [
"5m",
"1h"
],
"type": "string",
"description": "`positions` history only (needs `start`): `5m` = every snapshot, ~5 minutes apart; `1h` = the last snapshot of each hour, ~12x fewer rows. Default `1h` when `wallet` is given, `5m` otherwise; a `5m` read of one wallet is limited to 48 hours. Used by view: positions."
},
"label_basis": {
"enum": [
"current"
],
"type": "string",
"description": "`current` only: this series resolves the cohort label at query time, so `point_in_time` is refused by name; use hl_cohort_metrics for it. Used by view: symbol_metrics."
},
"opened_within": {
"enum": [
"24h",
"7d",
"30d",
"all"
],
"type": "string",
"default": "all",
"description": "Only positions opened within this window: `24h`, `7d`, `30d` or `all`; positions with no known open time are left out of every bounded window. Used by view: symbol_metrics."
}
}
},
"annotations": {
"title": "Hyperliquid Market",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| order | string | `desc` or `asc`. Used by view: leaderboard, users. |
| start | string | ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. Used by view: fills, series. |
| bucket | string | Bucket width: `1h` or `1d`. Used by view: series. |
| cursor | string | `nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. Used by view: leaderboard, users, fills, series. |
| symbol | string | Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. Omit for all symbols. Used by view: fills. |
| window | string | Window: `1d`, `7d`, `30d` or `all`. Used by view: leaderboard, stats, profile, users. |
| builder | string | Builder address: 0x followed by 40 hex characters. Used by view: profile, users, fills, series. Required by view: profile, users, fills, series. |
| breakdown_limit | ["integer","string"] | Rows per breakdown (per-symbol and per-dex). Max 1000. Used by view: profile. |
{
"name": "hl_builders",
"title": "Hyperliquid Builders",
"description": "Hyperliquid builder codes (front-ends and bots that attach their address to an order and take a slice of the taker fee), by `view`. `leaderboard`: builders ranked by fee revenue, routed volume, unique users or fills over a window. `stats`: venue-wide builder economics. `profile`: one builder's totals with per-symbol and per-dex breakdowns, user-volume deciles and lifetime totals. `users`: the wallets routing through one builder. `fills`: its raw routed fills (sum `fee_usd`; `fee` is in its own `fee_token`). `series`: fee, volume, users and fills per hour or day (`users` is NOT additive across buckets). `fee_usd` is the builder's own cut, `trader_fee_usd` what the trader paid; every `*_pct` is percentage points 0-100. History depth differs by builder: compare `active_days` and `window` before comparing windows. Same data as GET /v1/hyperliquid/builders and its sub-routes.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"end": {
"type": "string",
"description": "ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z. Used by view: fills, series."
},
"side": {
"enum": [
"buy",
"sell"
],
"type": "string",
"description": "`buy` or `sell`. Omit for both. Used by view: fills."
},
"sort": {
"type": "string",
"description": "`leaderboard`: `fee` (the builder's own cut), `volume`, `users` or `fills`. `users`: `volume`, `fees` or `pnl` (the TRADERS' signed realized PnL, not the builder's). Default by view: leaderboard fee, users volume. Used by view: leaderboard, users."
},
"view": {
"enum": [
"leaderboard",
"stats",
"profile",
"users",
"fills",
"series"
],
"type": "string",
"default": "leaderboard",
"description": "What to read. `leaderboard`: builders ranked by fee revenue, volume, users or fills. `stats`: venue-wide builder-code economics. `profile`: one builder's totals with per-symbol and per-dex breakdowns. `users`: the wallets routing through one builder, ranked. `fills`: one builder's raw routed fills, newest first. `series`: one builder's fee, volume, users and fills per hour or day. Default `leaderboard`."
},
"limit": {
"type": [
"integer",
"string"
],
"description": "Rows per page. Default by view: leaderboard 50, users 100, fills 100, series 500. Max by view: leaderboard 500, users 1000, fills 5000, series 2000. Used by view: leaderboard, users, fills, series."
},
"order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc",
"description": "`desc` or `asc`. Used by view: leaderboard, users."
},
"start": {
"type": "string",
"description": "ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. Used by view: fills, series."
},
"bucket": {
"enum": [
"1h",
"1d"
],
"type": "string",
"default": "1d",
"description": "Bucket width: `1h` or `1d`. Used by view: series."
},
"cursor": {
"type": "string",
"description": "`nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. Used by view: leaderboard, users, fills, series."
},
"symbol": {
"type": "string",
"description": "Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. Omit for all symbols. Used by view: fills."
},
"window": {
"enum": [
"1d",
"7d",
"30d",
"all"
],
"type": "string",
"default": "30d",
"description": "Window: `1d`, `7d`, `30d` or `all`. Used by view: leaderboard, stats, profile, users."
},
"builder": {
"type": "string",
"description": "Builder address: 0x followed by 40 hex characters. Used by view: profile, users, fills, series. Required by view: profile, users, fills, series."
},
"breakdown_limit": {
"type": [
"integer",
"string"
],
"default": 100,
"maximum": 1000,
"description": "Rows per breakdown (per-symbol and per-dex). Max 1000. Used by view: profile."
}
}
},
"annotations": {
"title": "Hyperliquid Builders",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| order | string | `desc` or `asc`. Used by view: list. |
| cursor | string | `nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. Used by view: list, flows. |
| status | string | `open`, `closed` or `all` vaults. Used by view: list. |
| window | string | Window ending on the newest recorded day: `7d`, `30d`, `90d`, `365d` or `all` (all history). Default by view: list 30d, stats 30d, flows 7d. |
| min_tvl | ["number","string"] | Minimum current TVL in USD. Used by view: list. |
| min_usd | ["number","string"] | Smallest flow in USD. Used by view: flows. |
| deposits | string | `any`, or only vaults whose deposits are `open` or `closed`. Used by view: list. |
| smart_only | ["boolean","string"] | Only depositors in the top 1,000 of the all-time PnL leaderboard. Used by view: flows. |
{
"name": "hl_vaults",
"title": "Hyperliquid Vaults",
"description": "Hyperliquid vaults across the platform, by `view`. `list`: one row per vault family (HLP and its sub-vaults are one row) with current TVL, APR (our 30-day share-price return, annualised) and the window's PnL, return, net flow, volume and fills, plus `leverage` (gross notional / equity) and the leader's and top-5 depositors' shares; `q` searches by name or address. A family is measured from the first day all its open vaults are recorded (`start`, `partial`); its flows are the parent's. `stats`: platform TVL, deposits, withdrawals and net flow over the window, vaults created per month. `flows`: deposits and withdrawals of at least `min_usd` across all vaults, newest first. A window ends on the newest recorded day; one shorter than asked says `partial`. Money is USD, `*_pct` percentage points. Same data as GET /v1/hyperliquid/vaults, /vaults/stats and /vaults/flows.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"q": {
"type": "string",
"description": "Search, 2-64 characters: a case-insensitive part of the vault name, or an address prefix starting `0x` (a sub-vault's address finds its family). Used by view: list."
},
"sort": {
"enum": [
"tvl",
"apr",
"pnl",
"return",
"net_flow",
"volume",
"age",
"leverage",
"top5_share"
],
"type": "string",
"default": "tvl",
"description": "Ranking: `tvl`, `apr`, `pnl`, `return`, `net_flow`, `volume`, `age`, `leverage` or `top5_share` (the five largest depositors' share). Used by view: list."
},
"type": {
"enum": [
"all",
"deposit",
"withdraw",
"distribution",
"commission"
],
"type": "string",
"default": "all",
"description": "`all`, `deposit`, `withdraw`, `distribution` or `commission`. Used by view: flows."
},
"view": {
"enum": [
"list",
"stats",
"flows"
],
"type": "string",
"default": "list",
"description": "What to read. `list`: every vault family with TVL, APR, the window's PnL, return, net flow and volume, leverage and depositor concentration; `q` searches by name or address. `stats`: platform TVL, flows over the window and vaults created per month. `flows`: deposits and withdrawals across all vaults, depositor side, newest first. Default `list`."
},
"limit": {
"type": [
"integer",
"string"
],
"description": "Rows per page. Default by view: list 50, flows 100. Max by view: list 500, flows 1000. Used by view: list, flows."
},
"order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc",
"description": "`desc` or `asc`. Used by view: list."
},
"cursor": {
"type": "string",
"description": "`nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. Used by view: list, flows."
},
"status": {
"enum": [
"open",
"closed",
"all"
],
"type": "string",
"default": "open",
"description": "`open`, `closed` or `all` vaults. Used by view: list."
},
"window": {
"enum": [
"7d",
"30d",
"90d",
"365d",
"all"
],
"type": "string",
"description": "Window ending on the newest recorded day: `7d`, `30d`, `90d`, `365d` or `all` (all history). Default by view: list 30d, stats 30d, flows 7d."
},
"min_tvl": {
"type": [
"number",
"string"
],
"default": 0,
"description": "Minimum current TVL in USD. Used by view: list."
},
"min_usd": {
"type": [
"number",
"string"
],
"default": 10000,
"description": "Smallest flow in USD. Used by view: flows."
},
"deposits": {
"enum": [
"any",
"open",
"closed"
],
"type": "string",
"default": "any",
"description": "`any`, or only vaults whose deposits are `open` or `closed`. Used by view: list."
},
"smart_only": {
"type": [
"boolean",
"string"
],
"default": false,
"description": "Only depositors in the top 1,000 of the all-time PnL leaderboard. Used by view: flows."
}
}
},
"annotations": {
"title": "Hyperliquid Vaults",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| `desc` or `asc`. Used by view: depositors. |
| start | string | ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. Used by view: series. |
| vault | string | Vault address: 0x followed by 40 hex characters. Required. |
| bucket | string | Point width: `1h` or `1d`. Used by view: series. |
| cursor | string | `nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. Used by view: depositors, flows, series. |
| window | string | Window ending on the newest recorded day: `7d`, `30d`, `90d`, `365d` or `all`. Used by view: flows. |
| smart_only | ["boolean","string"] | Only depositors in the top 1,000 of the all-time PnL leaderboard. Used by view: depositors. |
| min_equity_usd | ["number","string"] | Smallest depositor equity in USD, at least 1. Used by view: depositors. |
{
"name": "hl_vault",
"title": "Hyperliquid Vault",
"description": "One Hyperliquid vault by address, by `view`. `profile`: TVL, APR, leverage, leader and top-5 shares, active depositors and all five windows (7d, 30d, 90d, 365d, all). `depositors`: every current depositor (not only the largest 100) with equity, PnL on the current position, all-time PnL, entry time, lockup end and PnL rank. `flows`: the vault's own ledger rows, newest first. `series`: equity, chained share price (`nav`), net flow and PnL per hour or day, oldest first (for a parent vault, its whole family). Its fills, trades and positions: hl_wallet and hl_wallet_activity with the vault address. Same data as GET /v1/hyperliquid/vaults/{vault} and its sub-routes.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"end": {
"type": "string",
"description": "ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z. Used by view: series."
},
"sort": {
"enum": [
"share",
"pnl",
"all_time_pnl",
"entered"
],
"type": "string",
"default": "share",
"description": "Ranking: `share`, `pnl` (on the current position), `all_time_pnl` (since the first deposit) or `entered` (entry time). Used by view: depositors."
},
"type": {
"enum": [
"all",
"deposit",
"withdraw",
"distribution",
"commission"
],
"type": "string",
"default": "all",
"description": "`all`, `deposit`, `withdraw`, `distribution` or `commission`. Used by view: flows."
},
"view": {
"enum": [
"profile",
"depositors",
"flows",
"series"
],
"type": "string",
"default": "profile",
"description": "What to read. `profile`: TVL, APR, leverage, depositor concentration and all five windows. `depositors`: current depositors with their equity, PnL, entry and lockup, largest share first. `flows`: the vault's own deposits, withdrawals, distributions and commissions, newest first. `series`: equity, share price, net flow and PnL per hour or day, oldest first. Default `profile`."
},
"limit": {
"type": [
"integer",
"string"
],
"description": "Rows per page. Default by view: depositors 100, flows 100, series 500. Max by view: depositors 1000, flows 1000, series 5000. Used by view: depositors, flows, series."
},
"order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc",
"description": "`desc` or `asc`. Used by view: depositors."
},
"start": {
"type": "string",
"description": "ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. Used by view: series."
},
"vault": {
"type": "string",
"description": "Vault address: 0x followed by 40 hex characters. Required."
},
"bucket": {
"enum": [
"1h",
"1d"
],
"type": "string",
"default": "1d",
"description": "Point width: `1h` or `1d`. Used by view: series."
},
"cursor": {
"type": "string",
"description": "`nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. Used by view: depositors, flows, series."
},
"window": {
"enum": [
"7d",
"30d",
"90d",
"365d",
"all"
],
"type": "string",
"default": "30d",
"description": "Window ending on the newest recorded day: `7d`, `30d`, `90d`, `365d` or `all`. Used by view: flows."
},
"smart_only": {
"type": [
"boolean",
"string"
],
"default": false,
"description": "Only depositors in the top 1,000 of the all-time PnL leaderboard. Used by view: depositors."
},
"min_equity_usd": {
"type": [
"number",
"string"
],
"default": 1,
"description": "Smallest depositor equity in USD, at least 1. Used by view: depositors."
}
}
},
"annotations": {
"title": "Hyperliquid Vault",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| Parameter | Type | Description |
|---|---|---|
| at | string | ISO-8601 UTC instant, floored to 5 minutes. Default: the newest snapshot; not before 2026-07-29 (`book`: 2026-07-28), not in the future. On `open` and `clusters` an `at` with no complete 5-minute snapshot is rebuilt from the sightings around it, so short-lived orders can be missing; `book` answers t… |
| to | string | ISO-8601 UTC end of the window. Default: the newest order snapshot (`wallet`, `walls`, `order_stats`), now (`book_cohorts`). At most 30 days after `from` (`wallet`), 7 days (`walls`, `order_stats`, `book_cohorts`). Used by view: wallet, book_cohorts, walls, order_stats. |
| oid | ["integer","string"] | One order id. 0 (the default) = every order. Used by view: open. |
| from | string | ISO-8601 UTC start of the window. Default: 7 days before `to` (`wallet`, `order_stats`), 24 hours before `to` (`walls`, `book_cohorts`). Used by view: wallet, book_cohorts, walls, order_stats. |
| kind | string | `both` (the default), `resting` (limit orders on the book) or `trigger` (untriggered stops and take-profits). Used by view: walls. |
| side | string | `both` (the default), `bid` or `ask`: which side of the book to return. Used by view: book. |
| view | string | What to read. `open`: the orders resting at one instant for a symbol and/or a wallet, each with its owner's labels. `wallet`: what became of one wallet's orders in a window (open, filled, canceled), newest first. `clusters`: one symbol's standing orders bucketed by price around the mid. `book`: one … |
| limit | ["integer","string"] | Rows per page. Max 1000. Used by view: open, wallet, walls. |
| cohort | string | One label on `axis`, spelled exactly as `hl_segments` view=cohorts lists it, e.g. `whale` (size) or `3x smart` (pnl). Only that cohort's orders (`open`, `clusters`), or its stops and liquidations (`squeeze`). Without `at` by the current labels; with `at` by the labels of the hour before the snapshot… |
| cursor | string | `nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. On `open` it pins the snapshot of the first page. Used by view: open, wallet, walls. |
| levels | ["integer","string"] | Price levels per side, counted from the best price outward. Max 1000. Used by view: book. |
| market | string | `perp` (the default) or `spot`. Perp and spot books are never mixed: HYPE is both. Used by view: open, clusters, book, book_cohorts, walls, order_stats. |
| status | string | `open`, `filled`, `partially_filled` or `canceled_or_expired`. Omit for every status. Used by view: wallet. |
| symbol | string | Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. With `market=spot` a spot pair, `HYPE/USDC` (a bare `HYPE` is `HYPE/USDC`). On `open` and `walls`, `symbol` and/or `wallet` is required: an unfiltered snapshot is the whole book. Used by view: open, wa… |
| wallet | string | `open`: one wallet's resting orders; `walls`: one wallet's walls. 0x followed by 40 hex characters. Used by view: open, walls. |
| address | string | Hyperliquid wallet address: 0x followed by 40 hex characters, any case. Used by view: wallet, order_stats. Required by view: wallet, order_stats. |
| min_usd | ["number","string"] | Smallest wall in USD: limit price x original size, a stop or take-profit at its trigger price. At least 100,000. Default by view: walls 1000000.0, order_stats 100000.0. Used by view: walls, order_stats. |
| outcome | string | Only the walls with this outcome: `filled`, `partially_filled`, `pulled` (left the book with no fill), `open` (still resting) or `unknown` (left the book, fills not yet stored). Omit for all. Used by view: walls. |
| band_bps | ["integer","string"] | `book_cohorts`: the orders within `50`, `200` (the default) or `1000` basis points of the mid. Used by view: book_cohorts. |
| interval | string | `book_cohorts`: one point per `5m`, `1h` (the default) or `1d`; hours and days average the 5-minute snapshots. Used by view: book_cohorts. |
| step_bps | ["integer","string"] | Bucket width in basis points of the mid, at least 1. Default 10 (`clusters`), 25 (`squeeze`). Default by view: clusters 10, squeeze 25. Max 500. Used by view: clusters, squeeze. |
| range_pct | ["integer","string"] | Half-width of the price range around the mid, in percent, at least 1. Default 10 (`clusters`), 8 (`squeeze`). Default by view: clusters 10, squeeze 8. Max 50. Used by view: clusters, squeeze. |
| touch_bps | ["integer","string"] | How close the other side of the book must have been, in basis points of the wall's price, when it was last seen, for `near_touch` to be true. Max 500. Used by view: walls. |
| created_to | string | ISO-8601 UTC: only orders placed at or before this. Used by view: open. |
| order_type | string | One order type; an unknown value is refused. Used by view: open. |
| cohort_axis | string | The ladder `cohort` is read on: `size`, `pnl` or `pnl_abs`. Default `size`. On `book_cohorts` the ladder the book is split by: `size` or `pnl`. Default by view: book_cohorts size. Used by view: open, clusters, squeeze, book_cohorts. |
| created_from | string | ISO-8601 UTC: only orders placed at or after this. Used by view: open. |
{
"name": "hl_orders",
"title": "Hyperliquid Orders",
"description": "Hyperliquid standing orders, by `view`. `open`: every order resting at one instant (`at`, default the newest snapshot) for a `symbol` and/or a `wallet`, in key order, each with its owner's `sizeCohort`, `pnlCohort` and `pnlCumUsd` (without `at` the current labels, with `at` those of the hour before the snapshot's own hour), optionally one cohort's, with `snapshotTs` and `source`: `l4_5m` = the node's 5-minute order snapshot (from 2026-10-23 21:45 UTC), `state_12m` = rebuilt from the ~12-minute checkpoints (from 2026-07-29; before the 5-minute feed, or while it is stalled), where short-lived orders can be missing. `wallet`: what became of one wallet's orders in a window, newest placement first: each order seen resting or filled in it, its fills in the window and a `status` (open, filled, partially_filled, canceled_or_expired); `notes` says what a snapshot cannot tell. `clusters`: one symbol's standing orders within `range_pct` of the mid of the best resting bid and ask, bucketed by price (bids and asks by limit price, take-profit and stop-loss by trigger price; trailing stops are not bucketed), optionally one cohort's. `book`: one symbol's order book at one instant, the resting limit orders summed per price (`px`, `sz`, `n` orders), `levels` a side, bids highest first and asks lowest first; `l4_5m` from 2026-11-13 08:40 UTC, `state_12m` from 2026-07-28, and `snapshotTs` is the snapshot's own time. `squeeze`: one perp's price ladder at one instant, per bucket the resting book (size and USD value), the stop orders that would trade into it when triggered and the open positions that would be liquidated into it, and `pressure` = that forced selling over the USD value of the resting bids below the mid, forced buying over the asks above it (above 1: a squeeze); `cohort` keeps one cohort's stops and liquidations. `book_cohorts`: which cohorts own the resting book within `band_bps` of the mid over time, per point and cohort the bid and ask notional and its share, each owner labelled as of that 5-minute snapshot. `open`, `clusters`, `book`, `book_cohorts` and `walls` read the perp books unless `market=spot`. `walls`: the large orders (at least `min_usd`, default $1M; a stop or take-profit at its trigger price) of a `symbol` and/or a `wallet` whose last sighting falls in a window (default the last 24 hours, at most 7 days), newest first, each with `outcome` (`filled`, `partially_filled`, `pulled` = left the book with no fill, `open`, or `unknown` while the fills are not yet stored), `filled_usd`, `lifetime_s`, `near_touch` (the other side of the book within `touch_bps` of its price when it was last seen; null where that snapshot's book is not stored: 5-minute snapshots before 2026-11-13 08:40 UTC) and its owner's labels (current for an open wall, else those of the hour before it was last seen: each row's `label_basis`). `order_stats`: one wallet's walls of at least `min_usd` (default $100k) in a window (default and at most 7 days) in totals and for its 20 busiest symbols: counts per outcome, `pulled_share` (pulled / walls that left the book with a known outcome), `cancel_to_fill_ratio` (pulled / filled), `pulled_near_touch_share` (over its newest 1,000 pulled walls), `median_lifetime_s`, `total_wall_usd` and `filled_usd`. Same data as GET /v1/hyperliquid/orders, /wallets/{address}/orders, /symbols/{symbol}/order-clusters, /symbols/{symbol}/book, /symbols/{symbol}/squeeze-map, /symbols/{symbol}/book-cohorts, /walls and /wallets/{address}/order-stats.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"at": {
"type": "string",
"description": "ISO-8601 UTC instant, floored to 5 minutes. Default: the newest snapshot; not before 2026-07-29 (`book`: 2026-07-28), not in the future. On `open` and `clusters` an `at` with no complete 5-minute snapshot is rebuilt from the sightings around it, so short-lived orders can be missing; `book` answers the newest snapshot at or before it, and `squeeze` each of its parts' newest at or before it. Used by view: open, clusters, book, squeeze."
},
"to": {
"type": "string",
"description": "ISO-8601 UTC end of the window. Default: the newest order snapshot (`wallet`, `walls`, `order_stats`), now (`book_cohorts`). At most 30 days after `from` (`wallet`), 7 days (`walls`, `order_stats`, `book_cohorts`). Used by view: wallet, book_cohorts, walls, order_stats."
},
"oid": {
"type": [
"integer",
"string"
],
"default": 0,
"description": "One order id. 0 (the default) = every order. Used by view: open."
},
"from": {
"type": "string",
"description": "ISO-8601 UTC start of the window. Default: 7 days before `to` (`wallet`, `order_stats`), 24 hours before `to` (`walls`, `book_cohorts`). Used by view: wallet, book_cohorts, walls, order_stats."
},
"kind": {
"enum": [
"both",
"resting",
"trigger"
],
"type": "string",
"default": "both",
"description": "`both` (the default), `resting` (limit orders on the book) or `trigger` (untriggered stops and take-profits). Used by view: walls."
},
"side": {
"enum": [
"both",
"bid",
"ask"
],
"type": "string",
"default": "both",
"description": "`both` (the default), `bid` or `ask`: which side of the book to return. Used by view: book."
},
"view": {
"enum": [
"open",
"wallet",
"clusters",
"book",
"squeeze",
"book_cohorts",
"walls",
"order_stats"
],
"type": "string",
"default": "open",
"description": "What to read. `open`: the orders resting at one instant for a symbol and/or a wallet, each with its owner's labels. `wallet`: what became of one wallet's orders in a window (open, filled, canceled), newest first. `clusters`: one symbol's standing orders bucketed by price around the mid. `book`: one symbol's order book at one instant, price levels best first. `squeeze`: one perp's price ladder at one instant: resting book, stops and liquidations per bucket, and how much forced flow each bucket would take against its book. `book_cohorts`: which cohorts own the resting book near the mid, over time. `walls`: the large orders (walls) of a symbol and/or a wallet last seen in a window and what became of each: filled, pulled before any fill, or still open. `order_stats`: one wallet's walls in a window, in totals and per symbol: how many it pulled and filled. Default `open`."
},
"limit": {
"type": [
"integer",
"string"
],
"default": 100,
"maximum": 1000,
"description": "Rows per page. Max 1000. Used by view: open, wallet, walls."
},
"cohort": {
"type": "string",
"description": "One label on `axis`, spelled exactly as `hl_segments` view=cohorts lists it, e.g. `whale` (size) or `3x smart` (pnl). Only that cohort's orders (`open`, `clusters`), or its stops and liquidations (`squeeze`). Without `at` by the current labels; with `at` by the labels of the hour before the snapshot's own hour, the ones `open` rows carry. Used by view: open, clusters, squeeze."
},
"cursor": {
"type": "string",
"description": "`nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page. On `open` it pins the snapshot of the first page. Used by view: open, wallet, walls."
},
"levels": {
"type": [
"integer",
"string"
],
"default": 100,
"maximum": 1000,
"description": "Price levels per side, counted from the best price outward. Max 1000. Used by view: book."
},
"market": {
"enum": [
"perp",
"spot"
],
"type": "string",
"default": "perp",
"description": "`perp` (the default) or `spot`. Perp and spot books are never mixed: HYPE is both. Used by view: open, clusters, book, book_cohorts, walls, order_stats."
},
"status": {
"enum": [
"open",
"filled",
"partially_filled",
"canceled_or_expired"
],
"type": "string",
"description": "`open`, `filled`, `partially_filled` or `canceled_or_expired`. Omit for every status. Used by view: wallet."
},
"symbol": {
"type": "string",
"description": "Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. With `market=spot` a spot pair, `HYPE/USDC` (a bare `HYPE` is `HYPE/USDC`). On `open` and `walls`, `symbol` and/or `wallet` is required: an unfiltered snapshot is the whole book. Used by view: open, wallet, clusters, book, squeeze, book_cohorts, walls. Required by view: clusters, book, squeeze, book_cohorts."
},
"wallet": {
"type": "string",
"description": "`open`: one wallet's resting orders; `walls`: one wallet's walls. 0x followed by 40 hex characters. Used by view: open, walls."
},
"address": {
"type": "string",
"description": "Hyperliquid wallet address: 0x followed by 40 hex characters, any case. Used by view: wallet, order_stats. Required by view: wallet, order_stats."
},
"min_usd": {
"type": [
"number",
"string"
],
"description": "Smallest wall in USD: limit price x original size, a stop or take-profit at its trigger price. At least 100,000. Default by view: walls 1000000.0, order_stats 100000.0. Used by view: walls, order_stats."
},
"outcome": {
"enum": [
"filled",
"partially_filled",
"pulled",
"open",
"unknown"
],
"type": "string",
"description": "Only the walls with this outcome: `filled`, `partially_filled`, `pulled` (left the book with no fill), `open` (still resting) or `unknown` (left the book, fills not yet stored). Omit for all. Used by view: walls."
},
"band_bps": {
"type": [
"integer",
"string"
],
"default": 200,
"description": "`book_cohorts`: the orders within `50`, `200` (the default) or `1000` basis points of the mid. Used by view: book_cohorts."
},
"interval": {
"enum": [
"5m",
"1h",
"1d"
],
"type": "string",
"default": "1h",
"description": "`book_cohorts`: one point per `5m`, `1h` (the default) or `1d`; hours and days average the 5-minute snapshots. Used by view: book_cohorts."
},
"step_bps": {
"type": [
"integer",
"string"
],
"maximum": 500,
"description": "Bucket width in basis points of the mid, at least 1. Default 10 (`clusters`), 25 (`squeeze`). Default by view: clusters 10, squeeze 25. Max 500. Used by view: clusters, squeeze."
},
"range_pct": {
"type": [
"integer",
"string"
],
"maximum": 50,
"description": "Half-width of the price range around the mid, in percent, at least 1. Default 10 (`clusters`), 8 (`squeeze`). Default by view: clusters 10, squeeze 8. Max 50. Used by view: clusters, squeeze."
},
"touch_bps": {
"type": [
"integer",
"string"
],
"default": 10,
"maximum": 500,
"description": "How close the other side of the book must have been, in basis points of the wall's price, when it was last seen, for `near_touch` to be true. Max 500. Used by view: walls."
},
"created_to": {
"type": "string",
"description": "ISO-8601 UTC: only orders placed at or before this. Used by view: open."
},
"order_type": {
"enum": [
"Limit",
"Stop Market",
"Stop Limit",
"Take Profit Market",
"Take Profit Limit",
"Trailing Stop Market"
],
"type": "string",
"description": "One order type; an unknown value is refused. Used by view: open."
},
"cohort_axis": {
"enum": [
"size",
"pnl",
"pnl_abs"
],
"type": "string",
"description": "The ladder `cohort` is read on: `size`, `pnl` or `pnl_abs`. Default `size`. On `book_cohorts` the ladder the book is split by: `size` or `pnl`. Default by view: book_cohorts size. Used by view: open, clusters, squeeze, book_cohorts."
},
"created_from": {
"type": "string",
"description": "ISO-8601 UTC: only orders placed at or after this. Used by view: open."
}
}
},
"annotations": {
"title": "Hyperliquid Orders",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| symbol | string | Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. Omit for all symbols. |
| wallet | string | One wallet, 0x followed by 40 hex characters, any case. With it (or `twap_id`) there is no default window and no 31-day cap. |
| twap_id | ["integer","string"] | One TWAP id: every status line of that TWAP. 0 (the default) = every TWAP. Max 9007199254740991. |
{
"name": "hl_twaps",
"title": "Hyperliquid Twaps",
"description": "Hyperliquid TWAP orders, one row per status line, newest first. A line is a status CHANGE (`activated`, `waitingForTrigger`, then `finished`, `terminated` or `stopped`), not a slice fill: `executed_size` and `executed_notional_usd` are the cumulative totals when the line was written. Rejected placements (`error`) are hidden unless `status=error`. Across all wallets the window defaults to the last 24 hours and is at most 31 days; with `wallet` or `twap_id` neither applies. `order=asc` follows the feed: pass each `nextCursor` back and stop on an empty page. Same data as GET /v1/hyperliquid/twaps; with `wallet` it is GET /v1/hyperliquid/wallets/{address}/twaps (one feed: the cursors are interchangeable).",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"end": {
"type": "string",
"description": "ISO-8601 UTC upper bound. Default: now. A window wider than 31 days is refused unless `wallet` or `twap_id` is given."
},
"limit": {
"type": [
"integer",
"string"
],
"default": 100,
"maximum": 5000,
"description": "Rows per page. Max 5000."
},
"order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc",
"description": "`desc` (default, newest first) or `asc`, oldest first: the mode for FOLLOWING the feed. Pass each `nextCursor` back verbatim and stop on an EMPTY page, not on a null cursor (an `asc` page with rows always carries one). A row written late with an older key is not seen by a poller already past it: re-read a small overlap with `start`."
},
"start": {
"type": "string",
"description": "ISO-8601 UTC lower bound. Default: the 24 hours before `end`, unless `wallet` or `twap_id` is given."
},
"cursor": {
"type": "string",
"description": "`nextCursor` from the previous page, verbatim. It pins the call that returned it: send the same `order`, filters, `start` and `end` again, or the call is refused."
},
"status": {
"enum": [
"activated",
"waitingForTrigger",
"finished",
"terminated",
"stopped",
"error"
],
"type": "string",
"description": "One status. Default: every status except `error` (a rejected placement, not an order); `error` shows those rows."
},
"symbol": {
"type": "string",
"description": "Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. Omit for all symbols."
},
"wallet": {
"type": "string",
"description": "One wallet, 0x followed by 40 hex characters, any case. With it (or `twap_id`) there is no default window and no 31-day cap."
},
"twap_id": {
"type": [
"integer",
"string"
],
"default": 0,
"maximum": 9007199254740991,
"description": "One TWAP id: every status line of that TWAP. 0 (the default) = every TWAP. Max 9007199254740991."
}
}
},
"annotations": {
"title": "Hyperliquid Twaps",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| ["number","string"] |
| Smallest absolute `amount_usd`, 0 or more. Default 0: no floor. |
| event_type | string | One ledger event type; an unknown value is refused, not answered with an empty list. |
{
"name": "hl_ledger",
"title": "Hyperliquid Ledger",
"description": "Hyperliquid deposits, withdrawals, transfers and vault events ACROSS wallets, newest first, with `wallet` and `amount_usd` (USD) on every row; `min_usd` keeps the large ones (most events are small transfers). A transfer between two wallets is one row per affected wallet with the same `hash`. Without `wallet` the window defaults to the last 24 hours and is at most 31 days. `order=asc` follows the feed: pass each `nextCursor` back and stop on an empty page. One wallet's own ledger is also hl_wallet_activity view=ledger. Same data as GET /v1/hyperliquid/ledger.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"end": {
"type": "string",
"description": "ISO-8601 UTC upper bound. Default: now. A window wider than 31 days is refused unless `wallet` is given."
},
"limit": {
"type": [
"integer",
"string"
],
"default": 100,
"maximum": 5000,
"description": "Rows per page. Max 5000."
},
"order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc",
"description": "`desc` (default, newest first) or `asc`, oldest first: the mode for FOLLOWING the feed. Pass each `nextCursor` back verbatim and stop on an EMPTY page, not on a null cursor (an `asc` page with rows always carries one). A row written late with an older key is not seen by a poller already past it: re-read a small overlap with `start`. A page can hold fewer than `limit` rows and still carry a cursor (duplicates are dropped after the read)."
},
"start": {
"type": "string",
"description": "ISO-8601 UTC lower bound. Default: the 24 hours before `end`, unless `wallet` is given."
},
"cursor": {
"type": "string",
"description": "`nextCursor` from the previous page, verbatim. It pins the call that returned it: send the same `order`, filters, `start` and `end` again, or the call is refused."
},
"wallet": {
"type": "string",
"description": "One wallet, 0x followed by 40 hex characters, any case. With it there is no default window and no 31-day cap."
},
"min_usd": {
"type": [
"number",
"string"
],
"default": 0,
"description": "Smallest absolute `amount_usd`, 0 or more. Default 0: no floor."
},
"event_type": {
"enum": [
"deposit",
"withdraw",
"send",
"spotTransfer",
"internalTransfer",
"subAccountTransfer",
"accountClassTransfer",
"vaultDeposit",
"vaultWithdraw",
"vaultCreate",
"vaultDistribution",
"vaultLeaderCommission",
"borrowLend",
"rewardsClaim"
],
"type": "string",
"description": "One ledger event type; an unknown value is refused, not answered with an empty list."
}
}
},
"annotations": {
"title": "Hyperliquid Ledger",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| symbol | string | Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. Omit for all symbols. |
| wallet | string | One wallet, 0x followed by 40 hex characters, any case. With it there is no default window and no 31-day cap. |
| min_leverage | ["number","string"] | Smallest NEW `leverage`, 0 or more. Default 0: no floor. |
{
"name": "hl_leverage_changes",
"title": "Hyperliquid Leverage Changes",
"description": "Hyperliquid positions whose leverage or margin mode differs between two consecutive complete position snapshots, newest first: one row per wallet and symbol with the previous and the new leverage, margin mode, side, size and entry price. `ts` is when the later snapshot was written, not when the venue changed the setting; positions are captured about every 12 minutes, so changes arrive in batches. Without `wallet` the window defaults to the last 24 hours and is at most 31 days. `order=asc` follows the feed (stop on an empty page). Same data as GET /v1/hyperliquid/leverage-changes.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"end": {
"type": "string",
"description": "ISO-8601 UTC upper bound. Default: now. A window wider than 31 days is refused unless `wallet` is given."
},
"limit": {
"type": [
"integer",
"string"
],
"default": 100,
"maximum": 5000,
"description": "Rows per page. Max 5000."
},
"order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc",
"description": "`desc` (default, newest first) or `asc`, oldest first: the mode for FOLLOWING the feed. Pass each `nextCursor` back verbatim and stop on an EMPTY page, not on a null cursor (an `asc` page with rows always carries one). A row written late with an older key is not seen by a poller already past it: re-read a small overlap with `start`."
},
"start": {
"type": "string",
"description": "ISO-8601 UTC lower bound. Default: the 24 hours before `end`, unless `wallet` is given."
},
"change": {
"enum": [
"up",
"down",
"mode"
],
"type": "string",
"description": "`up` (leverage rose), `down` (leverage fell) or `mode` (only the margin mode, `cross` or `isolated`, changed). Omit for every change."
},
"cursor": {
"type": "string",
"description": "`nextCursor` from the previous page, verbatim. It pins the call that returned it: send the same `order`, filters, `start` and `end` again, or the call is refused."
},
"symbol": {
"type": "string",
"description": "Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. Omit for all symbols."
},
"wallet": {
"type": "string",
"description": "One wallet, 0x followed by 40 hex characters, any case. With it there is no default window and no 31-day cap."
},
"min_leverage": {
"type": [
"number",
"string"
],
"default": 0,
"description": "Smallest NEW `leverage`, 0 or more. Default 0: no floor."
}
}
},
"annotations": {
"title": "Hyperliquid Leverage Changes",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "hl_wallet_trades",
"title": "Hyperliquid Wallet Trades",
"description": "One Hyperliquid wallet's CLOSED round-trip trades, newest close first, keyset-paged: per trade the symbol, direction, `open_ts` / `close_ts`, entry and exit price, the largest size held (`max_size_usd`), traded `volume_usd`, `realized_pnl` and `total_fee` in USD and the fill count. A trade still open is not listed. For statistics over these trades use hl_wallet view=trades_summary; for the raw fills hl_wallet_activity view=fills. Same data as GET /v1/hyperliquid/wallets/{address}/trades.",
"inputSchema": {
"type": "object",
"required": [
"address"
],
"properties": {
"end": {
"type": "string",
"description": "ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z. Bounds the close time."
},
"limit": {
"type": [
"integer",
"string"
],
"default": 100,
"maximum": 5000,
"description": "Trades per page, newest close first. Max 5000."
},
"start": {
"type": "string",
"description": "ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z. Bounds the close time."
},
"cursor": {
"type": "string",
"description": "`nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page."
},
"symbol": {
"type": "string",
"description": "Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. Omit for all symbols."
},
"address": {
"type": "string",
"description": "Hyperliquid wallet address: 0x followed by 40 hex characters, any case."
}
}
},
"annotations": {
"title": "Hyperliquid Wallet Trades",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "hl_stats",
"title": "Hyperliquid Stats",
"description": "Hyperliquid venue-wide hourly series, newest hour first, by `view`. `ecosystem`: perp equity, open interest and position counts per hour. `volume`: traded perp notional per hour, of the whole venue (builder-DEX perps included; spot and outcome markets left out) or of one `symbol`: `volume` counts each trade ONCE (one side), the figure the candles report, while `n_fills` counts fill records, two per trade. Money is USD. Keyset-paged with `cursor`. Same data as GET /v1/hyperliquid/stats and /stats/volume.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"end": {
"type": "string",
"description": "ISO-8601 UTC upper bound, e.g. 2026-10-02T00:00:00Z."
},
"view": {
"enum": [
"ecosystem",
"volume"
],
"type": "string",
"default": "ecosystem",
"description": "What to read. `ecosystem`: hourly venue-wide perp equity, open interest and position counts, newest first. `volume`: hourly perp volume of the whole venue or one symbol, newest first. Default `ecosystem`."
},
"limit": {
"type": [
"integer",
"string"
],
"default": 500,
"maximum": 5000,
"description": "Hourly rows per page, newest first. Max 5000."
},
"start": {
"type": "string",
"description": "ISO-8601 UTC lower bound, e.g. 2026-10-01T00:00:00Z."
},
"cursor": {
"type": "string",
"description": "`nextCursor` from the previous page, passed back verbatim; it is null on the last page. Omit it for the first page."
},
"symbol": {
"type": "string",
"description": "Hyperliquid instrument ticker, e.g. BTC, ETH, HYPE; a HIP-3 market is `dex:TICKER`, e.g. xyz:TSLA. `volume` only; omit for the whole venue (perps, builder-DEX perps included; spot and outcome markets are left out). Used by view: volume."
}
}
},
"annotations": {
"title": "Hyperliquid Stats",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| offset | ["integer","string"] | `search` only: rows to skip, 0 to 10000 (default 0); above 10000 is refused. |
| category | string | `trending` only: category filter (default all) |
| condition_id | string | `market` only, required there: the 0x-prefixed condition id. |
{
"name": "polymarket_markets",
"title": "Polymarket Markets",
"description": "Polymarket markets, by `view`. `trending` (default): top prediction-market events ranked by 24h volume. Returns market title, slug, category, current Yes/No mid quotes, 24h volume, and end_date. Filter by category (Crypto | Sports | Politics | Pop-Culture | Tech | all). Use for 'what's hot on Polymarket' or 'top crypto prediction markets'. `search`: the recorded markets whose slug contains every word of `query` (any order, case-insensitive: 'bitcoin up or down' finds bitcoin-up-or-down-…), optionally only active or only closed ones, newest end_date first, paged with `limit` and `offset`; rows {active, closed, condition_id, end_date (epoch), neg_risk, slug, tick_size, token_ids}, `active` / `closed` derived from the on-chain resolution and Polymarket's own flag (a filter on them is the slower read). `market`: one market by `condition_id` in that row shape, a list of 0 or 1 rows, from the recorded markets or else Polymarket's full catalogue (`source` says which; an unknown id is `[]`). Same data as GET /v1/polymarket/markets and /markets/{condition_id}.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"view": {
"enum": [
"trending",
"search",
"market"
],
"type": "string",
"default": "trending",
"description": "`trending` (default): top by 24h volume; `search`: filter the recorded markets; `market`: one market by condition_id."
},
"limit": {
"type": [
"integer",
"string"
],
"description": "Max markets: `trending` default 10, max 30; `search` default 50, max 100 (a larger value is clamped)."
},
"query": {
"type": "string",
"description": "`search` only: case-insensitive substring of the market slug."
},
"active": {
"type": [
"boolean",
"string"
],
"description": "`search` only: true = only active markets, false = only closed ones; omit for all. Not together with `closed`."
},
"closed": {
"type": [
"boolean",
"string"
],
"description": "`search` only: the complement of `active` (true = only closed). Not together with `active`."
},
"offset": {
"type": [
"integer",
"string"
],
"description": "`search` only: rows to skip, 0 to 10000 (default 0); above 10000 is refused."
},
"category": {
"type": "string",
"description": "`trending` only: category filter (default all)"
},
"condition_id": {
"type": "string",
"description": "`market` only, required there: the 0x-prefixed condition id."
}
}
},
"annotations": {
"title": "Polymarket Markets",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "token_holders",
"title": "Token Holders",
"description": "Top holders of an ERC-20 token by cumulative net inflow USD. Returns wallet, net flow USD, volume USD, tx count, first/last seen dates, and known labels. Use when the user asks 'top holders of X' or 'who holds the most of token Y'. sort='flow' (default) ranks by cumulative net inflow USD, a flow and not a holding. sort='balance' ranks by the on-chain balanceOf among candidate wallets chosen by net inflow and by volume (a holder outside both is not in it) and adds balance, value_usd, supply_pct, balance_basis, balance_approximate and candidate_coverage to each row; balance_basis is 'chain' for a balance read from the chain ('unsupported' means the row is still ranked by flow, as for a chain's native coin), balance_approximate is true when a candidate's balance could not be read or the total supply is unknown, and candidate_coverage is the share of the total supply the candidates' balances add up to. sort='balance' is not available on every chain (the error names it). exclude_exchanges=true drops wallets labelled as an exchange.",
"inputSchema": {
"type": "object",
"required": [
"token_address"
],
"properties": {
"sort": {
"enum": [
"flow",
"balance"
],
"type": "string",
"default": "flow",
"description": "flow = cumulative net inflow USD (default); balance = on-chain balanceOf among candidate wallets"
},
"chain": {
"enum": [
"ethereum",
"bsc",
"base",
"hyperevm"
],
"type": "string",
"default": "ethereum",
"description": "Chain (default ethereum)"
},
"limit": {
"type": [
"integer",
"string"
],
"default": 10,
"description": "Max holders (default 10, max 50)"
},
"token_address": {
"type": "string",
"description": "ERC-20 token contract address (0x-prefixed)"
},
"exclude_exchanges": {
"type": "boolean",
"default": false,
"description": "Drop wallets labelled as an exchange (default false)"
}
}
},
"annotations": {
"title": "Token Holders",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| Only transfers of at least this many tokens (whole tokens, not raw units, up to 1e18). Needs token_address (an amount across different tokens means nothing) and that token's decimals known, else an error. With min_usd, both must hold. Omit for no floor |
| token_address | string | Optional: restrict to one token |
{
"name": "wallet_transactions",
"title": "Wallet Transactions",
"description": "Raw per-wallet transfer list (single transactions, not aggregates). Filter by direction (in/out/all), days back, min USD, and optionally a specific token and, for that token, an amount range in whole tokens. Returns time, tx_hash, from, to, token_address, symbol, amount (whole tokens; null when the token's decimals are unknown), value_usd, direction, block. Use when the user asks 'show me recent transfers for X' / 'last 100 transactions of wallet Y' / forensic audit queries.",
"inputSchema": {
"type": "object",
"required": [
"address"
],
"properties": {
"days": {
"type": [
"integer",
"string"
],
"default": 30,
"description": "Days back (default 30, max 365)"
},
"chain": {
"enum": [
"ethereum",
"bsc",
"base",
"hyperevm"
],
"type": "string",
"default": "ethereum",
"description": "Chain (default ethereum)"
},
"limit": {
"type": [
"integer",
"string"
],
"default": 50,
"description": "Max transactions (default 50, max 500)"
},
"address": {
"type": "string",
"description": "Wallet address (0x-prefixed)"
},
"min_usd": {
"type": [
"number",
"string"
],
"default": 0,
"description": "Filter dust below this USD value (default 0)"
},
"direction": {
"enum": [
"in",
"out",
"all"
],
"type": "string",
"default": "all",
"description": "Transfer direction (default all)"
},
"max_amount": {
"type": [
"number",
"string"
],
"description": "Only transfers of at most this many tokens (whole tokens, not raw units, up to 1e18). Needs token_address (an amount across different tokens means nothing) and that token's decimals known, else an error. With min_usd, both must hold. Omit for no ceiling"
},
"min_amount": {
"type": [
"number",
"string"
],
"description": "Only transfers of at least this many tokens (whole tokens, not raw units, up to 1e18). Needs token_address (an amount across different tokens means nothing) and that token's decimals known, else an error. With min_usd, both must hold. Omit for no floor"
},
"token_address": {
"type": "string",
"description": "Optional: restrict to one token"
}
}
},
"annotations": {
"title": "Wallet Transactions",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "wallet_first_funder",
"title": "Wallet First Funder",
"description": "The earliest inbound transfers of a wallet, from our own transfer tables, as TWO separate answers: `first_native_in` (the first plain send of the chain's coin to the wallet, at least `min_native` WHOLE coins; `amount` in whole coins, `amount_wei` exact in wei) and `first_token_in` (the first token transfer priced at `min_usd` USD or more; `amount` in whole tokens). Each carries the sender, its label (entity, wallet_type, label_confidence), time, tx_hash, block and `amount_usd` in plain dollars (null = no USD price). This is NOT proof of who funded the wallet: native rows hold top-level sends only (coin moved by a contract call or a bridge is absent), history starts on a different date per chain (`coverage.history_from`), and the sender may be an exchange or a relay. `found` is false when neither exists. On hyperevm, protocol system addresses appear as senders and come back with wallet_type 'system' (no entity name). Use when the user asks 'who funded this wallet' / 'where did its first coins come from', and pass the coverage caveats on.",
"inputSchema": {
"type": "object",
"required": [
"address"
],
"properties": {
"chain": {
"enum": [
"ethereum",
"bsc",
"base",
"hyperevm"
],
"type": "string",
"default": "ethereum",
"description": "Chain (default ethereum)"
},
"address": {
"type": "string",
"description": "Wallet address (0x-prefixed)"
},
"min_usd": {
"type": [
"number",
"string"
],
"default": 1,
"description": "Floor for the token side in USD. Token transfers priced below it, or with no USD price, are skipped. Default 1; 0 = no floor (unpriced tokens, mostly spam, included)."
},
"min_native": {
"type": [
"number",
"string"
],
"default": 0.0001,
"description": "Dust floor for the native coin in WHOLE coins (ETH, BNB or HYPE; 0.01 means 0.01 coin, not wei). Inbound native transfers below it are skipped. Default 0.0001; 0 = no floor (the very first inbound, probing dust included)."
}
}
},
"annotations": {
"title": "Wallet First Funder",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| series | string | price = the price, about one tick a second (default); twap60 = its 60-second time-weighted average. |
| symbol * | string | btc, eth, sol, xrp, doge, bnb, hype or zec; btcusd, btc/usd and BTC-USD work too, in any case. |
| from_ms | ["integer","string"] | Bucket start, epoch MILLISECONDS, inclusive. Omit for the first recorded tick. |
| interval | string | 1s = every tick (default); wider = one row per UTC bucket, its first tick. |
{
"name": "polymarket_chainlink_prices",
"title": "Polymarket Chainlink Prices",
"description": "The price Polymarket's crypto up/down markets resolve on: Chainlink Data Streams prices, as Polymarket's live-data socket relays them for its crypto markets, for btc, eth, sol, xrp, doge, bnb, hype or zec in USD, from 2026-11-06 09:24:15 UTC to about a minute ago (rows are stored once a minute). series=price (default) is the price, about one tick a second; series=twap60 is its 60-second time-weighted average. interval=1s (default) returns every tick; 1m, 5m, 15m, 1h, 4h or 1d return one row per bucket aligned to UTC, the FIRST tick at or after the bucket's start: the price an up/down market compares at the start and the end of its window. For a 5-minute, 15-minute or hourly market from S to E pass interval = its length (5m, 15m or 1h), from_ms=S and to_ms=E+1: two rows, the price at its start and at its end. 4-HOUR AND DAILY MARKETS FOLLOW US EASTERN TIME, off the UTC grid of the 4h and 1d buckets: pass interval=1m with from_ms=S and to_ms=S+60000, and again with from_ms=E and to_ms=E+60000. Returns {rows, has_more, next_cursor}; each row {ts_ms (bucket start, epoch ms), price_ts_ms (the tick's own time), price (USD)}. `from_ms` is inclusive and `to_ms` exclusive, both on ts_ms. While has_more is true pass next_cursor back as `cursor`; a page can hold fewer rows than `limit` while has_more is true, and within the last two minutes a page ends at the last row stored so far. About 1.6% of seconds have no row and nothing is filled in: about 600 single seconds a day, about 17 gaps a day of 2 to 5 seconds, and about 85 a day of 6 to 30 seconds that nearly always every coin skips at once; the longest, 74 seconds, was 2026-11-06 11:15:33 to 11:16:46 UTC. Compare price_ts_ms with ts_ms. A page is 100 rows by default and at most 10,000.",
"inputSchema": {
"type": "object",
"required": [
"symbol"
],
"properties": {
"limit": {
"type": [
"integer",
"string"
],
"default": 100,
"description": "Rows per page (default 100, max 10000, as the REST route)."
},
"to_ms": {
"type": [
"integer",
"string"
],
"description": "Bucket start, epoch milliseconds, EXCLUSIVE; must be greater than from_ms. Omit for up to now."
},
"cursor": {
"type": "string",
"description": "The previous page's next_cursor, passed back unchanged."
},
"series": {
"enum": [
"price",
"twap60"
],
"type": "string",
"default": "price",
"description": "price = the price, about one tick a second (default); twap60 = its 60-second time-weighted average."
},
"symbol": {
"type": "string",
"description": "btc, eth, sol, xrp, doge, bnb, hype or zec; btcusd, btc/usd and BTC-USD work too, in any case."
},
"from_ms": {
"type": [
"integer",
"string"
],
"description": "Bucket start, epoch MILLISECONDS, inclusive. Omit for the first recorded tick."
},
"interval": {
"enum": [
"1s",
"1m",
"5m",
"15m",
"1h",
"4h",
"1d"
],
"type": "string",
"default": "1s",
"description": "1s = every tick (default); wider = one row per UTC bucket, its first tick."
}
}
},
"annotations": {
"title": "Polymarket Chainlink Prices",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| The market's condition id: 0x followed by 64 hex digits. |
{
"name": "polymarket_market_trades",
"title": "Polymarket Market Trades",
"description": "ONE Polymarket market's trades WITH the wallet behind each, newest first, paged: who traded, which side, how many shares and at what price, from 2026-01-01 to a few minutes ago, read from the on-chain trade tape. Takes the market's `condition_id` (0x plus 64 hex digits, from polymarket_markets or polymarket_market_detail), NOT an outcome token id. Returns {trades, has_more, next_cursor}; while has_more is true pass next_cursor back as `cursor` for the next, older page. `from_ms` is inclusive and `to_ms` exclusive (epoch ms). A page is 100 rows by default and at most 10,000; a row is ~430 characters (a 66-character transaction hash and a 42-character wallet), so ask for what the context window holds. ONE ROW IS ONE ORDER'S FILL, NOT ONE MATCH: a match is several rows (the resting `maker` orders that were hit, plus one `taker` row for the aggressor, whose size is the sum of theirs), so never add size * price over both roles. A few percent of fills are merged away, so a count can sit slightly under the on-chain total. `proxy_wallet` is Polymarket's proxy wallet, not necessarily the person's own address. For the recorded order book (no wallets) use polymarket_tape; for one wallet's whole record use polymarket_wallet.",
"inputSchema": {
"type": "object",
"required": [
"condition_id"
],
"properties": {
"limit": {
"type": [
"integer",
"string"
],
"default": 100,
"description": "Rows per page (default 100, max 10000, as the REST route)."
},
"to_ms": {
"type": [
"integer",
"string"
],
"description": "Trade time, epoch milliseconds, EXCLUSIVE; must be greater than from_ms. Omit for no upper bound."
},
"cursor": {
"type": "string",
"description": "The previous page's next_cursor, passed back unchanged."
},
"from_ms": {
"type": [
"integer",
"string"
],
"description": "Trade time, epoch MILLISECONDS, inclusive. Omit for the first trade."
},
"condition_id": {
"type": "string",
"description": "The market's condition id: 0x followed by 64 hex digits."
}
}
},
"annotations": {
"title": "Polymarket Market Trades",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| One outcome token id (decimal string). Give this or `token_ids`. |
| token_ids | string | Comma-separated outcome token ids, at most 100. Wins over `token_id` when both are given. |
| event_type | string | Return only this event type. Strongly recommended. |
{
"name": "polymarket_tape",
"title": "Polymarket Tape",
"description": "Raw Polymarket L2 event tape for ONE time window (at most 24 hours) on one or more outcome tokens, oldest first, from the recorded order-book feed. `token_id` / `token_ids` are ERC-1155 OUTCOME token ids (long decimal strings: read them off `clob_token_ids` in polymarket_market_detail or `outcomes[].token_id` in polymarket_markets); a market's condition_id (0x...) will NOT work. Event types: `trade` (price = probability in [0, 1], size = shares, side = buy | sell), `price_change`, `book` (the whole ladder in `bids` / `asks`, JSON carried as strings), `tick_size_change` (the new tick in `tick_size`, a field no other row has; from November 2026, earlier days have none), `status`. Always pass `event_type`: without it a page is mostly price_change and book rows. Returns {events, has_more, next_cursor}; pass next_cursor back as `cursor` for the next page. A 0 in `best_bid`, `best_ask`, `price` or `size` on a row type that does not populate it means absent, not a price of 0; `best_bid` and `best_ask` are recorded only since 2026-11-05 18:02 UTC, on `price_change` and `book` rows. The tape carries no wallet addresses. `to_ms` is EXCLUSIVE here, unlike `to` in polymarket_ohlcv.",
"inputSchema": {
"type": "object",
"required": [
"from_ms",
"to_ms"
],
"properties": {
"limit": {
"type": [
"integer",
"string"
],
"default": 100,
"description": "Events per page (default 100, max 50000, as REST /events)."
},
"to_ms": {
"type": [
"integer",
"string"
],
"description": "Required. Window end, epoch MILLISECONDS, EXCLUSIVE. Must be greater than `from_ms` and at most 86400000 (24 hours) after it."
},
"cursor": {
"type": "string",
"description": "`next_cursor` from the previous page; resumes strictly after it."
},
"from_ms": {
"type": [
"integer",
"string"
],
"description": "Required. Window start, epoch MILLISECONDS, inclusive."
},
"token_id": {
"type": "string",
"description": "One outcome token id (decimal string). Give this or `token_ids`."
},
"token_ids": {
"type": "string",
"description": "Comma-separated outcome token ids, at most 100. Wins over `token_id` when both are given."
},
"event_type": {
"enum": [
"book",
"price_change",
"trade",
"tick_size_change",
"status"
],
"type": "string",
"description": "Return only this event type. Strongly recommended."
}
}
},
"annotations": {
"title": "Polymarket Tape",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| date_to |
| string |
| view=datasets only. Last UTC day, YYYY-MM-DD, inclusive (the REST route spells it `to`). |
| date_from | string | view=datasets only. First UTC day, YYYY-MM-DD, inclusive (the REST route spells it `from`). |
{
"name": "polymarket_archive",
"title": "Polymarket Archive",
"description": "Index of the bulk Polymarket L2 archive: one Parquet file per UTC day and stream (book_events, trades, l1_quotes), either multi-asset ('flat') or per asset and tenor ('family', e.g. btc + 5m). view='datasets' (default) lists files, filtered and paged, with `bytes` and `rows` where recorded; view='url' resolves exactly one file to a download link (give `date` and `stream`, plus `asset` and `tenor` together for a family file). This tool never downloads anything: the link is valid for 7 days (`expires_at`) and needs no API key, so fetch it yourself and do not share it. `asset` and `tenor` match family files ONLY, so supplying either hides every flat file. Returns {datasets, limit, offset, total} for 'datasets', one dataset row for 'url'.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"date": {
"type": "string",
"description": "view=url only. Required there. The UTC day, YYYY-MM-DD."
},
"view": {
"enum": [
"datasets",
"url"
],
"type": "string",
"default": "datasets",
"description": "datasets = list files (default); url = resolve one file."
},
"asset": {
"type": "string",
"description": "Family files only, e.g. `btc`. With view=url give it together with `tenor`, or neither."
},
"limit": {
"type": [
"integer",
"string"
],
"default": 50,
"description": "view=datasets only. Files per page (default 50, max 1000; `total` counts every match)."
},
"tenor": {
"type": "string",
"description": "Family files only, e.g. `5m`. Pairs with `asset`."
},
"offset": {
"type": [
"integer",
"string"
],
"description": "view=datasets only. Skip this many matching files (default 0)."
},
"stream": {
"enum": [
"book_events",
"trades",
"l1_quotes"
],
"type": "string",
"description": "One stream. Required for view=url."
},
"date_to": {
"type": "string",
"description": "view=datasets only. Last UTC day, YYYY-MM-DD, inclusive (the REST route spells it `to`)."
},
"date_from": {
"type": "string",
"description": "view=datasets only. First UTC day, YYYY-MM-DD, inclusive (the REST route spells it `from`)."
}
}
},
"annotations": {
"title": "Polymarket Archive",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| Rows per page (default 20, max 50). |
| offset | ["integer","string"] | Rows to skip, 0 to 1000 (default 0). `rank` continues across pages; the board is rebuilt hourly, so a page fetched after a rebuild can repeat or skip a wallet. |
| window | string | The period behind trades_window, volume_window_usd and realized_pnl_window_usd (P&L of markets RESOLVED inside it), and what the *_window and volume_24h / trades_24h sorts rank on. Default all (lifetime). For 'top traders this week / month' pass 7d / 30d and leave sort out: the board then ranks on r… |
| category | string | Market category (default all). Every figure is recomputed on that category's markets only. |
| min_avg_usd | ["number","string"] | Minimum average trade size in USD (default 0). 20 drops every wallet tagged bot. |
| min_resolved | ["integer","string"] | Minimum resolved markets (a count). Default 20; 0 includes wallets too thin for a hit rate to mean anything. |
| min_volume_usd | ["number","string"] | Minimum lifetime volume in USD, buys plus sells (default 0). |
{
"name": "polymarket_leaderboard",
"title": "Polymarket Leaderboard",
"description": "Leaderboard of Polymarket wallets ranked by realized P&L, hit rate, volume or trade count, for all time or over a window, optionally within one market category. The same board vike.io/polymarket shows. Returns rows {rank, proxy_wallet, pseudonym, display_name, realized_pnl_usd (lifetime, USD, resolved markets only), realized_pnl_window_usd (USD over `window`, by resolution time), resolved_markets, hit_rate, hit_rate_ci, volume_all_usd, volume_window_usd (USD), trades_all, trades_window, avg_trade_usd, markets, first_seen, last_seen (UTC), tags}. `hit_rate` is a FRACTION from 0 to 1 (0.62 = 62%), volume-weighted (the share of the wallet's resolved dollar volume that sat in markets it won), not a count of wins; it is null, never 0, when the wallet has no resolved volume. `hit_rate_ci` is the +/- half-width of the 95% Wilson interval, also a fraction: read hit_rate +/- hit_rate_ci and distrust a hit_rate with a wide one; a near-100% rate on a sliver of P&L is an arbitrage pattern, not skill. `min_resolved` defaults to 20 so a hit rate rests on a real sample; 0 lists thinner wallets. `tags` are whale (lifetime volume $100k or more), bot (average trade under $20 over 100+ trades), hot / cold (lifetime P&L of +/-$1,000 on 5+ resolved markets). The top of a category is often bots with tens of thousands of resolved markets: check `tags` and `avg_trade_usd`, or pass min_avg_usd=20 to drop every bot-tagged wallet. `first_seen` is the wallet's first trade in the recorded tape, which starts on 2026-01-01, so it does not show that a wallet is new. The 24h / 7d / 30d windows are rebuilt hourly (hour-granular) and a market's resolution time can be corrected later, so a windowed figure can be revised; window=all is not affected. Page with `limit` and `offset`; ties break on the wallet address. Addresses are public on-chain data; this tool names no one.",
"inputSchema": {
"type": "object",
"required": [],
"properties": {
"sort": {
"enum": [
"realized_pnl",
"realized_pnl_asc",
"realized_pnl_window",
"realized_pnl_window_asc",
"hit_rate",
"resolved",
"volume_24h",
"volume_all",
"trades_24h",
"trades_all",
"last_seen",
"markets"
],
"type": "string",
"description": "Default: realized_pnl_window when `window` is 24h, 7d or 30d, realized_pnl when it is all. realized_pnl: lifetime USD, largest first, whatever the window. realized_pnl_asc: biggest losers first. realized_pnl_window / realized_pnl_window_asc: P&L inside `window`. hit_rate: highest first, nulls last; the top is often wallets that buy near-certain outcomes just under $1 (a 100% rate on a sliver of P&L), so set realized_pnl_usd against volume_all_usd before reading it as skill. resolved: most resolved markets. volume_24h / trades_24h: USD volume / trade count inside `window` (the names are historical; they follow `window`). volume_all, trades_all, markets: lifetime. last_seen: most recently active first."
},
"limit": {
"type": [
"integer",
"string"
],
"default": 20,
"description": "Rows per page (default 20, max 50)."
},
"offset": {
"type": [
"integer",
"string"
],
"default": 0,
"description": "Rows to skip, 0 to 1000 (default 0). `rank` continues across pages; the board is rebuilt hourly, so a page fetched after a rebuild can repeat or skip a wallet."
},
"window": {
"enum": [
"24h",
"7d",
"30d",
"all"
],
"type": "string",
"default": "all",
"description": "The period behind trades_window, volume_window_usd and realized_pnl_window_usd (P&L of markets RESOLVED inside it), and what the *_window and volume_24h / trades_24h sorts rank on. Default all (lifetime). For 'top traders this week / month' pass 7d / 30d and leave sort out: the board then ranks on realized_pnl_window_usd."
},
"category": {
"enum": [
"all",
"Crypto",
"Sports",
"Politics",
"Pop-Culture",
"Tech"
],
"type": "string",
"default": "all",
"description": "Market category (default all). Every figure is recomputed on that category's markets only."
},
"min_avg_usd": {
"type": [
"number",
"string"
],
"description": "Minimum average trade size in USD (default 0). 20 drops every wallet tagged bot."
},
"min_resolved": {
"type": [
"integer",
"string"
],
"default": 20,
"description": "Minimum resolved markets (a count). Default 20; 0 includes wallets too thin for a hit rate to mean anything."
},
"min_volume_usd": {
"type": [
"number",
"string"
],
"description": "Minimum lifetime volume in USD, buys plus sells (default 0)."
}
}
},
"annotations": {
"title": "Polymarket Leaderboard",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "search",
"title": "Search",
"description": "Search everything vike knows by name, symbol or address in one call, the same search as the vike.io search box. Sections: `tokens` (live price, 24h change and the page to open), `hl_markets` (Hyperliquid builder markets such as xyz:GOLD), `wallets` (labelled entities and wallets on Ethereum, BSC, Base and HyperEVM; an entity row has `wallet_count` and `url`, the vike.io page listing its wallets, and an `address` only when it is one wallet; a type word such as `cex`, `bridge` or `hacker` lists that type's biggest entities), `traders`, `vaults` and `builders` (Hyperliquid), `polymarket` (Polymarket wallets by name, pseudonym or address, with the owner of an account or the accounts a personal wallet owns), `markets` (open Polymarket markets holding every word, several markets of one event as one row {event_slug, title, markets_n}; closed ones only when nothing else matched), `predictfun` (open Predict.fun markets on BNB Chain whose title or question holds every word, the busiest (24 h volume) first, then the newest, each {market_id, title, question, status, url}; closed and resolved ones only when nothing else matched; a pasted address that has traded there is one {address, url} row) and `did_you_mean` (coins one typo away when no token matched). `q` may be free text, a 0x address (also inside a pasted URL), an ENS name (searched as the address it points to) or a polymarket.com link. Each section holds at most `limit` rows; a section whose read fails comes back empty rather than failing the call. `url` fields are vike.io paths. Use it to turn a name into an address or id before calling another tool. Same data as GET /v1/search.",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "What to look for, 1 to 256 characters: a name, symbol, label, address, ENS name or polymarket.com link. Filter words may go with it or alone: `chain:base` (eth, bsc, base, hyperevm), `type:cex` (an entity type), `pnl>1m` or `pnl<-100k` (traders' all-time PnL; k, m, b)."
},
"limit": {
"type": [
"integer",
"string"
],
"default": 5,
"description": "Rows per section, 1 to 20 (default 5)."
}
}
},
"annotations": {
"title": "Search",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "stream_events",
"title": "Stream Events",
"description": "Stored events of ONE stream channel after a cursor, oldest first, with the stream's own filters: the REST catch-up of wss://stream.vike.io, for what a socket missed or a quick look without a socket. Returns {events: [{cursor, event}], next_cursor, has_more}; `event` is byte for byte what the WebSocket frame carried. An idle window of the on-demand channel is an item {cursor, gap} in its place. Pass next_cursor back as `cursor` for the next page; a page at the end returns the channel head, so an empty page on a quiet channel returns the same cursor. Events are kept 3 days: an older cursor is refused with a resume cursor in the message. `since_ms` starts at an ARRIVAL time instead of a cursor. Delivery is at least once: dedupe on event.event_id. hl.fills without min_usd is min_usd 1000, as on the socket (0 = every fill). Every channel stream_info lists is accepted, including one the stream does not run yet (a subscribe there answers unknown_channel): its pages are empty, like a quiet channel's. Same data as GET /v1/{hyperliquid,onchain,polymarket}/stream-events.",
"inputSchema": {
"type": "object",
"required": [
"channel"
],
"properties": {
"limit": {
"type": [
"integer",
"string"
],
"default": 200,
"description": "Events per page, 1 to 1000 (default 200)."
},
"cursor": {
"type": "string",
"description": "`next_cursor` of the previous page or the `cursor` of a stream frame. Omit (and omit since_ms) for the oldest retained event."
},
"filter": {
"type": [
"object",
"string"
],
"description": "The channel's filter keys as on a subscribe, e.g. `{\"coin\": [\"BTC\"], \"min_usd\": 100000}`. An unknown or channel-foreign key is refused."
},
"channel": {
"type": "string",
"description": "A stream channel, e.g. `hl.fills`, `hl.liquidations`, `chain.transfers`, `pm.trades`; stream_info lists them all. Required."
},
"since_ms": {
"type": [
"integer",
"string"
],
"description": "Epoch MILLISECONDS: start after this arrival time instead of a cursor. Not together with `cursor`."
}
}
},
"annotations": {
"title": "Stream Events",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| string |
| EVM address (0x-prefixed, 42 chars), a wallet or a contract |
{
"name": "wallet_check",
"title": "Wallet Check",
"description": "Everything we know about ONE address in one call: a wallet checker / address lookup. Each part is its own block: `ens` (reverse ENS name), `tags` (names attached to the address, e.g. a token's name), `labels` (per chain: entity and wallet type), `label_sources` (which source claimed what about the address, read for Ethereum; third-party providers are named provider_a to provider_e), `label_origins` (BNB Chain, Base, HyperEVM: the origins each chain's label records and what each claimed, `origin` one of third_party (provider_a), model (our heuristic, with its source, confidence (null = not scored) and tier), cross_chain (copied from the same address's label on `from_chain`) or unknown; a claim can differ from the label), `onchain` (transfer count per chain where the address is active), `code` (per chain, the code found at the address when last checked: contract, eip7702 delegated wallet, safe multisig or proxy; a chain absent means no code when checked, or not checked), `token` (name, symbol and chain when it is a token contract), `first_funder` (per chain: the earliest inbound coin and priced token transfers we hold, with sender and label; not proof of who funded the wallet), `exchanges` (per chain: the centralised exchanges it sent to and received from over 365 days, a lower bound), `hl_trader`, `hl_vault`, `hl_builder` (its Hyperliquid identity), `polymarket` (the Polymarket account at this address, its owner, and the accounts it owns), `predictfun` (its Predict.fun fills, counted up to 100,000, first and last trade in epoch ms, and its realized P&L and volume from the leaderboard once ranked; null when it never traded there), and `summary` (plain observed facts read off the blocks, never a verdict such as 'safe'). first_funder and exchanges cover every chain the address has transfers on, or only `chain`. A block missing from the answer could not be read; an empty one means we looked and found nothing. Use when the user pastes an address and asks 'whose wallet is this', 'what is this address' or 'check this wallet'; for one chain's funder or exchanges with other floors or windows, use wallet_first_funder / wallet_exchange_usage.",
"inputSchema": {
"type": "object",
"required": [
"address"
],
"properties": {
"chain": {
"enum": [
"ethereum",
"bsc",
"base",
"hyperevm"
],
"type": "string",
"description": "Read first_funder and exchanges on this chain only (default: every chain the address has transfers on)"
},
"address": {
"type": "string",
"description": "EVM address (0x-prefixed, 42 chars), a wallet or a contract"
}
}
},
"annotations": {
"title": "Wallet Check",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| address * | string | Wallet address (0x-prefixed) |
{
"name": "wallet_positions",
"title": "Wallet Positions",
"description": "A wallet's per-token positions on one chain with real profit and loss. Per token: token_address, symbol, name, bought_qty and bought_usd, sold_qty and sold_usd, avg_buy_price and avg_sell_price (USD per token), realized_pnl_usd, balance (read from the chain at request time), price_usd (latest daily price), value_usd and unrealized_pnl_usd = balance x (price_usd - avg_buy_price), null when either is unknown. Bought and sold are the wallet's priced inbound and outbound transfers of the token (a swap, a move between its own wallets and an exchange deposit all count); a transfer with no USD price (a mint, a pre-listing airdrop) is neither. Realized PnL is average cost: only units that were bought are realized, the chain's coin and its wrapped token (WETH, WBNB, WHYPE) are one position under the zero address, and Ethereum stablecoins and disabled tokens are left out. `totals` cover EVERY token the wallet traded, not only the rows returned: realized_pnl_usd, unrealized_pnl_usd (over the tokens where it is known), tokens_traded, tokens_profitable and `as_of`, when the wallet's lifetime PnL in the wallet rankings was last recomputed (updated nightly at 04:00 UTC); the positions count trades up to the latest priced transfers, so the two differ only when the wallet traded since. USD in plain dollars. `found` is false for a wallet with no priced trade. Use when the user asks 'what did this wallet make on each token' / 'is it in profit' / 'what is it holding and at what cost'; wallet_pnl_history is a daily net-flow series, not this.",
"inputSchema": {
"type": "object",
"required": [
"address"
],
"properties": {
"sort": {
"enum": [
"realized",
"unrealized",
"value"
],
"type": "string",
"default": "realized",
"description": "Rank positions by realized PnL, unrealized PnL or current value (default realized). Unknown values sort last"
},
"chain": {
"enum": [
"ethereum",
"bsc",
"base",
"hyperevm"
],
"type": "string",
"default": "ethereum",
"description": "Chain (default ethereum)"
},
"limit": {
"type": [
"integer",
"string"
],
"default": 20,
"description": "Positions returned (default 20, max 100); totals always cover every token"
},
"order": {
"enum": [
"desc",
"asc"
],
"type": "string",
"default": "desc",
"description": "desc = biggest first (default), asc = biggest losses first"
},
"address": {
"type": "string",
"description": "Wallet address (0x-prefixed)"
}
}
},
"annotations": {
"title": "Wallet Positions",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}