Vaults

Get vault deposit-epoch capacity

Current deposit-epoch target size and live allocation for the vault. epoch is null when no epoch is configured for the vault — a legitimate state, not an error. allocated is always a live on-chain read (never the stored epoch value); a null allocated means the read failed (see unavailable) — it is never reported as 0. Only the single v2 vault is supported; other vaults 404.

get/v3/vaults/{id}/capacity

Request

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

Response

Default Response

vaultIdstring uuid required
targetSizestring nullable required

Smallest-unit integer string; null when uncapped or no epoch is configured

allocatedstring nullable required

Live totalAssets, smallest-unit integer string; null only on a failed RPC read (see unavailable) — never 0

remainingstring nullable required

targetSize minus allocated, floored at 0, smallest-unit integer string; null when uncapped or allocated is unavailable

utilizationPctnumber nullable required

allocated / targetSize * 100; null when uncapped (targetSize null) or targetSize is 0

depositorCountinteger nullable required

Distinct depositor (ERC-4626 Deposit owner) addresses, all-time; null only when the chain id could not be resolved (see unavailable) — never 0

decimalsinteger nullable required

Asset-token decimals for targetSize/allocated/remaining

unavailablestring[] required

Which upstream fields failed to read (e.g. ["totalAssets"])

Changes

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