> ## 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 depositor analytics

> Returns a paginated list of all depositors with estimated balance, activity status, and transaction history. Status is computed from idleThresholdDays and minBalance thresholds (configurable per-user via VaultUserConfig, overridable by query params). NOTE: v1 only supports single-asset vaults; multi-asset vaults default to assets[0].



## OpenAPI

````yaml GET /vault/{address}/depositors
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}/depositors:
    get:
      tags:
        - Vault
      summary: Get vault depositor analytics
      description: >-
        Returns a paginated list of all depositors with estimated balance,
        activity status, and transaction history. Status is computed from
        idleThresholdDays and minBalance thresholds (configurable per-user via
        VaultUserConfig, overridable by query params). NOTE: v1 only supports
        single-asset vaults; multi-asset vaults default to assets[0].
      operationId: VaultController_getDepositors
      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
        - name: limit
          required: false
          in: query
          description: Results per page (max 100)
          schema:
            default: 25
            type: number
        - name: offset
          required: false
          in: query
          schema:
            default: 0
            type: number
        - name: sortBy
          required: false
          in: query
          schema:
            default: balance
            type: string
            enum:
              - balance
              - lastActivityAt
              - totalDeposited
              - walletAddress
        - name: sortOrder
          required: false
          in: query
          schema:
            default: desc
            type: string
            enum:
              - asc
              - desc
        - name: idleThresholdDays
          required: false
          in: query
          description: >-
            Days without activity before a depositor is classified as idle
            (default 30)
          schema:
            type: number
        - name: minBalance
          required: false
          in: query
          description: >-
            Minimum balance in stroops of the resolved asset. Depositors below
            this are inactive. Example: 1 USDC (7 decimals) = 10_000_000
          schema:
            type: number
        - name: status
          required: false
          in: query
          description: >-
            Filter depositors by status. Filtering is applied before pagination
            so total reflects only the matching set. Aggregates remain
            vault-wide regardless.
          schema:
            type: string
            enum:
              - active
              - idle
              - inactive
      responses:
        '200':
          description: Depositor analytics returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDepositorsResponseDto'
        '400':
          description: Bad request - invalid parameters
        '403':
          description: Forbidden - caller is not authorized for this operation
components:
  schemas:
    GetDepositorsResponseDto:
      type: object
      properties:
        vaultAddress:
          type: string
        network:
          type: string
        limit:
          type: number
        offset:
          type: number
        total:
          type: number
        idleThresholdDays:
          type: number
        depositors:
          type: array
          items:
            $ref: '#/components/schemas/DepositorItemDto'
        aggregates:
          $ref: '#/components/schemas/DepositorAggregatesDto'
      required:
        - vaultAddress
        - network
        - limit
        - offset
        - total
        - idleThresholdDays
        - depositors
        - aggregates
    DepositorItemDto:
      type: object
      properties:
        walletAddress:
          type: string
          description: Stellar wallet address
        status:
          type: string
          enum:
            - active
            - idle
            - inactive
        estimatedValue:
          type: string
          description: Estimated value in stroops of resolvedAsset
        resolvedAsset:
          type: string
          description: Asset address used for estimatedValue computation
        lastActivityAt:
          type: string
          nullable: true
          description: ISO 8601 — null if never directly deposited/withdrew
        totalDeposited:
          type: string
          description: Lifetime total deposited in stroops of resolvedAsset
        totalWithdrawn:
          type: string
          description: Lifetime total withdrawn in stroops of resolvedAsset
      required:
        - walletAddress
        - status
        - estimatedValue
        - resolvedAsset
        - lastActivityAt
        - totalDeposited
        - totalWithdrawn
    DepositorAggregatesDto:
      type: object
      properties:
        assets:
          type: array
          items:
            $ref: '#/components/schemas/DepositorAssetAggregatesDto'
        activeDepositors:
          type: number
        idleDepositors:
          type: number
        inactiveDepositors:
          type: number
      required:
        - assets
        - activeDepositors
        - idleDepositors
        - inactiveDepositors
    DepositorAssetAggregatesDto:
      type: object
      properties:
        asset:
          type: string
          description: Asset contract address
        assetSymbol:
          type: string
          description: Asset display symbol
        totalBalance:
          type: string
          description: Total balance across all depositors (stroops)
        activeBalance:
          type: string
          description: Balance of active depositors (stroops)
        idleBalance:
          type: string
          description: Balance of idle depositors (stroops)
        inactiveBalance:
          type: string
          description: Balance of inactive depositors (stroops)
      required:
        - asset
        - assetSymbol
        - totalBalance
        - activeBalance
        - idleBalance
        - inactiveBalance

````

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