Look up bond assets

post/sigmafi/assets

Whether each token is a SigmaFi bond asset, read from the chain and never from its name or description: the order that minted it, the bond it claims while that is live, and what the vault holds for it once settled. Up to 50 token ids.

Request body

SFAssetLookupRequest · application/json

tokenIdsstring[]required

Responses

200One entry per token id, in the order askedSFAssetLookup[]▶

tokenIdstringrequired
bondAssetbooleanrequired
Whether a SigmaFi order minted it.
verifiedbooleanrequired
verificationstring
▶
bondSFBondView
- 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
▶
vaultSFVaultView[]required
- boxIdstringrequired
- bondIdstring
  The bond this box settles.
- assetIdstringrequired
- nanoErgsstringrequired
- ▶
  tokensSFTokenAmount[]required
  tokenIdstringrequired
  amountstringrequired
  Base units.
statusstringrequired
Confirmed indexed bond state. Repaid and Liquidated are established from the actual spend, tagged payout and singleton burn, not inferred from maturity or absence in the live scan. Unknown means the index or spend evidence is incomplete or the spend used a rent extension.
one ofOpenMaturedRepaidLiquidatedUnknownUnverified
▶
settlementSFSettlement
Historical confirmed settlement, available even after the vault output is claimed.
- txIdstringrequired
- heightintegerrequired
- timestampinteger · int64
  Confirmed block timestamp in milliseconds, when the index provides it.
- bondBoxIdstringrequired
- ▶
  vaultSFVaultViewrequired
  boxIdstringrequired
  bondIdstring
  The bond this box settles.
  assetIdstringrequired
  nanoErgsstringrequired
  ▶
  tokensSFTokenAmount[]required
  tokenIdstringrequired
  amountstringrequired
  Base units.
- ▶
  returnedCollateralSFBoxValue
  boxIdstringrequired
  nanoErgsstringrequired
  ▶
  tokensSFTokenAmount[]required
  tokenIdstringrequired
  amountstringrequired
  Base units.
- liquidationHashstring
  Authenticated liquidation expression hash; present for Liquidated, absent for Repaid.
statusReasonstring
Why a verified asset's current settlement state could not be established.

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

← PreviousClaim a settled bond Next →This wallet in SigmaFi

[ { "tokenId": "string", "bondAsset": true, "verified": true, "verification": "string", "bond": { "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 }, "vault": [ { "boxId": "string", "bondId": "string", "assetId": "string", "nanoErgs": "string", "tokens": [ { "tokenId": "string", "amount": "string" } ] } ], "status": "Open", "settlement": { "txId": "string", "height": 0, "timestamp": 0, "bondBoxId": "string", "vault": { "boxId": "string", "bondId": "string", "assetId": "string", "nanoErgs": "string", "tokens": [ { "tokenId": "string", "amount": "string" } ] }, "returnedCollateral": { "boxId": "string", "nanoErgs": "string", "tokens": [ { "tokenId": "string", "amount": "string" } ] }, "liquidationHash": "string" }, "statusReason": "string" } ]