Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.superbots.finance/llms.txt

Use this file to discover all available pages before exploring further.

A SuperVault is a vault-of-vaults: a single smart contract that holds your deposit and distributes it across a group of connected individual trading vaults. Instead of choosing and monitoring one strategy at a time, you deposit once into the SuperVault and the system rebalances allocations across all participating vaults automatically. Performance metrics for a SuperVault are computed as the average of the metrics of all its connected vaults.

Fetching SuperVaults

GET /vaults/supervaults
Returns all Supervault entities where isActive = true or tvl > 0. Results are cached for 60 seconds. The Supervault entity shares most fields with Vault but uses a single currency field instead of currency1/currency2, because all connected vaults share the same deposit token. Key fields returned:
FieldDescription
idSuperVault identifier
nameDisplay name
chainBlockchain network (defaults to bsc)
contractAddressOn-chain contract address
currencyDeposit token for this SuperVault
perfFeesPerformance fee percentage
depositFeeFee charged on deposit
withdrawalFeeFee charged on withdrawal
safetyLevelNumeric safety rating
riskLevelText risk classification
strategyStrategy description
maxCapMaximum accepted TVL
tvlCurrent total value locked
perf3 / perf6 / perf123-, 6-, and 12-month average performance %
perfTotAverage monthly performance across all months
mddAverage maximum drawdown % across connected vaults
botOverMarketAverage outperformance vs market %
SuperVault performance fields (perf3, perf6, perf12, perfTot, mdd, botOverMarket) are averages computed from all vaults whose supervault field matches this SuperVault’s id. The update runs every 6 hours.

Trade history

To retrieve the 50 most recent trades executed by any vault connected to a SuperVault:
GET /vaults/supervault-trades-history/{vaultId}
Each record in the response includes:
FieldDescription
openAtTimestamp when the trade opened
closeAtTimestamp when the trade closed
entryPricePrice at trade open
closePricePrice at trade close
openTxOpening transaction hash
closeTxClosing transaction hash
vaultIdID of the individual vault that executed the trade
tradeSignalSignal label from the parent vault’s tradeSignal field
chainNetwork the trade occurred on

How rebalancing works

The SuperVault smart contract distributes your deposit across connected vaults according to its allocation weights. Rebalancing happens automatically on-chain — you do not need to take any action. You can tell which individual vaults are part of a SuperVault by checking the vault detail page, which shows the parent SuperVault relationship.

SuperVault detail view

The SuperVault detail page shows everything you need to evaluate and manage your position:

Overview banner

Displays the SuperVault name, chain, currency, and top-level performance figures.

Strategy

Shows the strategy description for this SuperVault.

Summary cards

A summary grid showing your balance, max drawdown, TVL, and chain.

Deposit & withdraw

Deposit and withdrawal controls, including a link to the contract on BscScan and a display of fees and max capital.

Performance chart

Performance chart built from the monthly performance data.

Trade history

Table of the 50 most recent trades across all connected vaults.

Depositing into a SuperVault

The deposit and withdrawal flow for SuperVaults is identical to standard vaults and uses the same POST /vaults/deposit and POST /vaults/withdraw endpoints with the SuperVault’s id as the vaultId. See Depositing and withdrawing for full details.
Depositing into a SuperVault exposes you to the combined risk of all connected vaults. Review each vault’s risk level and strategy before depositing.