List open orders
/sigmafi/ordersBorrowers' orders waiting for a lender, newest first. Unconfirmed orders are included and orders already being spent are not. collateral keeps orders whose collateral holds that token, or any ERG with erg; loan keeps orders borrowing that token, or ERG with erg. Each order says why this client would not fill it, when it would not.
Query parameters
offsetintegerdefault 0limitintegerdefault 10collateralstringA token id the collateral must hold, or
ergfor collateral with any ERG.loanstringThe token lent, or
ergfor ERG loans.
Responses
200One page of open ordersSFOrderBook▶
heightintegerrequired▶
ordersSFOrderView[]requiredboxIdstringrequired▶
termsSFTermsrequiredA 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
borrowerstringThe address the principal goes to, when this client can tell.
minebooleanrequiredrefusalstringWhy this client would not fill it. Absent when it would.
creationHeightintegerrequired
totalintegerrequiredtruncatedbooleanrequiredThe scan stopped at its cap, so older orders were not read.
400A malformed field, or terms no contract or shipped client accepts.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