Vault Shareholders

public/get_vault

Returns the full vault record — on-chain state plus curator metadata — for one vault subaccount id. Unauthenticated and read-only.

post/public/get_vault

Request

  • Base URL: https://api.derive.xyz/v3
  • URL: https://api.derive.xyz/v3/public/get_vault
  • Auth: none declared

Request body

subaccount_idinteger required

Response

Success

benchmark_pricestring decimal nullable

USD spot price of the HWM benchmark asset (1.0 for feed-less USD vaults). null when a configured benchmark has no resolvable price.

curatorstring required

20-byte Ethereum address as a 0x-prefixed lowercase hex string.

curator_sharesstring decimal required

Shares held by the curator (the vault subaccount's owner) — their skin-in-the-game. Same units as protocol.total_shares.

descriptionstring required
mtm_capstring decimal nullable

Optional non-negative decimal string of the human value (e.g. "1.5"), up to 12 fractional digits, or null; a string or JSON number is accepted

namestring required
nav_benchmarkstring decimal nullable

Live NAV expressed in the HWM benchmark asset's units. null when the vault couldn't be priced or its configured benchmark has no spot price.

nav_usdstring decimal nullable

Live mark-to-market NAV (USD) — signed, so an insolvent vault surfaces as a negative value. null only when the vault couldn't be priced (e.g. missing data). Divide by protocol.total_shares for the pre-fee share price.

simulated_share_price_usdstring decimal nullable

Live share price (USD/share) as if curator fees were settled now — the price a depositor/withdrawer faces. null when unpriceable or the vault is insolvent (a fee settlement on negative NAV is meaningless).

whitelist_onlyboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.