Vaults

Tokenized Vault Endpoints

Overview

The Tokenized Vault endpoints provide comprehensive access to August Digital's vault ecosystem. These endpoints allow you to discover available investment strategies, analyze performance metrics, retrieve detailed vault information, and monitor withdrawal activities.

Authentication

All tokenized vault endpoints are public and do not require authentication, making them ideal for frontend applications and public integrations.

Vault Discovery

Get All Tokenized Vaults

Endpoint: GET /tokenized_vault

Retrieve a list of all available tokenized vaults with optional filtering by status.

Parameters

  • status (optional): Filter vaults by status

    • active - Currently accepting deposits and actively managed

    • closed - No longer accepting new deposits

Response

Returns an array of vault objects containing:

  • Vault address and chain information

  • Vault metadata (name, description, type, logo)

  • Fee structure and configuration

  • Associated subaccounts and strategists

  • Current status and visibility settings

Use Cases

  • Display available investment options to users

  • Filter vaults by operational status

  • Build vault selection interfaces

  • Portfolio discovery and research

Get Tokenized Vaults

get
Query parameters
statusany ofOptional

Filter vaults by status (e.g. active, closed)

string · enumOptionalPossible values:
or
nullOptional
Responses
200

Successful Response

application/json
get
GET /api/v1/tokenized_vault HTTP/1.1
Host: 
Accept: */*

[
  {
    "address": "text",
    "yield_distributor": "text",
    "chain": 1,
    "description": "text",
    "internal_type": "text",
    "public_type": "text",
    "is_featured": false,
    "is_visible": true,
    "weekly_performance_fee_bps": 1,
    "platform_fee_override": {},
    "start_datetime": "2025-08-08T20:16:45.859Z",
    "vault_name": "text",
    "reserve_target": 0.05,
    "reserve_tolerance": 0.01,
    "status": "active",
    "is_charge_fees_manual": false,
    "receipt_token_symbol": "text",
    "enable_external_assets_update": false,
    "vault_logo_url": "text",
    "risk": "text",
    "max_daily_drawdown": 1,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "rewards": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "updated_at": "2025-08-08T20:16:45.859Z",
        "created_at": "2025-08-08T20:16:45.859Z",
        "tokenizedvault_id": "123e4567-e89b-12d3-a456-426614174000",
        "text": "text",
        "img_url": "text",
        "multiplier": 1,
        "start_datetime": "2025-08-08T20:16:45.859Z"
      }
    ],
    "subaccounts": [
      {
        "address": "text",
        "strategist": {
          "strategist_name": "text",
          "strategist_logo": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      }
    ],
    "reported_apy": {
      "apy": 1,
      "underlying_apy": 1,
      "liquid_apy": 1,
      "rewards_compounded": 1,
      "rewards_claimable": 1,
      "explainer": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "updated_at": "2025-08-08T20:16:45.859Z",
      "created_at": "2025-08-08T20:16:45.859Z",
      "tokenized_vault_id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "receipt_token_integrations": [
      {
        "address": "text",
        "chain": 1,
        "token_class": "text",
        "shorthand": "text",
        "symbol": "text",
        "tiingo_ticker": "text",
        "img_url": "text",
        "is_transferable": true,
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "updated_at": "2025-08-08T20:16:45.859Z",
        "created_at": "2025-08-08T20:16:45.859Z",
        "position_id": "123e4567-e89b-12d3-a456-426614174000",
        "stable_token_pair_id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "hardcoded_strategists": [
      {
        "strategist_name": "text",
        "strategist_logo": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }
]

Vault Details

Get Specific Tokenized Vault

Endpoint: GET /tokenized_vault/{vault_address}

Retrieve detailed information about a specific vault using its contract address.

Parameters

  • vault_address (required): The on-chain contract address of the vault

Response

Returns comprehensive vault details including:

  • Complete vault configuration and metadata

  • Fee structures and performance metrics

  • Associated strategists and management information

  • Receipt token integration details

  • Reward programs and incentives

Use Cases

  • Display detailed vault information pages

  • Perform due diligence on specific strategies

  • Access vault-specific configuration data

  • Integration with wallet interfaces

Get Tokenized Vault

get
Path parameters
vault_addressstringRequired
Responses
200

Successful Response

application/json
get
GET /api/v1/tokenized_vault/{vault_address} HTTP/1.1
Host: 
Accept: */*

{
  "address": "text",
  "yield_distributor": "text",
  "chain": 1,
  "description": "text",
  "internal_type": "text",
  "public_type": "text",
  "is_featured": false,
  "is_visible": true,
  "weekly_performance_fee_bps": 1,
  "platform_fee_override": {},
  "start_datetime": "2025-08-08T20:16:45.859Z",
  "vault_name": "text",
  "reserve_target": 0.05,
  "reserve_tolerance": 0.01,
  "status": "active",
  "is_charge_fees_manual": false,
  "receipt_token_symbol": "text",
  "enable_external_assets_update": false,
  "vault_logo_url": "text",
  "risk": "text",
  "max_daily_drawdown": 1,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "rewards": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "updated_at": "2025-08-08T20:16:45.859Z",
      "created_at": "2025-08-08T20:16:45.859Z",
      "tokenizedvault_id": "123e4567-e89b-12d3-a456-426614174000",
      "text": "text",
      "img_url": "text",
      "multiplier": 1,
      "start_datetime": "2025-08-08T20:16:45.859Z"
    }
  ],
  "subaccounts": [
    {
      "address": "text",
      "strategist": {
        "strategist_name": "text",
        "strategist_logo": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "reported_apy": {
    "apy": 1,
    "underlying_apy": 1,
    "liquid_apy": 1,
    "rewards_compounded": 1,
    "rewards_claimable": 1,
    "explainer": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "updated_at": "2025-08-08T20:16:45.859Z",
    "created_at": "2025-08-08T20:16:45.859Z",
    "tokenized_vault_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "receipt_token_integrations": [
    {
      "address": "text",
      "chain": 1,
      "token_class": "text",
      "shorthand": "text",
      "symbol": "text",
      "tiingo_ticker": "text",
      "img_url": "text",
      "is_transferable": true,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "updated_at": "2025-08-08T20:16:45.859Z",
      "created_at": "2025-08-08T20:16:45.859Z",
      "position_id": "123e4567-e89b-12d3-a456-426614174000",
      "stable_token_pair_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "hardcoded_strategists": [
    {
      "strategist_name": "text",
      "strategist_logo": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Performance Analytics

Get Vault Summary

Endpoint: GET /tokenized_vault/vault_summary/{vault_address}

Get a comprehensive summary of vault performance including returns across multiple time periods.

Parameters

  • vault_address (required): The vault contract address

Response

Provides vault summary data including:

  • Vault name, type, and chain information

  • Latest performance snapshot

  • 1-day, 7-day, and 30-day returns

  • Current strategy allocation

Use Cases

  • Performance dashboard displays

  • Comparative analysis between vaults

  • Risk assessment and due diligence

  • Portfolio performance tracking

Get Vault Summary

get

Get the summary of a specific vault by its address. Returns name, type, chain, latest snapshot and 1D/7D/30D returns for a vault.

Path parameters
vault_addressstringRequired
Responses
200

Successful Response

application/json
Responseany
get
GET /api/v1/tokenized_vault/vault_summary/{vault_address} HTTP/1.1
Host: 
Accept: */*

No content

Get Annualized APY

Endpoint: GET /tokenized_vault/annualized_apy/{vault_address}

Calculate annualized APY for specific vaults with support for multiple time horizons.

Parameters

  • vault_address (required): The vault contract address (currently supports hgETH vault)

Response

Returns annualized APY calculations:

  • hgETH30dLiquidAPY: 30-day annualized performance

  • hgETH7dLiquidAPY: 7-day annualized performance

Important Notes

  • Currently optimized for hgETH vault operations

  • Integrates with external data sources like KelpDAO

  • Provides liquid staking yield calculations

Error Handling

  • 400: Vault not supported for APY calculations

  • 424: Failed to fetch external APY data

  • 500: Server error during calculation

Use Cases

  • Display current yield expectations

  • Compare yields across different time horizons

  • Integration with yield farming dashboards

  • Investment decision support tools

Get Annualized Apy

get

Calculate annualized APY for a specific vault (currently only supports hgETH vault).

Parameters:

vault_address : str The on-chain address of the vault contract (must be hgETH vault) Example: "0x123...abc"

Returns:

Dict[str, float] Dictionary containing annualized APY values: - hgETH30dLiquidAPY: float Annualized APY based on 30-day performance Example: 0.0852 (for 8.52%) - hgETH7dLiquidAPY: float Annualized APY based on 7-day performance Example: 0.0921 (for 9.21%)

Raises:

HTTPException 400: If the vault is not an hgETH vault 424: If failed to fetch RSETH totalAPY from KelpDAO 500: For unexpected server errors

Examples:

Successful Response: { "hgETH30dLiquidAPY": 0.0852, "hgETH7dLiquidAPY": 0.0921 }

Error Responses: { "detail": "Annualized APY not available for vault address 0x123...xyz" } { "detail": "Failed to fetch base APY from KelpDAO" }

Path parameters
vault_addressstringRequired
Responses
200

Successful Response

application/json
Responseany
get
GET /api/v1/tokenized_vault/annualized_apy/{vault_address} HTTP/1.1
Host: 
Accept: */*

No content

Withdrawal Management

Get Vault Withdrawals

Endpoint: GET /withdrawals/{chain}/{vault_address}

Monitor withdrawal activities and pending transactions for a specific vault on a given blockchain.

Parameters

  • chain (required): The blockchain network identifier

  • vault_address (required): The vault contract address

Response

Returns withdrawal summary including:

  • Total withdrawal amounts (raw and normalized)

  • Current total assets in the vault

  • List of pending withdrawal requests with details:

    • Withdrawal dates and amounts

    • Vault percentage allocations

    • Recipient addresses

Use Cases

  • Monitor liquidity and withdrawal patterns

  • Track pending user withdrawals

  • Vault capacity planning and management

  • Compliance and reporting requirements

Get Vault Withdrawals

get
Path parameters
chaininteger · enumRequiredPossible values:
vault_addressstringRequired
Responses
200

Successful Response

application/json
get
GET /api/v1/withdrawals/{chain}/{vault_address} HTTP/1.1
Host: 
Accept: */*

{
  "total_withdrawals_raw_amount": 1,
  "normalized_total_withdrawals_amount": "text",
  "total_assets": "text",
  "normalized_total_assets": "text",
  "symbol": "text",
  "pending_withdrawals": [
    {
      "date": "text",
      "amount_raw": 1,
      "normalized_amount": "text",
      "vault_percentage": "text",
      "vault": "text",
      "receiver": "text"
    }
  ]
}

Integration Examples

Frontend Integration

// Example: Fetch all active vaults
const activeVaults = await fetch('/api/v1/tokenized_vault?status=active')
  .then(response => response.json());

// Example: Get specific vault details
const vaultDetails = await fetch(`/api/v1/tokenized_vault/${vaultAddress}`)
  .then(response => response.json());

Performance Monitoring

// Example: Get vault performance summary
const performance = await fetch(`/api/v1/tokenized_vault/vault_summary/${vaultAddress}`)
  .then(response => response.json());

// Example: Get current APY
const apy = await fetch(`/api/v1/tokenized_vault/annualized_apy/${vaultAddress}`)
  .then(response => response.json());

Best Practices

Error Handling

  • Always implement proper error handling for 422 validation errors

  • Handle rate limiting gracefully

  • Cache vault data appropriately to reduce API calls

Performance Optimization

  • Use status filtering to reduce response sizes

  • Implement pagination for large vault lists

  • Cache static vault information

Data Freshness

  • Performance data updates periodically - implement appropriate refresh intervals

  • Withdrawal data is near real-time

  • APY calculations may depend on external data sources

Response Schemas

All endpoints return structured JSON responses with consistent formatting. Refer to the OpenAPI specification for detailed schema definitions including:

  • ITokenizedVaultDisplay: Complete vault information

  • WithdrawalSummary: Withdrawal tracking data

  • APY calculation responses with error handling

  • Validation error formats for troubleshooting

PreviousAPI ReferenceNextSubaccounts

Last updated