GET
/api/v1/hyperliquid/whale-positions/{address}Standard tier+ · 300 req/minAll currently-open positions for a single whale address.
Returns one row per (coin, side) for the given address. Useful for wallet-centric dashboards or to cross-check a leaderboard entry against their actual book.
Path parameters
Segments of the URL path, validated server-side.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| address | string | required | — | 0x-prefixed 40-char hex address. |
Query parameters
This endpoint takes no query parameters.
Response shape
Always wrapped in the standard envelope. Nullable fields are explicitly marked — treat missing numeric data as a real data-source gap, not as an error.
data payloadtypescript
// Wrapped in the standard envelope:
// {
// data: /* shape below */,
// meta?: { total?: number; limit?: number; offset?: number; ... }
// }
{
address: string;
positions: Array<WhalePosition>;
summary: { count: number; totalSizeUsd: number; totalUnrealizedPnl: number };
}Example
Copy the curl, replace YOUR_KEY with a real key from your dashboard, and run.
Requestbash
curl -sS "http://localhost:3000/api/v1/hyperliquid/whale-positions/0xabcabc..."Responsejson
{ "data": { "address": "0x...", "positions": [], "summary": { "count": 0, "totalSizeUsd": 0, "totalUnrealizedPnl": 0 } }, "meta": { "total": 0 } }Notes
- 404 on malformed address; 200 with empty positions on unknown-but-valid addresses.
Next
Check the error code reference, or get an API key to try the request against your own account.