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

# Get vault statistics

> ### Parameters

| Parameter | Required | Type | Description |
| --------- | -------- | ---- | ----------- |
| vaultAddresses | yes | array | null | Comma-separated list of vault addresses (e.g., "0xABC...,0xDEF...") |
| from | yes | integer (int64) | — |
| to | yes | integer (int64) | — |

### Response fields

| Parameter | Required | Type | Description |
| --------- | -------- | ---- | ----------- |
| `vaultStats` | yes | object[] | — |
| `vaultStats[].address` | yes | string (hex) | An Ethereum-style account address (20 bytes). |
| `vaultStats[].stats` | yes | object | — |
| `vaultStats[].stats.APR` | yes | number (double) | — |
| `vaultStats[].stats.APR30d` | yes | number (double) | — |
| `vaultStats[].stats.APRTimeRange` | yes | integer (int64) | — |
| `vaultStats[].stats.CurrentTVL` | yes | number (double) | — |
| `vaultStats[].stats.apr_30d_data_time_range` | yes | integer (int64) | — |
| `vaultStats[].stats.balances` | yes | object | — |
| `vaultStats[].stats.balances.*` | yes | object (map) | An Ethereum-style account address (20 bytes). |
| `vaultStats[].stats.balances.*.shares` | yes | integer | — |
| `vaultStats[].stats.balances.*.withdrawableBalance` | yes | number (double) | — |
| `vaultStats[].stats.creationTimestamp` | yes | integer (Unix timestamp (milliseconds)) | — |
| `vaultStats[].stats.depositors` | yes | integer | — |
| `vaultStats[].stats.statsForTimeRange` | yes | object | — |
| `vaultStats[].stats.statsForTimeRange.avgReturns` | yes | number (double) | — |
| `vaultStats[].stats.statsForTimeRange.dailyValues` | yes | object[] | — |
| `vaultStats[].stats.statsForTimeRange.dailyValues[].nav` | yes | number (double) | — |
| `vaultStats[].stats.statsForTimeRange.dailyValues[].return` | yes | number (double) | — |
| `vaultStats[].stats.statsForTimeRange.dailyValues[].returnAbsolute` | yes | number (double) | — |
| `vaultStats[].stats.statsForTimeRange.dailyValues[].timestamp` | yes | integer (int64) | — |
| `vaultStats[].stats.statsForTimeRange.dailyValues[].tvl` | yes | number (double) | — |
| `vaultStats[].stats.statsForTimeRange.maxDrawdown` | yes | number (double) | — |
| `vaultStats[].stats.statsForTimeRange.returnsVolatility` | yes | number (double) | — |
| `vaultStats[].stats.statsForTimeRange.sharpeRatioDaily` | yes | number (double) | — |

### Response example

A sample **`200`** JSON body is attached to this operation as an OpenAPI **example** (Mintlify shows it in the example panel, similar to other exchange API docs).



## OpenAPI

````yaml /specs/openapi.json get /vault_stats
openapi: 3.1.0
info:
  title: RocketFi REST API
  description: REST API for Rocket Chain / RocketFi integrations.
  license:
    name: ''
  version: 0.1.0
servers:
  - url: https://beta.rocketfi.io
    description: Beta
  - url: https://testnet.rocket-cluster-1.com
    description: Testnet
  - url: https://devnet.rocket-cluster-1.com
    description: Devnet
security: []
tags:
  - name: Service
    description: Health and availability.
  - name: Market data
    description: Instruments, candles, fees, leverage, and funding data.
  - name: Account
    description: Account nonce, fees, collateral, positions, and orders.
  - name: Trading
    description: Transactions and order activity.
  - name: Vault and bridge
    description: Vaults, history, and bridge events.
  - name: Faucet (testnet)
    description: Testnet faucet for development.
paths:
  /vault_stats:
    get:
      tags:
        - Vault and bridge
      summary: Get vault statistics
      description: >-
        ### Parameters


        | Parameter | Required | Type | Description |

        | --------- | -------- | ---- | ----------- |

        | vaultAddresses | yes | array | null | Comma-separated list of vault
        addresses (e.g., "0xABC...,0xDEF...") |

        | from | yes | integer (int64) | — |

        | to | yes | integer (int64) | — |


        ### Response fields


        | Parameter | Required | Type | Description |

        | --------- | -------- | ---- | ----------- |

        | `vaultStats` | yes | object[] | — |

        | `vaultStats[].address` | yes | string (hex) | An Ethereum-style
        account address (20 bytes). |

        | `vaultStats[].stats` | yes | object | — |

        | `vaultStats[].stats.APR` | yes | number (double) | — |

        | `vaultStats[].stats.APR30d` | yes | number (double) | — |

        | `vaultStats[].stats.APRTimeRange` | yes | integer (int64) | — |

        | `vaultStats[].stats.CurrentTVL` | yes | number (double) | — |

        | `vaultStats[].stats.apr_30d_data_time_range` | yes | integer (int64) |
        — |

        | `vaultStats[].stats.balances` | yes | object | — |

        | `vaultStats[].stats.balances.*` | yes | object (map) | An
        Ethereum-style account address (20 bytes). |

        | `vaultStats[].stats.balances.*.shares` | yes | integer | — |

        | `vaultStats[].stats.balances.*.withdrawableBalance` | yes | number
        (double) | — |

        | `vaultStats[].stats.creationTimestamp` | yes | integer (Unix timestamp
        (milliseconds)) | — |

        | `vaultStats[].stats.depositors` | yes | integer | — |

        | `vaultStats[].stats.statsForTimeRange` | yes | object | — |

        | `vaultStats[].stats.statsForTimeRange.avgReturns` | yes | number
        (double) | — |

        | `vaultStats[].stats.statsForTimeRange.dailyValues` | yes | object[] |
        — |

        | `vaultStats[].stats.statsForTimeRange.dailyValues[].nav` | yes |
        number (double) | — |

        | `vaultStats[].stats.statsForTimeRange.dailyValues[].return` | yes |
        number (double) | — |

        | `vaultStats[].stats.statsForTimeRange.dailyValues[].returnAbsolute` |
        yes | number (double) | — |

        | `vaultStats[].stats.statsForTimeRange.dailyValues[].timestamp` | yes |
        integer (int64) | — |

        | `vaultStats[].stats.statsForTimeRange.dailyValues[].tvl` | yes |
        number (double) | — |

        | `vaultStats[].stats.statsForTimeRange.maxDrawdown` | yes | number
        (double) | — |

        | `vaultStats[].stats.statsForTimeRange.returnsVolatility` | yes |
        number (double) | — |

        | `vaultStats[].stats.statsForTimeRange.sharpeRatioDaily` | yes | number
        (double) | — |


        ### Response example


        A sample **`200`** JSON body is attached to this operation as an OpenAPI
        **example** (Mintlify shows it in the example panel, similar to other
        exchange API docs).
      operationId: get_vault_stats
      parameters:
        - name: vaultAddresses
          in: path
          description: Comma-separated list of vault addresses (e.g., "0xABC...,0xDEF...")
          required: true
          schema:
            type:
              - array
              - 'null'
            items:
              $ref: '#/components/schemas/AccountAddress'
        - name: from
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/u64'
        - name: to
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/u64'
      responses:
        '200':
          description: Vault stats by vault address
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVaultStatsResponse'
              example:
                vaultStats: []
components:
  schemas:
    AccountAddress:
      type: string
      format: hex
      description: An Ethereum-style account address (20 bytes).
    u64:
      type: integer
      format: int64
      minimum: 0
    GetVaultStatsResponse:
      type: object
      required:
        - vaultStats
      properties:
        vaultStats:
          $ref: '#/components/schemas/Vec'
    Vec:
      type: array
      items:
        type: object
        required:
          - address
          - stats
        properties:
          address:
            $ref: '#/components/schemas/AccountAddress'
          stats:
            $ref: '#/components/schemas/VaultStatsView'
    VaultStatsView:
      type: object
      required:
        - depositors
        - creationTimestamp
        - CurrentTVL
        - APR
        - APRTimeRange
        - APR30d
        - apr_30d_data_time_range
        - statsForTimeRange
        - balances
      properties:
        APR:
          type: number
          format: double
        APR30d:
          type: number
          format: double
        APRTimeRange:
          $ref: '#/components/schemas/u64'
        CurrentTVL:
          type: number
          format: double
        apr_30d_data_time_range:
          $ref: '#/components/schemas/u64'
        balances:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/VaultShareBalanceView'
          propertyNames:
            type: string
            format: hex
            description: An Ethereum-style account address (20 bytes).
        creationTimestamp:
          type: integer
          format: Unix timestamp (milliseconds)
          minimum: 0
        depositors:
          type: integer
          minimum: 0
        statsForTimeRange:
          $ref: '#/components/schemas/VaultStatsForRangeView'
    VaultShareBalanceView:
      type: object
      required:
        - shares
        - withdrawableBalance
      properties:
        shares:
          type: integer
          minimum: 0
        withdrawableBalance:
          type: number
          format: double
    VaultStatsForRangeView:
      type: object
      required:
        - avgReturns
        - returnsVolatility
        - maxDrawdown
        - sharpeRatioDaily
        - dailyValues
      properties:
        avgReturns:
          type: number
          format: double
        dailyValues:
          type: array
          items:
            $ref: '#/components/schemas/VaultStatsForRangeViewItem'
        maxDrawdown:
          type: number
          format: double
        returnsVolatility:
          type: number
          format: double
        sharpeRatioDaily:
          type: number
          format: double
    VaultStatsForRangeViewItem:
      type: object
      required:
        - timestamp
        - nav
        - tvl
        - return
        - returnAbsolute
      properties:
        nav:
          type: number
          format: double
        return:
          type: number
          format: double
        returnAbsolute:
          type: number
          format: double
        timestamp:
          $ref: '#/components/schemas/u64'
        tvl:
          type: number
          format: double

````