Hyperliquid vault detail
Hyperliquid vault detail
/api/hl/vault/:addrRequest
Query parameters
| Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|
| addr path | string | Required | — | — | 0x-prefixed 40-hex address; 400 on bad format; 404 if vault unknown. Example: 0xdfc24b077bc1425ad1dea75bcb6f8158e10df303 |
Parameters marked “path” are part of the URL.
Example request
curl -s "https://www.coinboss.com/api/hl/vault/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. |
| name | string | — | Name. |
| vaultAddress | string | — | Address of the vault. |
| leader | string | — | Vault leader address. |
| description | string | — | Description text written by the vault leader, as published by Hyperliquid; empty string when none. |
| apr | number | — | Annualised return of the vault. |
| maxDistributable | number | USD | Maximum amount the vault can currently pay out to depositors, as reported by Hyperliquid. |
| isClosed | boolean | — | True when the vault is closed. |
| allowDeposits | boolean | — | False only when Hyperliquid reports that the vault does not accept deposits. |
| followerCount | number | count | Number of depositor records Hyperliquid returns for the vault (the list is capped, so large vaults show the cap); null when not returned. |
| portfolio | object | — | Account-value and PnL history of the vault per time window. dynamic keys: day,week,month,allTime,perpDay,perpWeek |
| portfolio.{*} | object | — | Keys are the windows `day`, `week`, `month`, `allTime` and the perpetual-only `perpDay`, `perpWeek`, `perpMonth`, `perpAllTime`. |
| portfolio.{*}.accountValueHistory | array | — | Account value of the vault over the window, oldest first. |
| portfolio.{*}.accountValueHistory[] | array | — | One point: `[timestamp, account value]`. |
| portfolio.{*}.accountValueHistory[][] | number | — | First element is the timestamp in ms, second the account value in USD. |
| portfolio.{*}.pnlHistory | array | — | Cumulative PnL of the vault since the start of the window, oldest first. |
| portfolio.{*}.pnlHistory[] | array | — | One point: `[timestamp, cumulative PnL]`. |
| portfolio.{*}.pnlHistory[][] | number | — | First element is the timestamp in ms, second the cumulative PnL in USD. |
| portfolio.{*}.vlm | number | USD | Trading volume of the vault in the window, as reported by Hyperliquid. |
Generated 2026-11-11 23:00 UTC from 1 real responses.
Example response
/api/hl/vault/0xdfc24b077bc1425ad1dea75bcb6f8158e10df303 · Real response captured 2026-11-13 03:58:38 UTC. Long arrays and maps are shortened for display: portfolio had 8 items; portfolio.{*}.pnlHistory had 63 items; portfolio.{*}.accountValueHistory had 63 items.
- "success"true
- "updated"1794542319008
- "name""Hyperliquidity Provider (HLP)"
- "vaultAddress""0xdfc24b077bc1425ad1dea75bcb6f8158e10df303"
- "leader""0x677d831aef5328190852e24f13c46cac05f984e7"
- "description""This community-owned vault provides liquidity to Hyperliquid through multiple market making strategies, performs liquidations, and accrues platform fees."
- "apr"0.22667592086684252
- "maxDistributable"10172508.94846
- "isClosed"false
- "allowDeposits"true
- "followerCount"100
- "portfolio"
- "day"
- "week"
Details
- Authentication
- None. Public endpoint.
- Rate limit
- 1200 requests per minute per IP
- Server cache
- 60s
- Edge micro-cache
- 10s
- Update frequency
- fetched on request; API cache 60 s
- Window
- day / week / month / allTime portfolio series as provided upstream
- Data sources
- Vault details and equity/PnL curves passed through from Hyperliquid's official info API.
- Exchange coverage
- Any Hyperliquid vault address
- Pagination
- none
- Units
- USD
- Timestamps
- Unix epoch milliseconds (UTC) unless the field description says otherwise
- Response format
- json
- Stability
- Stable
Live status
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/:addrAvailablestring — 0x-prefixed 40-hex address; 400 on bad format; 404 if vault unknown.
https://www.coinboss.com/api/hl/vault/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