Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.superform.xyz/llms.txt

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

The Home page (/) is the top-level entry point at institutions.superform.xyz. It provides a global overview of all SuperVault deployments. No authentication required. Data refreshes from GET /api/v1/public/vaults (Erebor) with a 5-minute stale time.

Overview Cards

Three summary cards appear at the top of the page:
CardDescription
Total TVLAggregate USD value locked across all vaults
Total VaultsNumber of deployed SuperVaults
Best APYHighest current annualized yield across all vaults

Vault List

Below the overview cards, a searchable and filterable vault list displays every deployed SuperVault:
FieldDescription
Vault NameInstitution-defined name
Underlying AssetToken depositors supply (USDC, WETH, etc.)
TVL (USD)Total value locked
APYCurrent annualized yield
ChainEthereum or Base
ControlOptions
Chain filterAll, Ethereum (1), Base (8453)
SearchText match by vault name or asset
Clicking a vault navigates to its Dashboard under the Curate section at /dashboard?chainId={id}&vaultAddress={addr}. Home is one of three top-level sections in the institutional dashboard:
SectionPathPurpose
Home/Global overview — TVL, vault count, APY, vault list
Curate/dashboardPer-vault curation — dashboard, strategy, merkle trees, yield sources, settings, alerts
Institutional/manageInstitutional operations — deployers, providers, vault registry, and approval queues

API Reference

EndpointMethodAuthDescription
/api/v1/public/vaultsGETNoneAll vault deployments with TVL/APY
/api/v1/registry/token-assetsGETNoneToken metadata (symbol, decimals, logo)
// GET /api/v1/public/vaults — response shape
[
  {
    "vault_address": "0x...",
    "escrow_address": "0x...",
    "chain_id": 8453,
    "name": "USDC Yield Vault",
    "symbol": "svUSDC",
    "vault_share_decimals": 18,
    "underlying_asset_symbol": "USDC",
    "underlying_asset_decimals": 6,
    "underlying_asset_address": "0x...",
    "tvl_usd": 1250000.00,
    "apy": 0.0847
  }
]
Token metadata is fetched separately via GET /api/v1/registry/token-assets?chain_id={}&addresses={} and cached for the session (infinite stale time).