Sign in
Vaults

Get vault pseudonymised redemption queue

FIFO queue of pending redemption requests for the vault, denominated in shares with an asset-equivalent conversion. Pseudonymised: no controller and no txHash on any request row. Only the single v2 vault is supported; other vaults 404.

get/v3/vaults/{id}/redemption-queue

Request

  • Base URL: https://api.creditcoop.xyz
  • URL: https://api.creditcoop.xyz/v3/vaults/{id}/redemption-queue
  • 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
requestCountinteger required
totalPendingSharesstring nullable required

Sum of pending shares, display units. Null when the share-decimals read failed (see unavailable).

totalPendingAssetsstring nullable required

Asset-equivalent of totalPendingShares. Null when the share->asset conversion failed (see assetsUnavailable/unavailable) — never 0.

assetsUnavailableboolean required

True when any conversion dependency (baseUnit, sharePrice, assetDecimals, or shareDecimals) could not be read. Asset amounts are null in that case; share amounts are also null when the failed read was shareDecimals (see unavailable for which).

unavailablestring[] required

Which upstream fields failed to read (any of "baseUnit", "sharePrice", "assetDecimals", "shareDecimals"). Fields whose conversion depends on a listed read are null, never raw smallest-unit values.

earliestClearDateAllFlowDivertedstring nullable required

Best case. Earliest date at which cumulative projected repayment inflow would cover the pending queue if 100% of it were diverted to redemptions — a curator decision that is not committed or guaranteed. Null if never reached within the projection horizon or if assets are unavailable.

clearDateBasis'all_repayment_flow_diverted' required

Semantic basis for the clear date: all scheduled repayment flow diverted to the queue, a curator discretion, not a commitment.

inflowCoverageRatiostring nullable required

Projected repayment inflow over the next 30 days divided by totalPendingAssets, decimal string. Null when totalPendingAssets is "0" or unavailable.

Changes

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