Depositors

Depositor portfolio and performance metrics

Get depositor pending deposits

get

Get pending deposit requests across all vaults for a given depositor controller address. If networkId is omitted, results span all chains. Requires authentication.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringRequired

API key in the format: cc_xxx_yyy (for customer API routes)

Query parameters

addressstring · max: 200Required

Depositor controller address to look up pending deposits for. The controller is the address that initiated the ERC-7540 async request (pendingDepositRequest / pendingRedeemRequest) and may differ from the eventual share owner — e.g. a smart wallet or router acting on a user's behalf. Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

vaultAddressstring · max: 42Optional

Filter to a specific vault address. Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

Pattern: ^0x[0-9a-fA-F]{40}$

networkIdstring · max: 200Optional

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

Responses

200

Default Response

application/json

controllerAddressstringRequired

ERC-7540 controller address — the account that initiated the async deposit/redeem request. May differ from the eventual share owner.

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

400

Default Response

application/json

get/v3/depositors/pending-deposits

HTTPcURLJavaScriptPython

GET /v3/depositors/pending-deposits?address=text HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

{
  "controllerAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "pendingDeposits": [
    {
      "vaultId": "550e8400-e29b-41d4-a716-446655440000",
      "vaultAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "networkId": "eip155:1",
      "pendingAssets": "text",
      "decimals": 1,
      "assetToken": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
    }
  ],
  "claimableDeposits": [
    {
      "vaultId": "550e8400-e29b-41d4-a716-446655440000",
      "vaultAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "networkId": "eip155:1",
      "claimableAssets": "text",
      "claimableShares": "text",
      "decimals": 1,
      "assetToken": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
    }
  ]
}

Get depositor pending redemptions

get

Get pending redemption requests across all vaults for a given depositor controller address. If networkId is omitted, results span all chains. Requires authentication.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringRequired

API key in the format: cc_xxx_yyy (for customer API routes)

Query parameters

addressstring · max: 200Required

Depositor controller address to look up pending redemptions for. The controller is the address that initiated the ERC-7540 async request (pendingDepositRequest / pendingRedeemRequest) and may differ from the eventual share owner — e.g. a smart wallet or router acting on a user's behalf. Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

vaultAddressstring · max: 42Optional

Filter to a specific vault address. Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

Pattern: ^0x[0-9a-fA-F]{40}$

networkIdstring · max: 200Optional

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

Responses

200

Default Response

application/json

controllerAddressstringRequired

ERC-7540 controller address — the account that initiated the async deposit/redeem request. May differ from the eventual share owner.

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

400

Default Response

application/json

get/v3/depositors/pending-redemptions

HTTPcURLJavaScriptPython

GET /v3/depositors/pending-redemptions?address=text HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

{
  "controllerAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "pendingRedemptions": [
    {
      "vaultId": "550e8400-e29b-41d4-a716-446655440000",
      "vaultAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "networkId": "eip155:1",
      "pendingShares": "text",
      "decimals": 1,
      "shareToken": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
    }
  ],
  "claimableRedemptions": [
    {
      "vaultId": "550e8400-e29b-41d4-a716-446655440000",
      "vaultAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "networkId": "eip155:1",
      "claimableShares": "text",
      "claimableAssets": "text",
      "decimals": 1,
      "shareToken": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
    }
  ]
}

Get depositor vault balances

get

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.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringRequired

API key in the format: cc_xxx_yyy (for customer API routes)

Query parameters

addressstring · max: 200Required

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

networkIdstring · max: 200Optional

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

includeZeroBalancesbooleanOptional

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

Responses

200

Default Response

application/json

addressstringRequired

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

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

400

Default Response

application/json

get/v3/depositors/balances

HTTPcURLJavaScriptPython

GET /v3/depositors/balances?address=text HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

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

Get depositor portfolio

get

Returns a depositor's portfolio broken down by vault and aggregated at the portfolio level. Per-vault data includes: annualized yield (APY calculated as IRR/money-weighted return), holding period, interest earned, start/end position values, total deposited/withdrawn, share balances, and deposit/withdraw counts — all in both native token amounts (raw integer strings) and USD where pricing is available. The portfolio-level summary aggregates these metrics across all vaults in USD, including a combined APY. Use the expand parameter to include per-vault transaction timelines (with running balances), organization details, and daily time series (vault-daily-stats for per-vault, portfolio-daily-stats for portfolio-level, or daily-stats for both). Uses FIFO accounting for cost basis tracking. Supports optional date range filtering — when startDate is provided, all prior transactions are used to compute the opening position. Requires authentication.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringRequired

API key in the format: cc_xxx_yyy (for customer API routes)

Query parameters

addressstring · max: 200Required

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

networkIdstring · max: 200Optional

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

startDatestringOptional

ISO 8601 date for the start of the measurement window (earliest: 2020-01-01). Prior transactions are used to compute the opening position.

Example: 2025-01-01

endDatestringOptional

ISO 8601 date for the end of the measurement window (inclusive). Defaults to now.

Example: 2025-03-19

Responses

200

Default Response

application/json

addressstringRequired

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

networkIdstring · nullableRequired

CAIP-2 network filter applied (null if querying all chains)

startDatestring · date-time · nullableRequired

Start of measurement window (resolved from param or earliest activity; null if no activity)

endDatestring · date-time · nullableRequired

End of measurement window (resolved from param or current time; null if no activity)

400

Default Response

application/json

get/v3/depositors/portfolio

HTTPcURLJavaScriptPython

GET /v3/depositors/portfolio?address=text HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

{
  "address": "text",
  "networkId": "text",
  "startDate": "2026-07-12T01:06:52.841Z",
  "endDate": "2026-07-12T01:06:52.841Z",
  "vaults": [
    {
      "vaultId": "123e4567-e89b-12d3-a456-426614174000",
      "vaultAddress": "text",
      "networkId": "text",
      "apyPct": 1,
      "holdingPeriodDays": 1,
      "assetToken": "text",
      "assetTokenSymbol": "text",
      "decimals": 1,
      "organization": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "text",
        "slug": "text",
        "header": "text",
        "description": "text",
        "overview": "text",
        "links": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "label": "text",
            "linkText": "text",
            "iconUrl": "text",
            "url": "text"
          }
        ]
      },
      "totalInterestEarned": "text",
      "startValue": "text",
      "endValue": "text",
      "totalDeposited": "text",
      "totalWithdrawn": "text",
      "totalInterestEarnedUsd": "text",
      "startValueUsd": "text",
      "endValueUsd": "text",
      "totalDepositedUsd": "text",
      "totalWithdrawnUsd": "text",
      "totalTransferredIn": "text",
      "totalTransferredOut": "text",
      "totalTransferredInUsd": "text",
      "totalTransferredOutUsd": "text",
      "totalSharesDeposited": "text",
      "totalSharesWithdrawn": "text",
      "totalSharesTransferredIn": "text",
      "totalSharesTransferredOut": "text",
      "startShares": "text",
      "endShares": "text",
      "depositCount": 1,
      "withdrawCount": 1,
      "transferInCount": 1,
      "transferOutCount": 1,
      "dailyStats": [
        {
          "date": "2025-01-15",
          "shares": "text",
          "balance": "text",
          "balanceUsd": "text",
          "totalInterestEarned": "text",
          "totalInterestEarnedUsd": "text"
        }
      ],
      "transactions": [
        {
          "type": "deposit",
          "timestamp": "2026-07-12T01:06:52.841Z",
          "amount": "text",
          "amountUsd": "text",
          "balance": "text",
          "shares": "text",
          "sharesBalance": "text",
          "balanceUsd": "text",
          "txHash": "text"
        }
      ]
    }
  ],
  "portfolio": {
    "apyPct": 1,
    "holdingPeriodDays": 1,
    "startValueUsd": "text",
    "endValueUsd": "text",
    "totalDepositedUsd": "text",
    "totalWithdrawnUsd": "text",
    "totalTransferredInUsd": "text",
    "totalTransferredOutUsd": "text",
    "transferInCount": 1,
    "transferOutCount": 1,
    "totalInterestEarnedUsd": "text",
    "dailyStats": [
      {
        "date": "2025-01-15",
        "balanceUsd": "text",
        "totalInterestEarnedUsd": "text"
      }
    ]
  }
}