Hyperliquid vault profile
Hyperliquid vault profile (positions, performance)
/api/hl/vault-profile/:addrRequest
Query parameters
| Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|
| addr path | string | Required | — | — | 0x-prefixed 40-hex address; 400 on bad format. Example: 0xdfc24b077bc1425ad1dea75bcb6f8158e10df303 |
Parameters marked “path” are part of the URL.
Example request
curl -s "https://www.coinboss.com/api/hl/vault-profile/0xdfc24b077bc1425ad1dea75bcb6f8158e10df303"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. |
| address | string | — | On-chain address. |
| vault | object | — | Directory record of the vault with its latest position totals; null when the address is not a known vault. |
| vault.name | string | — | Name. |
| vault.leader | string | — | Vault leader address. |
| vault.tvl | number | USD | Total value locked in the vault. |
| vault.apr | number | — | Annualised return of the vault. |
| vault.isClosed | boolean | — | True when Hyperliquid lists the vault as closed. |
| vault.relType | string | — | Relationship type from Hyperliquid's vault directory: `parent`, `child` or `normal`. |
| vault.parentAddress | null | — | Address of the parent vault when this is a child vault; null otherwise. |
| vault.createTime | number | ms | Timestamp. |
| vault.accountValue | number | USD | Account equity. |
| vault.positionValue | number | USD | Position notional. |
| vault.longValue | number | USD | Long notional. |
| vault.shortValue | number | USD | Short notional. |
| vault.totalUpnl | number | USD | Total unrealised PnL. |
| vault.posPolledAt | number | ms | When positions were last polled. |
| vault.syncedAt | number | ms | Timestamp. |
| positions | array | — | Open positions. empty in the samples used to generate this table |
| style | null | — | Trading-style profile built from the vault's fills on the days with data in the last 30 days (volume, taker share, turnover); null when no fills are recorded. |
| topCoins | array | — | Largest coins. empty in the samples used to generate this table |
| daily | array | — | Daily values. empty in the samples used to generate this table |
Generated 2026-11-11 23:00 UTC from 1 real responses.
Example response
/api/hl/vault-profile/0xdfc24b077bc1425ad1dea75bcb6f8158e10df303 · Real response captured 2026-11-13 03:58:38 UTC.
- "success"true
- "updated"1794542318769
- "address""0xdfc24b077bc1425ad1dea75bcb6f8158e10df303"
- "vault"
- "name""Hyperliquidity Provider (HLP)"
- "leader""0x677d831aef5328190852e24f13c46cac05f984e7"
- "tvl"150199834.32
- "apr"0.226572
- "isClosed"false
- "relType""parent"
- "parentAddress"null
- "createTime"1683243596849
- "accountValue"10173298.97
- "positionValue"0
- "longValue"0
- "shortValue"0
- "totalUpnl"0
- "posPolledAt"1794542171335
- "syncedAt"1794542172182
- "positions"
- "style"null
- "topCoins"
- "daily"
Details
- Authentication
- None. Public endpoint.
- Rate limit
- 1200 requests per minute per IP
- Server cache
- 30s
- Edge micro-cache
- 10s
- Update frequency
- directory every 30 min; positions every 5 min; fills every 10 s; API cache 30 s
- Window
- 30 days of daily aggregates; top coins from stored fills
- Data sources
- Vault profile: directory info, current positions with liquidation distance, trading-style metrics and 30-day daily aggregates built from vault fills read from our own node.
- Exchange coverage
- Any vault in the official directory; positions only for vaults with TVL >= 10,000 USD
- Pagination
- none
- Units
- USD; ratios as decimals
- Method
- takerRatio = taker notional / total notional; dailyTurnover = volume / days / TVL; liqDistance = |mark - liqPx| / mark with mark = positionValue / |size|
- Timestamps
- Unix epoch milliseconds (UTC) unless the field description says otherwise
- Response format
- json
- Stability
- Stable
Live status
Parent vaults (such as HLP) hold positions in child vaults, so `positions`, `topCoins` and `daily` can be empty for them.
Availability, last 30 days
100% 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 →
| 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
/api/hl/vault-profile/:addrPartialstring — 0x-prefixed 40-hex address; 400 on bad format.
https://www.coinboss.com/api/hl/vault-profile/0xdfc24b077bc1425ad1dea75bcb6f8158e10df303More 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