GET
/
v1
/
vaults
/
vault
Python (SDK)
from compass_api_sdk import CompassAPI, models


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.erc_4626_vaults.vaults_vault(chain=models.V1VaultsVaultChain.ETHEREUM, vault_address="0x182863131F9a4630fF9E27830d945B1413e347E8")

    # Handle response
    print(res)
{
  "name": "<string>",
  "symbol": "<string>",
  "decimals": 123,
  "total_assets": "<string>",
  "total_supply": "<string>",
  "share_price": "<string>",
  "underlying_token": {
    "address": "<string>",
    "name": "<string>",
    "symbol": "<string>",
    "decimals": 123
  },
  "apy": {
    "current": "<string>",
    "apy_1_day": "<string>",
    "apy_7_day": "<string>",
    "apy_30_day": "<string>"
  },
  "user_position": {
    "amount_of_shares": "<string>",
    "amount_in_underlying_token": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Query Parameters

chain
enum<string>
default:ethereum
required
Available options:
arbitrum,
base,
ethereum
block
integer | null

Optional block number (defaults to latest).

vault_address
string
default:0x182863131F9a4630fF9E27830d945B1413e347E8
required

The vault address of the desired vault position.

user_address
string | null
default:0xb8340945eBc917D2Aa0368a5e4E79C849c461511

The user address of the desired vault position. Only include if you would like the user position included in the response. Defaults to None.

Response

200
application/json

Successful Response

The response is of type object.