This wallet in SigmaFi

get/sigmafi/portfolioapi_key

This wallet's open orders, the bonds it borrows on, and the bond assets it holds with what the vault holds for each.

Responses

200The portfolioSFPortfolio▶

heightintegerrequired
▶
ordersSFOrderView[]required
- boxIdstringrequired
- ▶
  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
- borrowerstring
  The address the principal goes to, when this client can tell.
- minebooleanrequired
- refusalstring
  Why this client would not fill it. Absent when it would.
- creationHeightintegerrequired
▶
borrowingSFBondView[]required
Bonds whose collateral returns to this wallet on repayment.
- 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
▶
lendingSFHolding[]required
Bond assets this wallet holds.
- assetIdstringrequired
- ▶
  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.
- claimablebooleanrequired
  Whether a claim goes through now. The bond's own settlement output is known and unspent.
truncatedbooleanrequired

403Missing or wrong api_key.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

← PreviousLook up bond assets Next →List configured oracle feeds

{ "height": 0, "orders": [ { "boxId": "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" }, "borrower": "string", "mine": true, "refusal": "string", "creationHeight": 0 } ], "borrowing": [ { "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 } ], "lending": [ { "assetId": "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" } ] } ], "claimable": true } ], "truncated": true }