Depositors

Get depositor vault balances

Get vault share balances for a depositor address. Returns vaults where the address holds shares, with current balance and asset value. If networkId is omitted, results span all chains. Requires authentication.

get/v3/depositors/balances

Request

Base URL: https://api.creditcoop.xyz
URL: https://api.creditcoop.xyz/v3/depositors/balances
Auth: one of:
- API key in header x-api-key
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://clerk.creditcoop.xyz/oauth/authorize, token URL https://clerk.creditcoop.xyz/oauth/token)

Query parameters

protocolVersionstring[]

Filter by protocol version(s). Comma-separated or repeated (e.g. ?protocolVersion=v1,v2 or ?protocolVersion=v1&protocolVersion=v2). Omit to return all versions.

addressstring required

Depositor owner address — the ERC-4626 holder of vault shares (per balanceOf). Returns balances for shares currently owned by this address. Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

networkIdstring

CAIP-2 network ID (e.g., "eip155:1", "eip155:8453"). If omitted, results span all chains.

includeZeroBalancesboolean

If true, include vaults where the address has historical transfer activity but current balance is 0. Defaults to false.

Response

Default Response

addressstring required

Depositor owner address queried — the ERC-4626 share holder.

Example response

{
  "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "vaults": [
    {
      "vaultId": "550e8400-e29b-41d4-a716-446655440000",
      "vaultAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "networkId": "eip155:1",
      "assetToken": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.