Vaults

List vaults

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.

get/v3/vaults

Request

  • Base URL: https://api.creditcoop.xyz
  • URL: https://api.creditcoop.xyz/v3/vaults
  • 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)
    • none

Query parameters

organizationIdstring uuid

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

addressstring

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

networkIdstring

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

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.

publicListingEnabledboolean

Filter to vaults opted into the public depositor-app surface (or, when false, vaults not opted in). Omit to return both.

limitinteger
offsetinteger
expandstring[]

Comma-separated list of fields to expand. Valid values: "related-addresses" (fetches on-chain addresses: creditStrategy, liquidStrategy, vaultCurator. creditStrategy/liquidStrategy are v2-only and null for v3 vaults (which have no strategy layer); vaultCurator is the vault owner.), "assets" (fetches asset info: assetToken, shareToken, decimals, totalAssets, totalLiquidAssets, totalSupply, sharePrice, baseUnit, totalActiveCredit, uninvestedCreditAssets), "organization" (includes full organization object with links), "apy" (fetches 30-day APY from historical sharePrice snapshots), "fees" (fetches managementFee and performanceFee from creditStrategy in basis points).

Response

Default Response

Example response

{
  "vaults": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "networkId": "eip155:1",
      "protocolVersion": "v3",
      "organizationId": "550e8400-e29b-41d4-a716-446655440000",
      "deployedAt": "2025-01-15T10:30:00Z",
      "organization": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      },
      "relatedAddresses": {
        "creditStrategy": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "liquidStrategy": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "vaultCurator": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "whitelister": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "synchronizer": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
      },
      "assets": {
        "assetToken": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "shareToken": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
      }
    }
  ]
}

Changes

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