/api/hl/coin
GETAvailable

Hyperliquid per-coin whale positions page data

Hyperliquid per-coin whale positions page data (paginated)

GET/api/hl/coin

Request

Query parameters

NameTypeRequiredDefaultAllowed valuesDescription
symbolstringRequired——Coin symbol (upper-cased); 404 when no data. Example: BTC
pageintegerOptional1≥ 1Page number (1-based). Example: 1
sizeintegerOptional12≥ 1 · ≤ 100Page size. Example: 12

Example request

curl -s "https://www.coinboss.com/api/hl/coin?symbol=BTC&page=1&size=12"

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 }`.
dataobject—Payload.
data.symbolstring—Instrument symbol as normalised by CoinBoss (for example BTCUSDT).
data.positionsnumber—Open positions.
data.total_value_usdnumberUSDSum of position values (long + short) of all tracked whale positions in this coin at their latest snapshot.
data.unrealized_pnl_usdnumberUSDSum of unrealised PnL over all tracked whale positions in this coin.
data.long_value_usdnumberUSDSum of position values of tracked long positions in this coin.
data.short_value_usdnumberUSDSum of position values of tracked short positions in this coin.
data.avg_leveragenumberxSimple (unweighted) average of the leverage setting across the tracked positions, rounded to one decimal.
data.snapshot_atnumbermsTime of the snapshot.
data.pagenumber—Current page (1-based).
data.sizenumber—Page size.
data.total_pagesnumbercountNumber of pages available at the requested `size`.
data.top_positionsarray—Positions on the requested page, largest position value first.
data.top_positions[]object—One tracked position (one address in this coin).
data.top_positions[].addressstring—On-chain address.
data.top_positions[].address_fullstring—Full account address; `address` is the shortened display form.
data.top_positions[].sidestring—`long` / `short` or `buy` / `sell`.
data.top_positions[].sizenumber—Page size.
data.top_positions[].entry_pxnumberUSDAverage entry price of the position.
data.top_positions[].value_usdnumberUSDValue.
data.top_positions[].pnl_usdnumberUSDUnrealised PnL of the position at its latest snapshot.
data.top_positions[].leveragenumber—Leverage of the position.
data.top_positions[].liq_pxnumber|nullUSDLiquidation price reported by Hyperliquid at the snapshot; null when the position has none.

Generated 2026-11-11 23:00 UTC from 3 real responses.

Example response

/api/hl/coin?symbol=BTC&page=1&size=12 · Real response captured 2026-11-13 03:58:26 UTC. Long arrays and maps are shortened for display: data.top_positions had 12 items.

  • {
    • "success": true,
    • "data": {
      • "symbol": "BTC",
      • "positions": 983,
      • "total_value_usd": 1748485942.46,
      • "unrealized_pnl_usd": 33759163.82,
      • "long_value_usd": 728625990.49,
      • "short_value_usd": 1019859951.97,
      • "avg_leverage": 28.1,
      • "snapshot_at": 1794542171335,
      • "page": 1,
      • "size": 12,
      • "total_pages": 82,
      • "top_positions": [ … 2 ]
      }
    }

Verified samples

Besides the example above, the probe calls this endpoint with these parameters and checks the schema each time.

ParametersHTTPLatencyResult
page=1&size=12&symbol=ETH2006 msPass
page=1&size=12&symbol=SOL2005 msPass

Checked 2026-11-13 03:28:24 UTC

Details

Authentication
None. Public endpoint.
Rate limit
1200 requests per minute per IP
Server cache
2m
Edge micro-cache
10s
Update frequency
positions every 5 min; in-memory cache 120 s
Window
latest position snapshot
Data sources
Tracked Hyperliquid whale positions in one coin: long/short totals, average leverage and the largest positions with liquidation prices.
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
page + size (1-100, default 12); total_pages returned
Sorting
position value desc
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:52:57 UTCHTTP 2005 msSchema matchesNewest data point 2m old

Availability, last 30 days

99.76% 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 →

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/coinAvailable
Parameters

string — Coin symbol (upper-cased); 404 when no data.

integer · default 1 · min 1 — Page number (1-based).

integer · default 12 · min 1 · max 100 — Page size.

Request URLhttps://www.coinboss.com/api/hl/coin?symbol=BTC&page=1&size=12
Choose an endpoint and press “Send request”. The response, headers and timing will appear here.