Vaults

Vault management

List vaults

get

List enabled vaults with organization info. Authentication is optional but affects results: unauthenticated requests only see vaults with public organizations, authenticated users see vaults with public orgs plus private orgs they have access to.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringOptional

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

Query parameters

organizationIdstring · uuid · max: 36Optional

Filter by vault curator organization ID. Example: 550e8400-e29b-41d4-a716-446655440000

addressstring · max: 100Optional

Filter by vault address. Case-insensitive when networkId is omitted or is an EVM chain (eip155:*), case-sensitive otherwise. Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

networkIdstring · max: 50Optional

Filter by network ID (CAIP-2 blockchain ID), e.g., eip155:1 (Ethereum), eip155:137 (Polygon), solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp (Solana)

limitinteger · min: 1 · max: 100OptionalDefault: 20

offsetintegerOptionalDefault: 0

Responses

200

Default Response

application/json

get/v3/vaults

HTTPcURLJavaScriptPython

GET /v3/vaults HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

200

Default Response

{
  "vaults": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "networkId": "eip155:1",
      "protocolVersion": "v2",
      "label": "text",
      "organizationId": "550e8400-e29b-41d4-a716-446655440000",
      "deployedAt": "2025-01-15T10:30:00Z",
      "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"
          }
        ]
      },
      "relatedAddresses": {
        "creditStrategy": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "liquidStrategy": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "vaultCurator": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "whitelister": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
      },
      "assets": {
        "assetToken": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "shareToken": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "decimals": 1,
        "totalAssets": "text",
        "totalLiquidAssets": "text",
        "totalSupply": "text",
        "sharePrice": "text",
        "baseUnit": "text",
        "totalActiveCredit": "text",
        "uninvestedCreditAssets": "text"
      },
      "apy": {
        "apyPct30D": 1
      },
      "fees": {
        "managementFee": 1,
        "performanceFee": 1
      }
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

Get vault by ID

get

Get a single vault by ID with organization info. Authentication is optional but required to view vaults with private organizations. Vaults with public organizations are visible to everyone.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringOptional

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

Path parameters

idstring · uuidRequired

Vault ID. Example: 550e8400-e29b-41d4-a716-446655440000

Query parameters

Responses

200

Default Response

application/json

idstring · uuidRequired

Vault unique identifier

Example: 550e8400-e29b-41d4-a716-446655440000

addressstringRequired

Vault contract address

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

networkIdstringRequired

CAIP-2 network identifier

Example: eip155:1

protocolVersionstring · nullableRequired

Credit Coop protocol/contract generation (e.g. "v1", "v2"). Null when not classified.

Example: v2

labelstring · nullableRequired

Display label for the vault. Always present; null if not configured.

organizationIdstring · uuid · nullableRequired

Vault curator organization ID

Example: 550e8400-e29b-41d4-a716-446655440000

deployedAtstring · date-time · nullableRequired

Timestamp when the vault contract was deployed

Example: 2025-01-15T10:30:00Z

404

Default Response

application/json

get/v3/vaults/{id}

HTTPcURLJavaScriptPython

GET /v3/vaults/{id} HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "networkId": "eip155:1",
  "protocolVersion": "v2",
  "label": "text",
  "organizationId": "550e8400-e29b-41d4-a716-446655440000",
  "deployedAt": "2025-01-15T10:30:00Z",
  "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"
      }
    ]
  },
  "relatedAddresses": {
    "creditStrategy": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "liquidStrategy": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "vaultCurator": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "whitelister": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
  },
  "assets": {
    "assetToken": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "shareToken": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "decimals": 1,
    "totalAssets": "text",
    "totalLiquidAssets": "text",
    "totalSupply": "text",
    "sharePrice": "text",
    "baseUnit": "text",
    "totalActiveCredit": "text",
    "uninvestedCreditAssets": "text"
  },
  "apy": {
    "apyPct30D": 1
  },
  "fees": {
    "managementFee": 1,
    "performanceFee": 1
  }
}

Get vault event logs

get

Get on-chain event logs for a vault.

Supports three response formats via the format query parameter:

• json (default) — paginated JSON (default limit 20, max 1000).

• csv — streamed CSV file download (up to 1 000 000 rows).

• event-stream — Server-Sent Events stream (up to 1 000 000 rows). Each log is emitted as a named log event with JSON data. A final done event carries {"total": N}. Connect with EventSource or fetch:

const es = new EventSource('/v3/vaults/{id}/logs?format=event-stream');
es.addEventListener('log', (e) => console.log(JSON.parse(e.data)));
es.addEventListener('done', (e) => { console.log('total:', JSON.parse(e.data).total); es.close(); });

Authentication is optional but required for vaults with private organizations. Events are ordered by most recent first. For v2 vaults this spans the vault contract, its credit strategy, liquid strategy, and credit facilities; for v3 vaults it currently covers the vault contract's own events (ERC-7540 deposit/redeem activity and PositionAdded/PositionRemoved) — facility-level event coverage is still being added.

Event types: AddCredit, CancelDepositRequest, CancelRedeemRequest, Deposit, DepositRequest, IncreaseCredit, ManagerDeposit, ManagerWithdraw, MintManagementShares, MintPerformanceShares, PositionAdded, PositionRemoved, ProcessDepositRequest, ProcessRedeemRequest, RedeemRequest, SetFee, SetManager, StrategyDeposit, StrategyWithdraw, SwapCreditPositionForTokens, VaultDeposit, VaultWithdraw, Withdraw, WithdrawDeposit, WithdrawProfit.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringOptional

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

Path parameters

idstring · uuidRequired

Vault ID. Example: 550e8400-e29b-41d4-a716-446655440000

Query parameters

formatstring · enumOptional

Response format. "json" returns paginated JSON (default 20, max 1000). "csv" returns a streamed CSV file download. "event-stream" returns Server-Sent Events with each log as a named "log" event and a final "done" event. Event types: AddCredit, CancelDepositRequest, CancelRedeemRequest, Deposit, DepositRequest, IncreaseCredit, ManagerDeposit, ManagerWithdraw, MintManagementShares, MintPerformanceShares, PositionAdded, PositionRemoved, ProcessDepositRequest, ProcessRedeemRequest, RedeemRequest, SetFee, SetManager, StrategyDeposit, StrategyWithdraw, SwapCreditPositionForTokens, VaultDeposit, VaultWithdraw, Withdraw, WithdrawDeposit, WithdrawProfit.

Default: jsonPossible values:

startDatestring · dateOptional

Start date (YYYY-MM-DD). Example: 2025-01-15

endDatestring · dateOptional

End date, inclusive (YYYY-MM-DD). Example: 2025-01-15

limitinteger · min: 1Optional

Maximum number of results. For json: default 20, max 1000. For csv/event-stream: default 1000000, max 1000000.

offsetintegerOptionalDefault: 0

Responses

200

Vault event logs. Response format depends on the format query parameter.

application/jsontext/csvtext/event-stream

vaultAddressstringRequired

Vault contract address

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

networkIdstring · nullableRequired

CAIP-2 network identifier (e.g. eip155:1)

Example: eip155:1

404

Default Response

application/json

get/v3/vaults/{id}/logs

HTTPcURLJavaScriptPython

GET /v3/vaults/{id}/logs HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

{
  "vaultAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "networkId": "eip155:1",
  "logs": [
    {
      "timestamp": "2025-01-15T10:30:00Z",
      "eventType": "text",
      "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "amount": "text",
      "decimals": 1,
      "token": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "shares": "text",
      "shareToken": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "contractAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "txHash": "text",
      "lineTokenId": "text",
      "feeType": "text",
      "managerShares": "text",
      "protocolShares": "text",
      "protocolTreasury": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

Get vault historical asset metrics

get

Get a daily timeseries of vault asset metrics derived from on-chain snapshots. Returns totalAssets, totalLiquidAssets, sharePrice, and a 30-day rolling APY for each calendar day in the requested range. Authentication is optional but required for vaults with private organizations and may increase rate limits.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringOptional

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

Path parameters

idstring · uuidRequired

Vault ID. Example: 550e8400-e29b-41d4-a716-446655440000

Query parameters

startDatestring · dateOptional

Start date (YYYY-MM-DD, UTC). Defaults to the earliest available snapshot date.

endDatestring · dateOptional

End date, inclusive (YYYY-MM-DD, UTC). Defaults to the latest available snapshot date.

Responses

200

Default Response

application/json

vaultAddressstringRequired

Vault contract address

networkIdstring · nullableRequired

CAIP-2 network identifier

assetTokenstring · nullableRequired

Underlying asset token address (ERC-4626 asset())

shareTokenstring · nullableRequired

Vault share token address (ERC-4626 share())

decimalsnumber · nullableRequired

Asset token decimals (shared by asset and share tokens)

404

Default Response

application/json

get/v3/vaults/{id}/historical/assets

HTTPcURLJavaScriptPython

GET /v3/vaults/{id}/historical/assets HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

{
  "vaultAddress": "text",
  "networkId": "text",
  "assetToken": "text",
  "shareToken": "text",
  "decimals": 1,
  "data": [
    {
      "date": "text",
      "totalAssets": "text",
      "totalLiquidAssets": "text",
      "sharePrice": "text",
      "apyPct30D": 1
    }
  ]
}

Get vault credit lines

get

Get credit lines for a vault by querying on-chain data from the creditStrategy contract. Authentication is optional but required to view vaults with private organizations. Vaults with public organizations are visible to everyone.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringOptional

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

Path parameters

idstring · uuidRequired

Vault ID. Example: 550e8400-e29b-41d4-a716-446655440000

Query parameters

Responses

200

Default Response

application/json

vaultIdstring · uuidRequired

Vault ID

Example: 550e8400-e29b-41d4-a716-446655440000

vaultAddressstringRequired

Vault contract address

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

networkIdstringRequired

CAIP-2 network identifier

Example: eip155:1

404

Default Response

application/json

get/v3/vaults/{id}/credit-lines

HTTPcURLJavaScriptPython

GET /v3/vaults/{id}/credit-lines HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

{
  "vaultId": "550e8400-e29b-41d4-a716-446655440000",
  "vaultAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "networkId": "eip155:1",
  "creditLines": [
    {
      "lineTokenId": "text",
      "deposit": "text",
      "creditLimit": "text",
      "principal": "text",
      "interestBalance": "text",
      "interestAccrued": "text",
      "interestRepaid": "text",
      "token": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "decimals": 1,
      "isOpen": true,
      "isRestricted": true,
      "earlyWithdrawalFee": "text",
      "deadline": "2025-01-15T10:30:00Z",
      "drawRate": "text",
      "facilityRate": "text",
      "apyPct": 1,
      "createdTxHash": "text",
      "createdBlockNumber": 1,
      "createdAt": "2025-01-15T10:30:00Z",
      "commitmentValue": "text",
      "claimable": "text",
      "facilityType": "text",
      "isDefaulted": true,
      "fees": {
        "originationFees": "text"
      },
      "error": "text",
      "relatedAddresses": {
        "facility": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "facilityOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
        "borrower": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "servicing": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "servicingId": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "totals": {
    "deposit": "text",
    "principal": "text",
    "interestAccrued": "text",
    "interestRepaid": "text",
    "interestBalance": "text",
    "decimals": 1,
    "depositUsd": "text",
    "principalUsd": "text",
    "interestAccruedUsd": "text",
    "interestRepaidUsd": "text",
    "interestBalanceUsd": "text",
    "creditLimitUsd": "text"
  }
}

Get vault liquid strategy

get

Get liquid strategy details for a vault. Authentication is optional but required to view vaults with private organizations. Returns external ERC4626 vault positions with share balances and their underlying asset values. v3 vaults have no liquid strategy (idle capital is held directly), so they return an empty vaults array with liquidStrategyAddress set to the zero address and null totals.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringOptional

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

Path parameters

idstring · uuidRequired

Vault ID. Example: 550e8400-e29b-41d4-a716-446655440000

Query parameters

Responses

200

Default Response

application/json

vaultIdstring · uuidRequired

Vault ID

Example: 550e8400-e29b-41d4-a716-446655440000

vaultAddressstringRequired

Vault contract address

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

networkIdstring · nullableRequired

CAIP-2 network identifier

Example: eip155:1

liquidStrategyAddressstring · nullableRequired

Liquid strategy contract address

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

assetTokenstring · nullableRequired

Underlying asset token address shared by all external vaults

Example: 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48

decimalsinteger · nullableRequired

Decimal precision of the underlying asset token. Applies to asset-denominated values: totalAssets, uninvestedAssets, vaultAssets, and assetsValue.

404

Default Response

application/json

get/v3/vaults/{id}/liquid-strategy

HTTPcURLJavaScriptPython

GET /v3/vaults/{id}/liquid-strategy HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

{
  "vaultId": "550e8400-e29b-41d4-a716-446655440000",
  "vaultAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "networkId": "eip155:1",
  "liquidStrategyAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "assetToken": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
  "decimals": 1,
  "vaults": [
    {
      "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "name": "text",
      "symbol": "text",
      "shares": "text",
      "shareDecimals": 1,
      "assetsValue": "text",
      "apy": {
        "apyPct30D": 1
      }
    }
  ],
  "totals": {
    "totalAssets": "text",
    "uninvestedAssets": "text",
    "vaultAssets": "text",
    "apy": {
      "apyPct30D": 1
    }
  }
}

Check vault whitelist status

get

Check if an address is whitelisted on the vault's credit strategy contract (requires authentication)

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringRequired

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

Path parameters

idstring · uuidRequired

Vault ID. Example: 550e8400-e29b-41d4-a716-446655440000

Query parameters

addressstring · max: 255Required

The address to check for whitelisting. Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

Responses

200

Default Response

application/json

vaultIdstring · uuidRequired

Vault ID

Example: 550e8400-e29b-41d4-a716-446655440000

vaultAddressstringRequired

Vault contract address

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

networkIdstringRequired

CAIP-2 network identifier

Example: eip155:1

addressstringRequiredExample: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

isWhitelistedbooleanRequired

404

Default Response

application/json

get/v3/vaults/{id}/whitelist-check

HTTPcURLJavaScriptPython

GET /v3/vaults/{id}/whitelist-check?address=text HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

{
  "vaultId": "550e8400-e29b-41d4-a716-446655440000",
  "vaultAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "networkId": "eip155:1",
  "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "isWhitelisted": true
}

Get vault pending deposits

get

Get pending deposit requests for a vault. Requires a role for the vault's organization.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringRequired

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

Path parameters

idstring · uuidRequired

Vault ID. Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Default Response

application/json

vaultIdstring · uuidRequired

Vault ID

Example: 550e8400-e29b-41d4-a716-446655440000

vaultAddressstringRequired

Vault contract address

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

networkIdstringRequired

CAIP-2 network identifier

Example: eip155:1

decimalsinteger · nullableRequired

404

Default Response

application/json

get/v3/vaults/{id}/pending-deposits

HTTPcURLJavaScriptPython

GET /v3/vaults/{id}/pending-deposits HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

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

Get vault pending redemptions

get

Get pending redemption requests for a vault. Requires a role for the vault's organization.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringRequired

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

Path parameters

idstring · uuidRequired

Vault ID. Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Default Response

application/json

vaultIdstring · uuidRequired

Vault ID

Example: 550e8400-e29b-41d4-a716-446655440000

vaultAddressstringRequired

Vault contract address

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

networkIdstringRequired

CAIP-2 network identifier

Example: eip155:1

decimalsinteger · nullableRequired

404

Default Response

application/json

get/v3/vaults/{id}/pending-redemptions

HTTPcURLJavaScriptPython

GET /v3/vaults/{id}/pending-redemptions HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

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