Skip to main content
GET
Get vault depositor analytics

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

address
string
required

Stellar address of the vault contract

Example:

"CBNKCU3HGFKHFOF7JTGXQCNKE3G3DXS5RDBQUKQMIIECYKXPIOUGB2S3"

Query Parameters

network
enum<string>
required

Stellar network to execute the transaction on (testnet or mainnet)

Available options:
testnet,
mainnet
limit
number
default:25

Results per page (max 100)

offset
number
default:0
sortBy
enum<string>
default:balance
Available options:
balance,
lastActivityAt,
totalDeposited,
walletAddress
sortOrder
enum<string>
default:desc
Available options:
asc,
desc
idleThresholdDays
number

Days without activity before a depositor is classified as idle (default 30)

minBalance
number

Minimum balance in stroops of the resolved asset. Depositors below this are inactive. Example: 1 USDC (7 decimals) = 10_000_000

status
enum<string>

Filter depositors by status. Filtering is applied before pagination so total reflects only the matching set. Aggregates remain vault-wide regardless.

Available options:
active,
idle,
inactive

Response

Depositor analytics returned successfully

vaultAddress
string
required
network
string
required
limit
number
required
offset
number
required
total
number
required
idleThresholdDays
number
required
depositors
object[]
required
aggregates
object
required