GETAvailable
Hyperliquid whale long/short split
Hyperliquid whale long/short split
GET
/api/hl/whales/long-shortRequest
Query parameters
| Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|
| coin | string | Optional | — | — | Filter by coin. |
Example request
curl -s "https://www.coinboss.com/api/hl/whales/long-short"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. |
| coin | null | — | Coin symbol, upper case (for example BTC). |
| longAddrs | number | — | Number of addresses that are long. |
| shortAddrs | number | — | Number of addresses that are short. |
| longUsd | number | USD | Long notional. |
| shortUsd | number | USD | Short notional. |
| longUpnl | number | USD | Sum of unrealised PnL of the tracked long positions (filtered by `coin` when given). |
| shortUpnl | number | USD | Sum of unrealised PnL of the tracked short positions (filtered by `coin` when given). |
| latestSnapshot | number | ms | Newest position snapshot time among the rows counted; null when there are none. |
| byCoin | array | — | Top 15 coins by total tracked position value, with long / short address counts and notional; empty when `coin` is given. |
| byCoin[] | object | — | One coin. |
| byCoin[].coin | string | — | Coin symbol, upper case (for example BTC). |
| byCoin[].longAddrs | number | — | Number of addresses that are long. |
| byCoin[].shortAddrs | number | — | Number of addresses that are short. |
| byCoin[].longUsd | number | USD | Long notional. |
| byCoin[].shortUsd | number | USD | Short notional. |
Generated 2026-11-11 23:00 UTC from 1 real responses.
Example response
/api/hl/whales/long-short · Real response captured 2026-11-13 04:03:10 UTC. Long arrays and maps are shortened for display: byCoin had 15 items.
- "success"true
- "updated"1794542590962
- "coin"null
- "longAddrs"1251
- "shortAddrs"754
- "longUsd"2292861113.61
- "shortUsd"2668168301.19
- "longUpnl"-226757447.39
- "shortUpnl"325258708.86
- "latestSnapshot"1794542471343
- "byCoin"
Details
- Authentication
- None. Public endpoint.
- Rate limit
- 1200 requests per minute per IP
- Server cache
- 30s
- Edge micro-cache
- 10s
- Update frequency
- positions every 5 min; API cache 30 s
- Window
- latest snapshot
- Data sources
- Long/short head-count and notional of tracked Hyperliquid whales, aggregated in-house from polled positions.
- Exchange coverage
- tracked whale pool (addresses that made a single fill >= 50,000 USD, were liquidated, or run a vault); not the whole network
- Pagination
- none
- Units
- USD; counts
- Method
- long = SUM(position_value where size > 0); short = SUM(position_value where size < 0); byCoin = top 15 coins by notional
- Timestamps
- Unix epoch milliseconds (UTC) unless the field description says otherwise
- Response format
- json
- Stability
- Stable
Live status
AvailableChecked 2026-11-13 04:03:10 UTCHTTP 20032 msSchema matchesNewest data point 0s old
Availability, last 30 days
100% of 410 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/whales/long-shortAvailableParameters
string — Filter by coin.
Request URL
https://www.coinboss.com/api/hl/whales/long-shortChoose 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