Quote an order

post/sigmafi/orders/check

What creating the order would lock, and its terms as a lender reads them. Signs nothing.

Request body

SFOrderRequest · application/json

collateralNanoErgsstringrequired
▶
collateralTokensSFTokenAmount[]
- tokenIdstringrequired
- amountstringrequired
  Base units.
principalNanoErgsstring
▶
principalTokenSFTokenAmount
- tokenIdstringrequired
- amountstringrequired
  Base units.
repaymentstringrequired
maturityHeightinteger · int64
At least 3 blocks above the current height.
durationBlocksinteger · int64
30 – …
batchingFeestring
Rejected on order creation. The lender selects this reserve in SFFillRequest instead.
liquidationstring
default "MaturityLiquidation"

Responses

200What the action would do. Nothing was signed or sent.SFQuote▶

actionstringrequired
boxIdstring
▶
termsSFTerms
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
paysNanoErgsstringrequired
What leaves this wallet, the network fee included.
▶
paysTokensSFTokenAmount[]required
- tokenIdstringrequired
- amountstringrequired
  Base units.
receivesNanoErgsstringrequired
▶
receivesTokensSFTokenAmount[]required
- tokenIdstringrequired
- amountstringrequired
  Base units.
feeNanoErgsstringrequired
notesstring[]required
warningsstring[]required

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

← PreviousCreate an order Next →Quote cancelling an order

curl -X POST "http://localhost:9000/sigmafi/orders/check" \ -H "Content-Type: application/json" \ -d '{ "collateralNanoErgs": "string", "collateralTokens": [ { "tokenId": "string", "amount": "string" } ], "principalNanoErgs": "string", "principalToken": { "tokenId": "string", "amount": "string" }, "repayment": "string", "maturityHeight": 0, "durationBlocks": 30, "batchingFee": "string", "liquidation": "MaturityLiquidation" }'

{ "action": "string", "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" }, "paysNanoErgs": "string", "paysTokens": [ { "tokenId": "string", "amount": "string" } ], "receivesNanoErgs": "string", "receivesTokens": [ { "tokenId": "string", "amount": "string" } ], "feeNanoErgs": "string", "notes": [ "string" ], "warnings": [ "string" ] }