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

# Get vault 7-day Annual Percentage Yield (APY)

> **User Experience Function**: Retrieves the 7-day Annual Percentage Yield (APY) for a vault. This endpoint calculates APY based on the vault's performance over the last 7 days and returns it as an annualized percentage.



## OpenAPI

````yaml GET /vault/{address}/apy
openapi: 3.0.0
info:
  title: DeFindex API
  description: API documentation for DeFindex endpoints
  version: 1.0.0
  contact: {}
  x-logo:
    url: https://links.paltalabs.io/defindex-full.svg
    backgroundColor: '#0e0e0e'
    altText: DeFindex Logo
    href: https://defindex.io
servers: []
security: []
tags: []
paths:
  /vault/{address}/apy:
    get:
      tags:
        - Vault
      summary: Get vault 7-day Annual Percentage Yield (APY)
      description: >-
        **User Experience Function**: Retrieves the 7-day Annual Percentage
        Yield (APY) for a vault. This endpoint calculates APY based on the
        vault's performance over the last 7 days and returns it as an annualized
        percentage.
      operationId: VaultController_getApy
      parameters:
        - name: address
          required: true
          in: path
          description: Stellar address of the vault contract
          schema:
            example: CBNKCU3HGFKHFOF7JTGXQCNKE3G3DXS5RDBQUKQMIIECYKXPIOUGB2S3
            type: string
        - name: network
          required: true
          in: query
          description: Stellar network to execute the transaction on (testnet or mainnet)
          schema:
            enum:
              - testnet
              - mainnet
            type: string
      responses:
        '200':
          description: 7-day APY retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  apy:
                    type: number
                    description: >-
                      7-day Annual Percentage Yield (%) - calculated based on
                      vault performance over the last 7 days and annualized for
                      comparison
                    example: 19.4
                example:
                  apy: 19.4
        '400':
          description: Bad request - invalid parameters
        '403':
          description: Forbidden - caller is not authorized for this operation

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.