API Reference

Welcome to the Vault Street API

The Vault Street API provides programmatic access to Vault Street's tokenized vault ecosystem, enabling developers to integrate vault performance data and wallet position tracking into their applications.

OpenAPI / UI: https://external-api.vaultstreet.com/openapi/ui/index.html Base URL: https://external-api.vaultstreet.com/ API Key: Request an API key at [e-mail]

API Overview

The Vault Street API v1 is public and read-only, and covers two core areas:

Vaults

Access core information about Vault Street's vaults, including:

• Vault symbol, contract address, chain, and underlying asset

• Current price-per-share and TVL

• Historical price-per-share and TVL series, over a choice of time windows

• Operational wallets associated with each vault

Positions

Query what a wallet holds and has requested:

• Current balance and USD-denominated value per vault

• Total portfolio value across all vaults

• Deposit and withdrawal request history, with status

Supported Vaults

The API currently supports:

• primeUSD (prime-usd)

• CARRY ( carry)

Getting Started

Base URL

All API requests should be made to:

OpenAPI / UI: https://external-api.vaultstreet.com/openapi/ui/index.html Base URL: https://external-api.vaultstreet.com/ API Key: Request an API key at [e-mail]

API Endpoints

Tokenized Vaults

• GET /vaults — List all vaults

• GET /vaults/{vault} — Get a vault's core data with its current price-per-share and TVL

• GET /vaults/{vault}/metrics/{interval} — Get a vault's price-per-share and TVL history

Positions

• GET /positions/{wallet} — Get what a wallet holds across all vaults

• GET /positions/{wallet}/requests — Get a wallet's deposit and withdrawal request history

Response Format

All API responses follow a consistent JSON structure with appropriate HTTP status codes:

• 200 — Successful responses

• 400 — Validation errors, with details on what was invalid

• 403 — Missing, unknown, or wrongly-scoped API key

• 500 — Unhandled server error

Important Notes

• Vaults are addressed by slug (prime-usd, carry), not by contract address, and slugs are case-insensitive.

---

This API documentation covers Vault Street API v1.0.0. Features and endpoints may evolve as the platform develops.