Contents

Whale position changes

Whale position changes (open, close, increase, decrease, flip, liquidated), newest first.

GET/api/v1/whales/feedEvery keyPaginated

Description

Use since as a polling cursor. Stored history: open / close / flip / liquidated 400 days, increase / decrease 90 days.

Available with every key and keyless (X-Blockmetric-Access: public). Keys of Free accounts get free-tier data (real-time feeds, 30 days of history, heatmap over time for every coin over the last 24 hours, liquidation levels now for every coin, the same as the free web plan); Pro and Desk keys the data of their plan; API Dev / API Pro raise the limits.

No key: 24 h
Free: 30 days
Pro: 365 days
Desk: 1095 days
API Dev: 365 days
API Pro: 1095 days

History window per plan. Limits: Authentication & limits.

Parameters

Parameters of /whales/feed
Parameter	Description
`coin`string	Coin name as on Hyperliquid (BTC, ETH, kPEPE, HIP-3 names like xyz:TSLA); case-insensitive.
`minUsd`number	Minimum absolute USD change, default 0.≥ 0 · default 0
`since`string	ISO 8601 time; only events after it (optional). Clamped to the plan history (free key 30 days, keyless 24 h): older events are never returned, also not via cursor.ISO 8601, e.g. 2026-10-23T12:00:00Z
`limit`integer	Number of items, default 50, clamped to 1–500.1–500 · default 50
`cursor`string	Next page: the value of meta.nextCursor from the previous response (keep the other parameters unchanged). Cursors are signed: an edited cursor answers 400; paging stops at the plan history.
`fields`string	Comma-separated fields of every item to return, e.g. ts,address,coin,kind,usdDelta (case-insensitive). All other fields are left out, so large lists get much smaller; an unknown name answers 400 with the list of fields. Default: every field.
`format`string	json (default: the { data, meta } envelope) \| csv (the rows with a header line; nested values as JSON text) \| ndjson (one JSON object per row and line). csv and ndjson carry the meta block in headers: Link rel="next" and X-Blockmetric-Next-Cursor (next page), X-Blockmetric-Next-After (forward polling), X-Blockmetric-Updated-At, X-Blockmetric-Warnings, X-Blockmetric-License. Errors stay JSON.one of json, csv, ndjson · default json

Response fields

Every success is { data, meta }; these are the fields of data. meta is the same on every endpoint.

Response fields of /whales/feed
Field	Description
`[].id`integer	Stable id of the item; on paginated feeds the order key together with ts.
`[].ts`string (ISO 8601)	Time of the event (ISO 8601 UTC).
`[].address`string	Hyperliquid address, lowercase.
`[].label`string · nullable	Display label: a public label with a cited source, else the self-chosen leaderboard name (unverified).
`[].coin`string	Coin name as on Hyperliquid (BTC, kPEPE, HIP-3 names like xyz:TSLA).
`[].kind`"open" \| "close" \| "increase" \| "decrease" \| "flip" \| "liquidated"	Kind of whale position change (liquidated = confirmed by the wallet’s Hyperliquid liquidation fills).
`[].side`"long" \| "short" · nullable	Position side (long / short); for trades and orders the side named in the description.
`[].sizeDelta`number · nullable	Change in coins.
`[].usdDelta`number · nullable	Change (USD).
`[].price`number · nullable	Price in the quote currency of the venue (USD / USDT / USDC).
`[].data`any	Kind-specific details (JSON) or null.

Errors

400invalid_param Invalid parameter
401unauthorized Missing or invalid API key
403plan_required Plan does not include this
403scope_required Key not scoped for this API
403ip_not_allowed Address not on the IP allowlist of the key
403origin_not_allowed Key used from a browser origin it does not allow
403source_restricted Exchange data not redistributed
403https_required https required
429rate_limited Per-minute limit reachedretry
429daily_limit_exceeded Daily limit reachedretry
429stream_limit Too many open streamsretry
500internal_error Internal errorretry

Request

curl -s -H "X-Blockmetric-Access: public" \
  "https://api.blockmetric.io/v1/whales/feed?limit=20"

Example response

HTTP 200Real data from 2026-10-27 13:12 UTC

{
  "data": [
    {
      "id": 225062,
      "ts": "2026-10-27T13:12:18.534Z",
      "address": "0x7d0c59691fec7f3fea385cdc3126c37a41d91b28",
      "label": null,
      "coin": "HYPE",
      "kind": "increase",
      "side": "short",
      "sizeDelta": 724.16,
      "usdDelta": 56918.98,
      "price": 78.6,
      "data": {
        "prevSize": 99843.61,
        "newSize": 100567.77,
        "prevSide": "short",
        "entryPx": 77.7659,
        "liqPx": 116.084417506,
        "leverage": 7,
        "leverageType": "cross",
        "prevUnrealizedPnl": -65771.220533,
        "prevPolledAt": "2026-10-27T13:09:39.844Z",
        "polledAt": "2026-10-27T13:12:18.534Z",
        "positionUsd": 7904626.72,
        "prevPositionUsd": 7847707.75
      }
    },
    {
      "id": 225061,
      "ts": "2026-10-27T13:12:16.653Z",
      "address": "0xa63be3806dbaa5b8dfc62a4e1d93d7a530567de7",
      "label": null,
      "coin": "SUI",
      "kind": "decrease",
      "side": "short",
      "sizeDelta": -50000,
      "usdDelta": -45879.5,
      "price": 0.91759,
      "data": {
        "prevSize": 475000,
        "newSize": 425000,
        "prevSide": "short",
        "entryPx": 0.91869,
        "liqPx": 1.0340492211,
        "leverage": 10,
        "leverageType": "cross",
        "prevUnrealizedPnl": -1104.922007,
        "prevPolledAt": "2026-10-27T12:46:55.875Z",
        "polledAt": "2026-10-27T13:12:16.653Z",
        "positionUsd": 389975.75,
        "prevPositionUsd": 435855.25
      }
    }
  ],
  "meta": {
    "updatedAt": "2026-10-27T13:12:18.534Z",
    "source": "hyperliquid",
    "sources": [
      "hyperliquid"
    ],
    "plan": "api_dev",
    "delayMinutes": 0,
    "commercial": false,
    "license": {
      "id": "internal",
      "display": false,
      "attributionRequired": false,
      "attribution": null,
      "redistribution": false,
      "mauCap": null,
      "terms": "https://blockmetric.io/terms#api-license"
    },
    "attribution": {
      "text": "Data by Blockmetric · Source: Blockmetric Research",
      "url": "https://blockmetric.io/"
    },
    "access": {
      "historyDays": 365,
      "historyFrom": "2025-10-27T13:14:00.000Z"
    },
    "nextCursor": "<cursor>",
    "nextUrl": "https://api.blockmetric.io/v1/whales/feed?cursor=<cursor>"
  }
}

More options: open in the explorer · SDK method whaleFeed() / whale_feed()

Code snippets in these docs are licensed under MIT-0: copy them into your own code without attribution. The SDKs, CLI and MCP server will be, once published, Apache-2.0; the name Blockmetric is not licensed (forks must be renamed). Data from the API is governed by the API terms; third-party exchange data by the exchange’s terms.

Whale position changes

Description

Who can call it

Parameters

Response fields

Errors