> ## 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.

# Home

> The global overview page showing total TVL, vault count, best APY, and a filterable vault list.

<img src="https://mintcdn.com/superform-cb7ef652/MhEzTvzQXPC-eNn0/operate/images/screenshots/home.jpg?fit=max&auto=format&n=MhEzTvzQXPC-eNn0&q=85&s=88610e7e7f9da8732952e560b4bb1401" alt="SuperformOS Operate landing — selected vault and setup status" width="1594" height="2148" data-path="operate/images/screenshots/home.jpg" />

The **Home** page (`/`) is the top-level entry point at [os.superform.xyz](https://os.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:

| Card | Description |
| - | - |
| **Total TVL** | Aggregate USD value locked across all vaults |
| **Total Vaults** | Number of deployed SuperVaults |
| **Best APY** | Highest current annualized yield across all vaults |

## Vault List

Below the overview cards, a searchable and filterable vault list displays every deployed SuperVault:

| Field | Description |
| - | - |
| Vault Name | Operator-defined name |
| Underlying Asset | Token depositors supply (USDC, WETH, etc.) |
| TVL (USD) | Total value locked |
| APY | Current annualized yield |
| Chain | Ethereum or Base |

### Filtering and Search

| Control | Options |
| - | - |
| Chain filter | All, Ethereum (1), Base (8453) |
| Search | Text match by vault name or asset |

Clicking a vault opens the public read-only vault route at `/supervaults/{chain_name}/{vaultAddress}`. That route uses the same allocator-facing dashboard context described in [Dashboard](/operate/ui/dashboard), while manager-only actions remain in Operate.

## Navigation Context

Home sits alongside the operator and distribution sections in SuperformOS:

| Section | Path | Purpose |
| - | - | - |
| **Home** | `/` | Global overview — TVL, vault count, APY, vault list |
| **Operate** | `/operate` | Per-vault operation - dashboard, setup, strategy, simulation, merkle trees, yield sources, and settings |
| **Distribute** | `/distribute` | Vault and provider distribution workflows |

## API Reference

| Endpoint | Method | Auth | Description |
| - | - | - | - |
| `/api/v1/public/vaults` | GET | None | All vault deployments with TVL/APY |
| `/api/v1/registry/token-assets` | GET | None | Token metadata (symbol, decimals, logo) |

```json theme={null}
// 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).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.