> ## Documentation Index
> Fetch the complete documentation index at: https://docs.privy.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Ethereum vault details

> Retrieve detailed information about an Ethereum vault, including current APY and liquidity.



## OpenAPI

````yaml get /v1/earn/ethereum/vaults/{vault_id}
openapi: 3.1.0
info:
  version: 0.0.1
  title: Privy API
  description: >-
    REST API for Privy's wallet infrastructure — provision and manage wallets
    across EVM, Solana, and Bitcoin, authenticate users, sign transactions, and
    configure programmable policies and authorization intents.
  contact:
    name: Privy
    url: https://www.privy.io/
    email: support@privy.io
servers:
  - url: https://api.privy.io
security: []
tags:
  - name: Accounts
    description: Operations related to asset accounts
  - name: Aggregations
    description: Operations related to aggregations for tracking and measuring metrics
  - name: Apps
    description: Operations related to app settings and allowlist management
  - name: Client Auth
    description: OAuth token exchange and device authorization operations
  - name: Condition Sets
    description: Operations related to condition sets
  - name: Embedded wallets
    description: Operations related to embedded wallet creation and authentication
  - name: Fiat
    description: Operations related to fiat onramping and offramping
  - name: Intents
    description: Operations related to authorization intents for wallet actions
  - name: Key quorums
    description: Operations related to key quorums
  - name: Kraken Embed
    description: >-
      Operations for Kraken Embed integration, including quotes, trades, user
      management, and portfolio operations
  - name: OAuth
    description: >-
      OAuth 2.0 endpoints including Device Authorization Grant (RFC 8628) for
      CLI and limited-input device login flows
  - name: Organizations
    description: Operations related to organization secret management
  - name: Policies
    description: Operations related to policies
  - name: Shared
    description: Common schemas shared across resources
  - name: Swaps
    description: Operations for swapping tokens within wallets
  - name: Transactions
    description: Operations related to transactions
  - name: User signers
    description: Operations related to user signers
  - name: Users
    description: Operations related to users
  - name: Wallet Actions
    description: Operations related to wallet actions
  - name: Wallets
    description: Operations related to wallets
  - name: Webhooks
    description: >-
      Webhook events that Privy sends to your configured endpoint when specific
      actions occur in your app
  - name: Yield
    description: >-
      Operations for depositing and withdrawing funds from ERC-4626 yield vaults
      (Morpho, Aave)
paths:
  /v1/earn/ethereum/vaults/{vault_id}:
    get:
      tags:
        - Wallet Actions
      summary: Get earn vault details
      description: >-
        Retrieve detailed information about an earn vault, including current APY
        and liquidity.
      operationId: getEthereumEarnVaultDetails
      parameters:
        - schema:
            type: string
            description: The Privy vault ID.
          required: true
          name: vault_id
          in: path
        - schema:
            type: string
            description: ID of your Privy app.
          required: true
          name: privy-app-id
          in: header
      responses:
        '200':
          description: Vault details retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EthereumEarnVaultDetailsResponse'
      security:
        - appSecretAuth: []
components:
  schemas:
    EthereumEarnVaultDetailsResponse:
      oneOf:
        - $ref: '#/components/schemas/AaveVaultDetails'
        - $ref: '#/components/schemas/MorphoVaultDetails'
        - $ref: '#/components/schemas/VedaVaultDetails'
      discriminator:
        propertyName: provider
        mapping:
          aave:
            $ref: '#/components/schemas/AaveVaultDetails'
          morpho:
            $ref: '#/components/schemas/MorphoVaultDetails'
          veda:
            $ref: '#/components/schemas/VedaVaultDetails'
      description: >-
        Detailed vault information including current APY, liquidity, and asset
        metadata. Discriminated on provider.
      title: EthereumEarnVaultDetailsResponse
      x-stainless-model: wallets.actions.ethereum_earn_vault_details_response
    AaveVaultDetails:
      type: object
      properties:
        id:
          type: string
          description: Vault identifier.
        name:
          type: string
          description: Human-readable vault name from the yield provider.
        vault_address:
          type: string
          description: Onchain vault contract address.
        asset:
          $ref: '#/components/schemas/EarnAsset'
        caip2:
          type: string
          description: CAIP-2 chain identifier (e.g. "eip155:8453").
        user_apy:
          type:
            - number
            - 'null'
          description: >-
            Annual percentage yield available to the user, after fees and
            excluding rewards, in basis points (e.g. 500 for 5%). 1 basis point
            = 0.01%.
        app_apy:
          type:
            - number
            - 'null'
          description: >-
            Annual percentage yield earned by the app from fee wrapper fees, in
            basis points.
        tvl_usd:
          type:
            - number
            - 'null'
          description: Total value locked in USD.
        available_liquidity_usd:
          type:
            - number
            - 'null'
          description: Available liquidity in USD.
        admin_wallet_id:
          type: string
          description: Privy wallet ID of the vault admin.
        admin_wallet_address:
          type: string
          description: EVM address of the vault admin wallet.
        provider:
          type: string
          enum:
            - aave
        available_fees:
          type: string
          description: Fees available to collect, in smallest unit of the underlying asset.
      required:
        - id
        - name
        - vault_address
        - asset
        - caip2
        - user_apy
        - app_apy
        - tvl_usd
        - available_liquidity_usd
        - admin_wallet_id
        - admin_wallet_address
        - provider
        - available_fees
      description: Vault details for an Aave earn vault, including fee visibility.
      title: AaveVaultDetails
      example:
        id: cm7oxq1el000e11o8iwp7d0d0
        name: Aave USDC Vault
        provider: aave
        vault_address: '0x1234567890abcdef1234567890abcdef12345678'
        asset:
          address: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913'
          symbol: usdc
          decimals: 6
        caip2: eip155:8453
        user_apy: 500
        app_apy: 50
        tvl_usd: 64000000
        available_liquidity_usd: 64000000
        admin_wallet_id: fmfdj6yqly31huorjqzq38zc
        admin_wallet_address: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcd'
        available_fees: '10000000'
      x-stainless-model: wallets.actions.aave_vault_details
    MorphoVaultDetails:
      type: object
      properties:
        id:
          type: string
          description: Vault identifier.
        name:
          type: string
          description: Human-readable vault name from the yield provider.
        vault_address:
          type: string
          description: Onchain vault contract address.
        asset:
          $ref: '#/components/schemas/EarnAsset'
        caip2:
          type: string
          description: CAIP-2 chain identifier (e.g. "eip155:8453").
        user_apy:
          type:
            - number
            - 'null'
          description: >-
            Annual percentage yield available to the user, after fees and
            excluding rewards, in basis points (e.g. 500 for 5%). 1 basis point
            = 0.01%.
        app_apy:
          type:
            - number
            - 'null'
          description: >-
            Annual percentage yield earned by the app from fee wrapper fees, in
            basis points.
        tvl_usd:
          type:
            - number
            - 'null'
          description: Total value locked in USD.
        available_liquidity_usd:
          type:
            - number
            - 'null'
          description: Available liquidity in USD.
        admin_wallet_id:
          type: string
          description: Privy wallet ID of the vault admin.
        admin_wallet_address:
          type: string
          description: EVM address of the vault admin wallet.
        provider:
          type: string
          enum:
            - morpho
        total_rewards_apr:
          type: number
          description: Total rewards annual percentage rate in basis points.
      required:
        - id
        - name
        - vault_address
        - asset
        - caip2
        - user_apy
        - app_apy
        - tvl_usd
        - available_liquidity_usd
        - admin_wallet_id
        - admin_wallet_address
        - provider
        - total_rewards_apr
      description: Vault details for a Morpho earn vault.
      title: MorphoVaultDetails
      example:
        id: cm7oxq1el000e11o8iwp7d0d0
        name: Gauntlet USDC Prime
        provider: morpho
        vault_address: '0x460b523b670e751c1d7c85f24504825e24f64700'
        asset:
          address: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913'
          symbol: usdc
          decimals: 6
        caip2: eip155:8453
        user_apy: 500
        app_apy: 50
        total_rewards_apr: 0
        tvl_usd: 64000000
        available_liquidity_usd: 64000000
        admin_wallet_id: fmfdj6yqly31huorjqzq38zc
        admin_wallet_address: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcd'
      x-stainless-model: wallets.actions.morpho_vault_details
    VedaVaultDetails:
      type: object
      properties:
        id:
          type: string
          description: Vault identifier.
        name:
          type: string
          description: Human-readable vault name from the yield provider.
        vault_address:
          type: string
          description: Onchain vault contract address.
        asset:
          $ref: '#/components/schemas/EarnAsset'
        caip2:
          type: string
          description: CAIP-2 chain identifier (e.g. "eip155:8453").
        user_apy:
          type:
            - number
            - 'null'
          description: >-
            Annual percentage yield available to the user, after fees and
            excluding rewards, in basis points (e.g. 500 for 5%). 1 basis point
            = 0.01%.
        app_apy:
          type:
            - number
            - 'null'
          description: >-
            Annual percentage yield earned by the app from fee wrapper fees, in
            basis points.
        tvl_usd:
          type:
            - number
            - 'null'
          description: Total value locked in USD.
        available_liquidity_usd:
          type:
            - number
            - 'null'
          description: Available liquidity in USD.
        admin_wallet_id:
          type: string
          description: Privy wallet ID of the vault admin.
        admin_wallet_address:
          type: string
          description: EVM address of the vault admin wallet.
        provider:
          type: string
          enum:
            - veda
      required:
        - id
        - name
        - vault_address
        - asset
        - caip2
        - user_apy
        - app_apy
        - tvl_usd
        - available_liquidity_usd
        - admin_wallet_id
        - admin_wallet_address
        - provider
      description: Vault details for a Veda (BoringVault) earn vault.
      title: VedaVaultDetails
      example:
        id: cm7oxq1el000e11o8iwp7d0d0
        name: Veda USDC Vault
        provider: veda
        vault_address: '0x460b523b670e751c1d7c85f24504825e24f64700'
        asset:
          address: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913'
          symbol: usdc
          decimals: 6
        caip2: eip155:8453
        user_apy: 500
        app_apy: 50
        tvl_usd: 64000000
        available_liquidity_usd: null
        admin_wallet_id: fmfdj6yqly31huorjqzq38zc
        admin_wallet_address: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcd'
      x-stainless-model: wallets.actions.veda_vault_details
    EarnAsset:
      type: object
      properties:
        address:
          type: string
          description: Token contract address.
        symbol:
          type: string
          description: Lowercase token symbol (e.g. "usdc").
        decimals:
          type: integer
          description: Number of decimals for the asset (e.g. 6 for USDC).
      required:
        - address
        - symbol
        - decimals
      description: Asset metadata for an earn vault position.
      title: EarnAsset
      example:
        address: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48'
        symbol: usdc
        decimals: 6
      x-stainless-model: wallets.actions.earn_asset
  securitySchemes:
    appSecretAuth:
      type: http
      scheme: basic
      description: >-
        Basic Auth header with your app ID as the username and your app secret
        as the password.

````