/api/hl/whales/long-short
GETAvailable

Hyperliquid whale long/short split

Hyperliquid whale long/short split

GET/api/hl/whales/long-short

Request

Query parameters

NameTypeRequiredDefaultAllowed valuesDescription
coinstringOptional——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.

FieldTypeUnitDescription
successboolean—true when the request succeeded. On failure the body is `{ success: false, code, error, request_id }`.
updatednumbermsWhen the data was last updated.
coinnull—Coin symbol, upper case (for example BTC).
longAddrsnumber—Number of addresses that are long.
shortAddrsnumber—Number of addresses that are short.
longUsdnumberUSDLong notional.
shortUsdnumberUSDShort notional.
longUpnlnumberUSDSum of unrealised PnL of the tracked long positions (filtered by `coin` when given).
shortUpnlnumberUSDSum of unrealised PnL of the tracked short positions (filtered by `coin` when given).
latestSnapshotnumbermsNewest position snapshot time among the rows counted; null when there are none.
byCoinarray—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[].coinstring—Coin symbol, upper case (for example BTC).
byCoin[].longAddrsnumber—Number of addresses that are long.
byCoin[].shortAddrsnumber—Number of addresses that are short.
byCoin[].longUsdnumberUSDLong notional.
byCoin[].shortUsdnumberUSDShort 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": [
      • { … 5 },
      • { … 5 }
      ]
    }

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 →

CodeHTTPMeaningWhat to do
INVALID_PARAM400A 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.
UNAUTHORIZED401The `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.
FORBIDDEN403The route is not part of the public API (internal or account-only).Do not retry.
NOT_FOUND404Unknown route, or the requested coin / exchange / fund does not exist.Do not retry; check the path and identifiers against the catalog.
RATE_LIMITED429More requests than the per-minute limit. `Retry-After` gives the seconds to wait.Wait for `Retry-After`, then retry with backoff.
INTERNAL500Unexpected 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_FAILED503The 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.
UNAVAILABLE501 / 503The 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_FAILED200Some 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-shortAvailable
Parameters

string — Filter by coin.

Request URLhttps://www.coinboss.com/api/hl/whales/long-short
Choose an endpoint and press “Send request”. The response, headers and timing will appear here.