`vaultDetails`

Returns one vault's profile and state: name, leader, TVL, total shares, profit share, deposit settings, its parent or child vaults, and its depositors. Use it to render a vault page.

POST/infotype vaultDetails

Render a vault page: profile, TVL, lock-up, depositors, and one user’s withdrawable amount.

Request body

typestringrequired

Must be `vaultDetails`.

"vaultDetails"

vaultAddressstring · addressrequired

Vault to read. The sample is the testnet Liquidity Provider vault.

userstring · addressoptional

Depositor to report on. When set, `followerState` replaces `followers` and `maxWithdrawable` is this user’s.

Request example

curl -X POST https://rpc.txflow-testnet.xyz/info \
  -H "Content-Type: application/json" \
  -H "x-api-version: 2026-08-16" \
  -d '{
  "type": "vaultDetails",
  "vaultAddress": "0x664989a76069c2b153720745bc1c3c8eeee504c1"
}'

Try it

POST https://rpc.txflow-testnet.xyz/info

Response 200

codeinteger

`0` on success.

dataobject

allowDepositsboolean

alwaysCloseOnWithdrawboolean

createTimeMillisinteger

Creation time, Unix ms.

descriptionstring

isClosedboolean

leaderstring · address

Vault operator. For a child vault, its parent vault.

leaderCommissionstring

Leader’s profit share as a fraction (`0.1` = 10%).

leaderFractionnumber

Fraction of `totalShares` held by the leader.

maxDistributablestring

maxWithdrawablestring

USDC the `user` can withdraw now; `0.000000` when `user` is omitted.

namestring

relationshipobject

totalSharesstring

Shares outstanding.

tvlstring

Total value locked, USDC.

vaultAddressstring · address

followersobject[]

Depositors. Omitted when `user` is set.

followerStateobject

The `user`’s position. Present only when `user` is set.

successboolean

`false` on error, with `code` set and the text in `message` instead of `data`.

Response example

{
  "success": true,
  "code": 0,
  "data": {
    "name": "Liquidity Provider",
    "vaultAddress": "0x664989a76069c2b153720745bc1c3c8eeee504c1",
    "leader": "0xa84f1e04f1d66e4f326b55eb045ae3b931d31b54",
    "tvl": "104084637.190682",
    "isClosed": false,
    "relationship": {
      "type": "parent",
      "data": {
        "childAddresses": [
          "0x299d36d36a217abef8a61081bdc724b4f7057848",
          "0x89a9e22d834ac85688589c342bde69bacb24f41d"
        ]
      }
    },
    "createTimeMillis": 1762760933000,
    "description": "This vault provides liquidity to TxFlow through multiple market making strategies, performs liquidations, and accrues platform fees.",
    "totalShares": "104694308.658889",
    "leaderCommission": "0.000000",
    "allowDeposits": true,
    "alwaysCloseOnWithdraw": true,
    "followers": [
      {
        "user": "0x0032a9aceea6afb7f2a17b2759e7ab3c8f1dc31b",
        "vaultEquity": "29.997435",
        "shares": "30.173143",
        "costBasis": "30.000000",
        "vaultEntryTime": 1792564787350,
        "lockupUntil": 1792910487446,
        "pnl": "-0.002564",
        "allTimePnl": "-0.002564"
      }
    ],
    "leaderFraction": 0.039738133114642415,
    "maxDistributable": "104084637.190682",
    "maxWithdrawable": "0.000000"
  }
}

One depositor's view

Add user to read one depositor's position. The response then carries followerState (that user's equity, PnL, and lock-up) instead of the followers list, and maxWithdrawable is the USDC that user can withdraw now.

{ "type": "vaultDetails", "vaultAddress": "0x664989a76069c2b153720745bc1c3c8eeee504c1", "user": "0x091564806dce41ffeebafbc417e73b6849b1c29e" }

Parent and child vaults

relationship.type is normal, parent, or child. A parent vault lists its children in relationship.data.childAddresses; a child vault's leader is its parent. A parent's positions and orders live on its children; read each child with clearinghouseState and frontendOpenOrders.

For every vault one user holds, use uservaultequities.