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.

Trading vaults are smart contracts that hold your deposited tokens and execute algorithmic trades on your behalf. You deposit a supported token into a vault, the on-chain strategy runs automatically, and you withdraw your balance — plus or minus any gains or losses — whenever you choose. Each vault tracks its own performance history, total value locked (TVL), and fee structure so you can compare vaults before committing funds.

Standard vaults

Spot trading vaults of type standard. These vaults trade a currency pair (e.g. BTC/USDT) on-chain and do not use leverage. Suitable for lower-risk algorithmic strategies.

Perpetual vaults

Leveraged vaults of type perp. These vaults trade perpetual futures contracts and apply a leverage multiplier when calculating performance. Higher potential returns come with higher risk.

SuperVaults

Vault-of-vaults that aggregate multiple trading bots under a single deposit. Performance metrics are averaged across the connected vaults, and the SuperVault contract rebalances allocations automatically.

​
Vault properties

Every vault exposes a consistent set of fields from the Vault entity. Understanding these fields helps you evaluate a vault before depositing.

​
Identity and configuration

​
id
string
Unique identifier for the vault, used in all API calls.
​
name
string
Human-readable display name.
​
chain
string
default:"bsc"
Blockchain network the vault is deployed on. Defaults to bsc (BNB Smart Chain).
​
contractAddress
string
On-chain address of the vault smart contract.
​
currency1
string
The deposit/withdrawal token (e.g. USDT, BUSD). This is the token you deposit and receive back.
​
currency2
string
The traded asset (e.g. BTC, ETH). The strategy buys and sells this asset.
​
vaultType
VaultType enum
One of standard, perp, POOL1, POOL2, POOL3, VAULT1, VAULT2, or VAULT3.
​
leverage
integer
default:"1"
Leverage multiplier applied when calculating performance. Standard vaults use 1; perp vaults use higher values.
​
isActive
boolean
default:"true"
Whether the vault is currently accepting deposits and executing trades.
​
isNew
boolean
default:"false"
Flags recently launched vaults.

​
Fees

​
perfFees
decimal
Performance fee charged as a percentage of profits.
​
depositFee
decimal
default:"0"
Fee deducted at deposit time, expressed as a percentage of the deposit amount.
​
withdrawalFee
decimal
default:"0"
Fee deducted at withdrawal time, expressed as a percentage of the withdrawal amount.

​
Capacity and value

​
maxCap
string
Maximum total value the vault will accept. Once reached, new deposits are blocked.
​
tvl
real
Current total value locked in the vault, refreshed periodically.

​
Risk and strategy

​
safetyLevel
integer
Numeric safety rating assigned to the vault.
​
riskLevel
string
Text risk classification (e.g. low, medium, high).
​
strategy
string
Description of the trading strategy used by the vault.

​
Performance metrics

The following fields are recalculated every 6 hours from the vault’s closed trade history.
​
perf3
decimal
Compounded performance over the last 3 months, expressed as a percentage.
​
perf6
decimal
Compounded performance over the last 6 months, expressed as a percentage.
​
perf12
decimal
Compounded performance over the last 12 months, expressed as a percentage.
​
perfTot
decimal
Average monthly performance across all recorded months, expressed as a percentage.
​
mdd
decimal
Maximum drawdown — the largest peak-to-trough loss recorded in the vault’s history, expressed as a percentage.
​
botOverMarket
decimal
Outperformance relative to the market: perf12 minus the 12-month return of the traded asset on CoinGecko. A positive value means the vault outperformed simply holding the asset.

​
SuperVault linkage

​
supervault
string
ID of the SuperVault this vault belongs to, if any.
​
supervaultId
integer
default:"-1"
Numeric index of the parent SuperVault. -1 means no parent.
​
supervaultConnected
boolean
default:"false"
Whether this vault is actively connected to a SuperVault and contributes its trades to the SuperVault trade history.

​
Next steps

Perpetual vaults

Learn about leveraged vault strategies on perpetual futures.

SuperVaults

Understand vault-of-vaults and automatic rebalancing.

Depositing and withdrawing

Step-by-step guide to moving funds in and out of vaults.

Performance metrics

Understand how vault performance is calculated and displayed.