GETAvailable
Hyperliquid whale position list
Hyperliquid whale position list
GET
/api/hl/whalesRequest
Query parameters
| Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|
| sort | string | Optional | value | value, pnl, pnl_abs, leverage, account | Sort key. |
| dir | string | Optional | desc | asc, desc | Sort direction. |
| limit | integer | Optional | 50 | ≤ 200 | Number of rows to return. Example: 50 |
| coin | string | Optional | — | — | Filter by coin. |
Example request
curl -s "https://www.coinboss.com/api/hl/whales?limit=50"Response fields
The field table is generated from real responses, so it lists exactly what the endpoint returns. Paths use a[] for array items and {*} for objects keyed by a dynamic name such as a coin or an exchange.
| Field | Type | Unit | Description |
|---|---|---|---|
| success | boolean | — | true when the request succeeded. On failure the body is `{ success: false, code, error, request_id }`. |
| updated | number | ms | When the data was last updated. |
| rows | array | — | Result rows. |
| rows[] | object | — | Result rows. |
| rows[].address | string | — | On-chain address. |
| rows[].coin | string | — | Coin symbol, upper case (for example BTC). |
| rows[].side | string | — | `long` / `short` or `buy` / `sell`. |
| rows[].szi | number | — | Signed position size in coins (negative = short). |
| rows[].entryPx | number | USD | Average entry price. |
| rows[].positionValue | number | USD | Position notional. |
| rows[].unrealizedPnl | number | USD | Unrealised profit and loss. |
| rows[].roe | number | fraction | Unrealised PnL divided by the margin of the position, as Hyperliquid reports it (0.13 = 13 %); null when it is zero or missing. |
| rows[].leverage | number | — | Leverage of the position. |
| rows[].leverageType | string | — | Margin mode of the position: `cross` or `isolated`. |
| rows[].marginUsed | number | USD | Margin used by the position. |
| rows[].liquidationPx | number | USD | Estimated liquidation price. |
| rows[].fundingSinceOpen | number | USD | Cumulative funding since the position was opened, in Hyperliquid's sign convention (positive = paid, negative = received); null when not published. |
| rows[].openedAt | null | — | Timestamp. |
| rows[].accountValue | number | USD | Account equity. |
| rows[].addrVolume | number | USD | Cumulative notional of the address's large fills recorded since it has been tracked; not its full trading volume. |
| rows[].liqCount | number | count | Liquidations of the address on Hyperliquid recorded since it has been tracked. |
| rows[].snapshotTs | number | ms | Time of the position snapshot. |
| rows[].labels | array | — | Labels. |
| rows[].labels[] | object | — | Labels. |
| rows[].labels[].label | string | — | Label. |
| rows[].labels[].type | string | — | Type. |
Generated 2026-11-11 23:00 UTC from 1 real responses.
Example response
/api/hl/whales?limit=50 · Real response captured 2026-11-13 03:58:41 UTC. Long arrays and maps are shortened for display: rows had 50 items; rows[].labels had 3 items.
- "success"true
- "updated"1794542321682
- "rows"
Details
- Authentication
- None. Public endpoint.
- Rate limit
- 1200 requests per minute per IP
- Server cache
- 30s
- Edge micro-cache
- 10s
- Update frequency
- new addresses every 10 s; positions of the top 300 addresses every 5 min; labels daily; API cache 30 s
- Window
- latest position snapshot per address
- Data sources
- Positions of tracked Hyperliquid whale addresses: the pool is built from large fills seen by our own Hyperliquid node and positions are polled from the official info API; address labels come from the official leaderboard, hypurrscan and our own rules.
- Exchange coverage
- tracked whale pool (addresses that made a single fill >= 50,000 USD, were liquidated, or run a vault); not the whole network (about 1,750 addresses with open positions)
- Pagination
- limit (default 50, max 200); filter coin
- Sorting
- sort = value (default) | pnl | pnl_abs | leverage | account; dir = desc | asc
- Units
- USD; size in coin units
- Timestamps
- Unix epoch milliseconds (UTC) unless the field description says otherwise
- Response format
- json
- Stability
- Stable
Live status
AvailableChecked 2026-11-13 03:58:41 UTCHTTP 20013 msSchema matchesNewest data point 0s old
Availability, last 30 days
100% of 409 checks passed
Errors
Failed calls share one shape on every endpoint. The full list is on the errors page. Errors and rate limits →
| Code | HTTP | Meaning | What to do |
|---|---|---|---|
| INVALID_PARAM | 400 | A required parameter is missing or a value is not accepted. `param` names the parameter when it is known. | Do not retry unchanged; fix the request. |
| UNAUTHORIZED | 401 | The `CB-API-KEY` header was sent but the key is unknown or revoked. Public data needs no key — drop the header or use a valid key. | Do not retry unchanged. |
| FORBIDDEN | 403 | The route is not part of the public API (internal or account-only). | Do not retry. |
| NOT_FOUND | 404 | Unknown route, or the requested coin / exchange / fund does not exist. | Do not retry; check the path and identifiers against the catalog. |
| RATE_LIMITED | 429 | More requests than the per-minute limit. `Retry-After` gives the seconds to wait. | Wait for `Retry-After`, then retry with backoff. |
| INTERNAL | 500 | Unexpected server error. The message is generic by design; quote `request_id` when reporting it. | Retry once after a few seconds; report it with the request id if it persists. |
| UPSTREAM_FAILED | 503 | The data source behind this endpoint did not answer in time. No stale or substitute numbers are returned in its place. | Retry with backoff; check the status page. |
| UNAVAILABLE | 501 / 503 | The dataset is temporarily not ready (cache warming) or the endpoint has no lawful public source yet. | Retry later; the catalog marks endpoints that are unavailable by design. |
| REQUEST_FAILED | 200 | Some older endpoints answer HTTP 200 with `success: false`. Always check `success`, not only the HTTP status. | Depends on the message; treat as a failed request. |
Try it
GET
/api/hl/whalesAvailableParameters
string · default value — Sort key.
string · default desc — Sort direction.
integer · default 50 · max 200 — Number of rows to return.
string — Filter by coin.
Request URL
https://www.coinboss.com/api/hl/whales?limit=50Choose an endpoint and press “Send request”. The response, headers and timing will appear here.
More in this category
- Hyperliquid account state for an address /api/hl/address/:addr
- Hyperliquid per-coin whale positions page data /api/hl/coin
- HYPE burn overview /api/hl/hype-burn
- HYPE burn statistics /api/hl/hype-burn-stats
- HYPE burn / buyback transactions /api/hl/hype-burn-txs
- Hyperliquid address labels /api/hl/labels/:addr
- Hyperliquid position-size distribution /api/hl/margin-distribution
- Hyperliquid perp market list /api/hl/markets
- Hyperliquid wallet PnL distribution /api/hl/pnl-distribution
- Hyperliquid position summary /api/hl/position-summary
- Hyperliquid smart-money leaderboard /api/hl/smart-money
- Hyperliquid tier × coin heatmap /api/hl/symbol-heatmap
- Hyperliquid tier detail /api/hl/tier/:slug
- Addresses within a Hyperliquid tier /api/hl/tier/:slug/addresses
- Hyperliquid vault fills /api/hl/vault-fills
- Hyperliquid vault deposit / withdrawal flows /api/hl/vault-flows
- Hyperliquid vault profile /api/hl/vault-profile/:addr
- Hyperliquid vault detail /api/hl/vault/:addr
- Hyperliquid vault list /api/hl/vaults
- Hyperliquid vault overview table /api/hl/vaults/overview
- Hyperliquid whale open / close activity /api/hl/whale-actions
- Hyperliquid single-whale detail /api/hl/whale/:addr
- Hyperliquid whale position list /api/hl/whales
- Hyperliquid whale long/short split /api/hl/whales/long-short
- Hyperliquid whale-pool statistics /api/hl/whales/stats