Aggregate whale positions by coin
hl_whale_positions[PREMIUM — needs an API key: call hl_request_free_key first for a free key, or pay per call via x402] Aggregated positioning of a whale cohort for a coin (or all coins): total long/short size & notional, long/short wallet counts, weighted-average entry, net bias, and change vs 1h/24h ago. Cohort = cohort arg or HL_WHALE_ADDRESSES. Analytics only, not investment advice.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "hl_whale_positions"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dex | No | Perp dex: omit for the main dex, a HIP-3 builder dex name (e.g. 'xyz'), or 'all' for every dex (at most 20 wallets). | |
| coin | No | Restrict to one coin (a HIP-3 coin like 'xyz:XYZ100' reads its own dex); omit for all coins. | |
| topN | No | Max wallets to include from the cohort. | |
| cohort | No | Explicit list of 0x wallet addresses. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dex | Yes | ||
| asOf | Yes | ||
| coins | Yes | ||
| source | Yes | ||
| disclaimer | Yes | ||
| walletsQueried | Yes | ||
| walletsCappedTo | Yes | ||
| walletsRequested | Yes |