/api/hl/vault-profile/:addr
GETPartial

Hyperliquid vault profile

Hyperliquid vault profile (positions, performance)

GET/api/hl/vault-profile/:addr
Partial coverage. Parent vaults (such as HLP) hold positions in child vaults, so `positions`, `topCoins` and `daily` can be empty for them.

Request

Query parameters

NameTypeRequiredDefaultAllowed valuesDescription
addr pathstringRequired——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.

FieldTypeUnitDescription
successboolean—true when the request succeeded. On failure the body is `{ success: false, code, error, request_id }`.
updatednumbermsWhen the data was last updated.
addressstring—On-chain address.
vaultobject—Directory record of the vault with its latest position totals; null when the address is not a known vault.
vault.namestring—Name.
vault.leaderstring—Vault leader address.
vault.tvlnumberUSDTotal value locked in the vault.
vault.aprnumber—Annualised return of the vault.
vault.isClosedboolean—True when Hyperliquid lists the vault as closed.
vault.relTypestring—Relationship type from Hyperliquid's vault directory: `parent`, `child` or `normal`.
vault.parentAddressnull—Address of the parent vault when this is a child vault; null otherwise.
vault.createTimenumbermsTimestamp.
vault.accountValuenumberUSDAccount equity.
vault.positionValuenumberUSDPosition notional.
vault.longValuenumberUSDLong notional.
vault.shortValuenumberUSDShort notional.
vault.totalUpnlnumberUSDTotal unrealised PnL.
vault.posPolledAtnumbermsWhen positions were last polled.
vault.syncedAtnumbermsTimestamp.
positionsarray—Open positions. empty in the samples used to generate this table
stylenull—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.
topCoinsarray—Largest coins. empty in the samples used to generate this table
dailyarray—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

PartialChecked 2026-11-13 03:58:38 UTCHTTP 2003 msSchema matchesNewest data point 0s old

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 →

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/vault-profile/:addrPartial
Parameters

string — 0x-prefixed 40-hex address; 400 on bad format.

Request URLhttps://www.coinboss.com/api/hl/vault-profile/0xdfc24b077bc1425ad1dea75bcb6f8158e10df303
Choose an endpoint and press “Send request”. The response, headers and timing will appear here.