Vaults

Get vault by ID

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.

get/v3/vaults/{id}

Request

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

Path parameters

idstring uuid required

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

Query parameters

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

idstring uuid required

Vault unique identifier

addressstring required

Vault contract address

networkIdstring required

CAIP-2 network identifier

publicListingEnabledboolean required

Whether this vault is opted into the public depositor-app surface. When true, the vault's /v3/vaults/:id/{repayment-schedule,credit-history,redemption-queue,capacity} routes are available; non-listed vaults 404 on those routes. Not sensitive — this is a public designation of an already-public vault.

protocolVersionstring nullable required

Credit Coop protocol/contract generation ("v1", "v2", or "v3"). Determines which fields apply — several facility and credit-line fields are v3 only. Null when not classified.

labelstring nullable required

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

organizationIdstring uuid nullable required

Vault curator organization ID

deployedAtstring date-time nullable required

Timestamp when the vault contract was deployed

Example response

{
  "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.