Quote a claim
/sigmafi/claims/{tokenId}/checkWhat a claim of this bond asset takes, and what it leaves locked. Signs nothing.
Path parameters
tokenIdstringrequiredThe bond asset's token id.
Responses
200What the action would do. Nothing was signed or sent.SFQuote▶
actionstringrequiredboxIdstring▶
termsSFTermsA bond's terms, as its order states them and the bond carries them.
kindstringrequiredThe bond's kind. Every SigmaFi V2 bond is
zero-coupon.principalNanoErgsstringAgreed nanoERG lent; for a token loan, the principal box's floor. Read directly from a bond's R6.
▶
principalTokenSFTokenAmounttokenIdstringrequiredamountstringrequiredBase units.
repaymentstringrequiredWhat the borrower repays, in nanoERG or in base units of
repayToken.repayTokenstringThe token a token loan is repaid in. Absent when repaid in ERG.
collateralNanoErgsstringrequiredBorrower collateral nanoERG, excluding the lender-funded reserve.
▶
collateralTokensSFTokenAmount[]requiredtokenIdstringrequiredamountstringrequiredBase units.
maturityHeightinteger · int64Repayment is open strictly below it. Absent for an on-close order until it is filled.
durationBlocksinteger · int64An on-close order's term, counted from its fill.
batchingFeestringrequiredLender-funded reserve selected on fill; zero on unfilled orders. Refunded on repayment.
liquidationstringThe liquidation script's name. Absent when this client does not know it.
liquidationHashstringrequired
paysNanoErgsstringrequiredWhat leaves this wallet, the network fee included.
▶
paysTokensSFTokenAmount[]requiredtokenIdstringrequiredamountstringrequiredBase units.
receivesNanoErgsstringrequired▶
receivesTokensSFTokenAmount[]requiredtokenIdstringrequiredamountstringrequiredBase units.
feeNanoErgsstringrequirednotesstring[]requiredwarningsstring[]required
404No unspent box has that id, it is not the kind named, or it is not this wallet's.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
422Valid, but not possible now: the box's terms are refused, maturity has passed or not come, the wallet cannot cover it, or no wallet box can authorize a cancel.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
503Node or index unavailable. Never returns a partial answer.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description