List live bonds

get/sigmafi/bonds

Bonds not yet repaid or liquidated, soonest maturity first. Only verified bonds unless all is true: a verified bond is the one its bond asset's genesis order created. Anyone can build a bond naming any asset, and such a bond only ever pays that asset's holder.

Query parameters

offsetintegerdefault 0
limitintegerdefault 10
allbooleandefault false
Include unverified bonds.

Responses

200One page of bondsSFBondList▶

heightintegerrequired
▶
bondsSFBondView[]required
- boxIdstringrequired
- assetIdstringrequired
  The bond asset whose holder is paid.
- ▶
  termsSFTermsrequired
  A bond's terms, as its order states them and the bond carries them.
  kindstringrequired
  The bond's kind. Every SigmaFi V2 bond is zero-coupon.
  principalNanoErgsstring
  Agreed nanoERG lent; for a token loan, the principal box's floor. Read directly from a bond's R6.
  ▶
  principalTokenSFTokenAmount
  tokenIdstringrequired
  amountstringrequired
  Base units.
  repaymentstringrequired
  What the borrower repays, in nanoERG or in base units of repayToken.
  repayTokenstring
  The token a token loan is repaid in. Absent when repaid in ERG.
  collateralNanoErgsstringrequired
  Borrower collateral nanoERG, excluding the lender-funded reserve.
  ▶
  collateralTokensSFTokenAmount[]required
  tokenIdstringrequired
  amountstringrequired
  Base units.
  maturityHeightinteger · int64
  Repayment is open strictly below it. Absent for an on-close order until it is filled.
  durationBlocksinteger · int64
  An on-close order's term, counted from its fill.
  batchingFeestringrequired
  Lender-funded reserve selected on fill; zero on unfilled orders. Refunded on repayment.
  liquidationstring
  The liquidation script's name. Absent when this client does not know it.
  liquidationHashstringrequired
- verifiedbooleanrequired
  Whether this is the bond its asset's genesis order created.
- verificationstring
  Why it is not verified.
- statusstringrequired
  one ofopenmatured
- blocksLeftinteger · int64required
  Blocks before repayment closes. 0 once matured.
- borrowerIsMebooleanrequired
- creationHeightintegerrequired
totalintegerrequired
unverifiedintegerrequired
Live bonds that failed verification, listed only with all.
truncatedbooleanrequired

400A malformed field, or terms no contract or shipped client accepts.ApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

503Node or index unavailable. Never returns a partial answer.ApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

← PreviousFill an order Next →Quote repaying a bond

{ "height": 0, "bonds": [ { "boxId": "string", "assetId": "string", "terms": { "kind": "string", "principalNanoErgs": "string", "principalToken": { "tokenId": "string", "amount": "string" }, "repayment": "string", "repayToken": "string", "collateralNanoErgs": "string", "collateralTokens": [ { "tokenId": "string", "amount": "string" } ], "maturityHeight": 0, "durationBlocks": 0, "batchingFee": "string", "liquidation": "string", "liquidationHash": "string" }, "verified": true, "verification": "string", "status": "open", "blocksLeft": 0, "borrowerIsMe": true, "creationHeight": 0 } ], "total": 0, "unverified": 0, "truncated": true }