Monitoring & API

circle-info

API services are only available for indexed vaults. Please reach out to the team to get your vault enabled.

Monitor your vault's performance and health using the Voltr API and SDK.

Voltr API

The Voltr API provides read-only endpoints for querying vault data. This is the recommended approach for monitoring and user-facing applications.

Base URL: https://api.voltr.xyz

Full documentation: api.voltr.xyz/docsarrow-up-right

SDK Query Methods

The SDK provides methods for querying on-chain vault state directly. Use these when you need real-time data or data not available through the API.

import { VoltrClient } from "@voltr/vault-sdk";
import { Connection, PublicKey } from "@solana/web3.js";

const connection = new Connection("your-rpc-url");
const client = new VoltrClient(connection);
const vault = new PublicKey("your-vault-address");

Vault State

// Get full vault account data
const vaultData = await client.getVault(vault);
console.log("Total assets:", vaultData.asset.totalValue.toString());
console.log("Admin:", vaultData.admin.toBase58());
console.log("Manager:", vaultData.manager.toBase58());

Fee Information

Share Price & LP Supply

Best Practices

circle-info

API for reads, SDK for writes: Use the Voltr API for monitoring, dashboards, and user-facing queries. Use the SDK for manager/admin operations that require signing transactions.

Use Case
Recommended

Dashboard / UI showing vault data

Voltr API

Monitoring vault APY over time

Voltr API

User deposit/withdraw UI

Voltr API

Checking fees before harvesting

SDK (real-time)

Automation scripts (rebalancing)

SDK

What to Monitor

Key Metrics

  • Share price trend — is the vault generating positive yield?

  • Total assets vs. idle assets — what percentage is deployed vs. idle?

  • APY — is performance meeting expectations?

  • Fee accumulation — are fees ready to harvest?

  • Strategy health — are all strategies performing as expected?

Alert Triggers

Consider setting up alerts for:

  • Share price decreasing (potential loss event)

  • Idle balance dropping below threshold (withdrawal pressure)

  • Strategy returning errors

  • SOL balance running low on admin/manager wallets

Last updated