# Vaults ## Tokenized Vault API Endpoints This documentation covers the tokenized vault endpoints for retrieving vault information. ### Base URL ``` https://api.upshift.finance/v1/ ``` *** ### Get All Tokenized Vaults #### GET `/tokenized_vaults` Retrieve a list of all tokenized vaults with optional status filtering. **Query Parameters:** * `status` (optional): Filter by vault status (`active` or `closed`) ## GET /tokenized\_vaults > Get Tokenized Vaults ```json {"openapi":"3.1.0","info":{"title":"Upshift API","version":"0.1.0"},"servers":[{"url":"/v1"}],"paths":{"/tokenized_vaults":{"get":{"summary":"Get Tokenized Vaults","operationId":"get_tokenized_vaults_tokenized_vaults_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ITokenizedVaultStatus"},{"type":"null"}],"description":"Filter vaults by status (e.g. active, closed)","title":"Status"},"description":"Filter vaults by status (e.g. active, closed)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ITokenizedVaultDisplay"},"title":"Response Get Tokenized Vaults Tokenized Vaults Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ITokenizedVaultStatus":{"type":"string","enum":["active","closed"],"title":"ITokenizedVaultStatus"},"ITokenizedVaultDisplay":{"properties":{"address":{"type":"string","title":"Address"},"yield_distributor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Yield Distributor"},"chain":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Chain"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"internal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Type"},"public_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Public Type"},"is_featured":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Featured","default":false},"is_visible":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Visible","default":true},"weekly_performance_fee_bps":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Weekly Performance Fee Bps"},"platform_fee_override":{"type":"object","title":"Platform Fee Override","default":{}},"start_datetime":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Datetime"},"vault_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vault Name"},"reserve_target":{"anyOf":[{"type":"number","maximum":1,"minimum":0},{"type":"null"}],"title":"Reserve Target","default":0.05},"reserve_tolerance":{"anyOf":[{"type":"number","maximum":1,"minimum":0},{"type":"null"}],"title":"Reserve Tolerance","default":0.01},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","default":"active"},"is_charge_fees_manual":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Charge Fees Manual","default":false},"receipt_token_symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Token Symbol"},"enable_external_assets_update":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enable External Assets Update","default":false},"vault_logo_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vault Logo Url"},"risk":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Risk"},"max_daily_drawdown":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Daily Drawdown"},"chain_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chain Type","default":"evm"},"enabled_historical_price_horizons":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Enabled Historical Price Horizons"},"id":{"type":"string","format":"uuid","title":"Id"},"rewards":{"items":{"$ref":"#/components/schemas/TokenizedVaultReward"},"type":"array","title":"Rewards","default":[]},"subaccounts":{"items":{"$ref":"#/components/schemas/ISubaccountReadWithStrategist"},"type":"array","title":"Subaccounts","default":[]},"reported_apy":{"anyOf":[{"$ref":"#/components/schemas/TokenizedVaultReportedAPY"},{"type":"null"}]},"receipt_token_integrations":{"items":{"$ref":"#/components/schemas/Token"},"type":"array","title":"Receipt Token Integrations"},"hardcoded_strategists":{"items":{"$ref":"#/components/schemas/IStrategistRead"},"type":"array","title":"Hardcoded Strategists"}},"type":"object","required":["address","chain","id"],"title":"ITokenizedVaultDisplay"},"TokenizedVaultReward":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"tokenizedvault_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Tokenizedvault Id"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"img_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Img Url"},"multiplier":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Multiplier"},"start_datetime":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Datetime"}},"type":"object","title":"TokenizedVaultReward"},"ISubaccountReadWithStrategist":{"properties":{"address":{"type":"string","title":"Address"},"strategist":{"anyOf":[{"$ref":"#/components/schemas/IStrategistRead"},{"type":"null"}]}},"type":"object","required":["address"],"title":"ISubaccountReadWithStrategist"},"IStrategistRead":{"properties":{"strategist_name":{"type":"string","title":"Strategist Name"},"strategist_logo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Strategist Logo"},"id":{"type":"string","format":"uuid","title":"Id"}},"type":"object","required":["strategist_name","id"],"title":"IStrategistRead"},"TokenizedVaultReportedAPY":{"properties":{"apy":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Apy"},"underlying_apy":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Underlying Apy"},"liquid_apy":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Liquid Apy"},"rewards_compounded":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rewards Compounded"},"rewards_claimable":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rewards Claimable"},"explainer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Explainer"},"id":{"type":"string","format":"uuid","title":"Id"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"tokenized_vault_id":{"type":"string","format":"uuid","title":"Tokenized Vault Id"}},"type":"object","required":["tokenized_vault_id"],"title":"TokenizedVaultReportedAPY"},"Token":{"properties":{"address":{"type":"string","title":"Address"},"chain":{"type":"integer","title":"Chain"},"token_class":{"type":"string","title":"Token Class"},"shorthand":{"type":"string","title":"Shorthand"},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Symbol"},"tiingo_ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tiingo Ticker"},"img_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Img Url"},"is_transferable":{"type":"boolean","title":"Is Transferable","default":true},"id":{"type":"string","format":"uuid","title":"Id"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"position_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Position Id"},"stable_token_pair_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Stable Token Pair Id"}},"type":"object","required":["address","chain","token_class","shorthand"],"title":"Token"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` *** ### Get Specific Tokenized Vault #### GET `/tokenized_vaults/{vault_address}` Get detailed information for a specific tokenized vault by its contract address. **Path Parameters:** * `vault_address` (required): The vault contract address ## GET /tokenized\_vaults/{vault\_address} > Get Tokenized Vault ```json {"openapi":"3.1.0","info":{"title":"Upshift API","version":"0.1.0"},"servers":[{"url":"/v1"}],"paths":{"/tokenized_vaults/{vault_address}":{"get":{"summary":"Get Tokenized Vault","operationId":"get_tokenized_vault_tokenized_vaults__vault_address__get","parameters":[{"name":"vault_address","in":"path","required":true,"schema":{"type":"string","title":"Vault Address"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ITokenizedVaultDisplay"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ITokenizedVaultDisplay":{"properties":{"address":{"type":"string","title":"Address"},"yield_distributor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Yield Distributor"},"chain":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Chain"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"internal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Type"},"public_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Public Type"},"is_featured":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Featured","default":false},"is_visible":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Visible","default":true},"weekly_performance_fee_bps":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Weekly Performance Fee Bps"},"platform_fee_override":{"type":"object","title":"Platform Fee Override","default":{}},"start_datetime":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Datetime"},"vault_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vault Name"},"reserve_target":{"anyOf":[{"type":"number","maximum":1,"minimum":0},{"type":"null"}],"title":"Reserve Target","default":0.05},"reserve_tolerance":{"anyOf":[{"type":"number","maximum":1,"minimum":0},{"type":"null"}],"title":"Reserve Tolerance","default":0.01},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","default":"active"},"is_charge_fees_manual":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Charge Fees Manual","default":false},"receipt_token_symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Token Symbol"},"enable_external_assets_update":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enable External Assets Update","default":false},"vault_logo_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vault Logo Url"},"risk":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Risk"},"max_daily_drawdown":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Daily Drawdown"},"chain_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chain Type","default":"evm"},"enabled_historical_price_horizons":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Enabled Historical Price Horizons"},"id":{"type":"string","format":"uuid","title":"Id"},"rewards":{"items":{"$ref":"#/components/schemas/TokenizedVaultReward"},"type":"array","title":"Rewards","default":[]},"subaccounts":{"items":{"$ref":"#/components/schemas/ISubaccountReadWithStrategist"},"type":"array","title":"Subaccounts","default":[]},"reported_apy":{"anyOf":[{"$ref":"#/components/schemas/TokenizedVaultReportedAPY"},{"type":"null"}]},"receipt_token_integrations":{"items":{"$ref":"#/components/schemas/Token"},"type":"array","title":"Receipt Token Integrations"},"hardcoded_strategists":{"items":{"$ref":"#/components/schemas/IStrategistRead"},"type":"array","title":"Hardcoded Strategists"}},"type":"object","required":["address","chain","id"],"title":"ITokenizedVaultDisplay"},"TokenizedVaultReward":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"tokenizedvault_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Tokenizedvault Id"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"img_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Img Url"},"multiplier":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Multiplier"},"start_datetime":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Datetime"}},"type":"object","title":"TokenizedVaultReward"},"ISubaccountReadWithStrategist":{"properties":{"address":{"type":"string","title":"Address"},"strategist":{"anyOf":[{"$ref":"#/components/schemas/IStrategistRead"},{"type":"null"}]}},"type":"object","required":["address"],"title":"ISubaccountReadWithStrategist"},"IStrategistRead":{"properties":{"strategist_name":{"type":"string","title":"Strategist Name"},"strategist_logo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Strategist Logo"},"id":{"type":"string","format":"uuid","title":"Id"}},"type":"object","required":["strategist_name","id"],"title":"IStrategistRead"},"TokenizedVaultReportedAPY":{"properties":{"apy":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Apy"},"underlying_apy":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Underlying Apy"},"liquid_apy":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Liquid Apy"},"rewards_compounded":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rewards Compounded"},"rewards_claimable":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rewards Claimable"},"explainer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Explainer"},"id":{"type":"string","format":"uuid","title":"Id"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"tokenized_vault_id":{"type":"string","format":"uuid","title":"Tokenized Vault Id"}},"type":"object","required":["tokenized_vault_id"],"title":"TokenizedVaultReportedAPY"},"Token":{"properties":{"address":{"type":"string","title":"Address"},"chain":{"type":"integer","title":"Chain"},"token_class":{"type":"string","title":"Token Class"},"shorthand":{"type":"string","title":"Shorthand"},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Symbol"},"tiingo_ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tiingo Ticker"},"img_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Img Url"},"is_transferable":{"type":"boolean","title":"Is Transferable","default":true},"id":{"type":"string","format":"uuid","title":"Id"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"position_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Position Id"},"stable_token_pair_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Stable Token Pair Id"}},"type":"object","required":["address","chain","token_class","shorthand"],"title":"Token"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` *** ### Get Specific Tokenized Vault APY #### GET `/tokenized_vaults/{vault_address}/annualized_apy` Get APY information for a specific tokenized vault by its contract address. **Path Parameters:** * `vault_address` (required): The vault contract address ## Get annualized APY > Calculate annualized APY for a specific vault.\ > \ > ⚠️ Deprecation Notice: \ > \- The \`hgETH30dLiquidAPY\` and \`hgETH7dLiquidAPY\` fields are deprecated\ > \- These fields will be removed on 2026-01-01\ > \- Use \`liquidAPY30Day\` and \`liquidAPY7Day\` fields instead\ > \ > Supported Vaults: cUSDO, tETH, wstETH, rsETH ```json {"openapi":"3.1.0","info":{"title":"Upshift API","version":"0.1.0"},"servers":[{"url":"/v1"}],"paths":{"/tokenized_vaults/{vault_address}/annualized_apy":{"get":{"summary":"Get annualized APY","description":"Calculate annualized APY for a specific vault.\n \n ⚠️ Deprecation Notice: \n - The `hgETH30dLiquidAPY` and `hgETH7dLiquidAPY` fields are deprecated\n - These fields will be removed on 2026-01-01\n - Use `liquidAPY30Day` and `liquidAPY7Day` fields instead\n \n Supported Vaults: cUSDO, tETH, wstETH, rsETH","operationId":"get_annualized_APY_tokenized_vaults__vault_address__annualized_apy_get","parameters":[{"name":"vault_address","in":"path","required":true,"schema":{"type":"string","title":"Vault Address"}}],"responses":{"200":{"description":"APY data","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` *** ### Key Response Fields **Important fields in the responses:** * `address`: Vault contract address * `vault_name`: Human-readable vault name * `status`: Current status (`active` or `closed`) * `chain`: Blockchain network ID * `reported_apy`: APY information including breakdown * `rewards`: Available reward multipliers * `subaccounts`: Associated strategist subaccounts * `is_featured`: Whether vault is prominently displayed * `receipt_token_symbol`: Symbol for vault receipt tokens *** ### Status Values * `active`: Vault is operational and accepting deposits * `closed`: Vault is closed to new deposits *** ### Usage Examples **Get all active vaults:** ```bash curl "https://api.augustdigital.io/api/v1/tokenized_vaults?status=active" ``` **Get specific vault details:** ```bash curl "https://api.augustdigital.io/api/v1/tokenized_vaults/0x123..." ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.upshift.finance/developer-docs/api-reference/vaults.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.