Vault API Introduction

Welcome to the Teahouse Vault API Documentation

This API provides a RESTful HTTP interface for accessing Teahouse Vault data.

Vault Types

The API supports permissionless vaults of the following types:

• V3Pair: A single Uniswap V3 LP pair (e.g., USDC-USDT)

• V3Port: A portfolio of multiple Uniswap V3 positions

For example, in a V3Pair vault like USDC-USDT:

• token0 = USDC

• token1 = USDT

Precision and Decimals

• Percentages are expressed with a precision of at least 4 decimal places.

• Share token prices are denominated in token0 and scaled by:

For example: Raw share token price in token0 = 1000045241250000000000000 , 1000045241250000000000000 / (10^(18+6)) = 1.000045241250000000000000 USDC

• All V3Port (portfolio) vaults use 18 decimals for the asset token.

Special Address Handling

In transaction records, the address 0x0000000000000000000000000000000000000000 indicates an interaction involving a smart contract rather than an externally owned account (EOA). Specifically:

• If this address appears as the sender, it represents a token mint operation.

• If it appears as the receiver, it represents a token burn operation.

---

API Standard

• https://vault-content-api.teahouse.finance

• https://vault-api.teahouse.finance

Status Code

• 200 success

• 400 bad request (client side errors with message)

• 401 unauthorized (API Key verification failed)

• 500 server side error (database/contract errors, etc.)

Return Format

All API return data in JSON format.

• Success with data { "dataKey1":"Value1", "dataKey2":"Value2", "dataKey3":"Value3", }

• Success with no data {}

• Errors { "error": "I am error message", "details": [ // string array, only exists when error has details "detail message 1", "detail message 2" ] }

Tip: You can find detailed API endpoints and their usage in the left sidebar under “Vault API”.