Quote filling an offer

post/forwards/offers/{boxId}/fill/check

What filling an offer takes from this wallet and the side it would hold. offer.fillable says whether a fill sent now would be accepted, and offer.refusal why not. No body.

Path parameters

boxIdstringrequired
Offer box id, as listed by GET /forwards/offers or GET /forwards/positions.

Responses

200Quote for the fillDFFillQuote▶

▶
offerDFOfferViewrequired
- boxIdstringrequired
- makerstringrequired
  Address the maker is paid to.
- makerSidestringrequired
  long is paid when the window's mean difficulty is above the strike, short when below.
  one oflongshort
- strikestringrequired
  Difficulty the window's mean is measured against.
- notionalstringrequired
  LIT base units.
- marginstringrequired
  Each side's margin, a fifth of the notional, and the most either side can lose of it.
- windowStartinteger · int32required
- windowLengthinteger · int32required
- windowEndinteger · int32required
  The window's last epoch.
- expiryinteger · int32required
  The last height a fill can be mined at.
- lastFillHeightinteger · int32required
  The last height a fill can actually be mined at: the expiry, or earlier when the window would start less than 2 epochs after the fill.
- litstringrequired
  LIT base units the offer holds.
- nanoErgsstringrequired
- takerLitstringrequired
  LIT base units a fill takes from the taker.
- takerNanoErgsstringrequired
  nanoERG a fill takes from the taker, network fee included.
- impliedMovenumber · double
  The strike against the current difficulty, as a fraction.
- impliedMoveNextnumber · double
  The strike against nextDifficulty, when known.
- minebooleanrequired
  Whether this wallet made the offer.
- fillablebooleanrequired
  Whether this wallet's fill sent now would be accepted.
- refusalstring
  Why not, when fillable is false.
takerSidestringrequired
The side this wallet takes, opposite the maker's.
one oflongshort
takerLitstringrequired
takerNanoErgsstringrequired
Network fee included.
networkFeestringrequired
maxLossstringrequired
The most this wallet can lose, its margin plus 7.5 LIT.
warningsstring[]required

400`boxId` is not a box id.ApiError▶

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

404No unspent offer has that id.ApiError▶

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

422No accumulator is deployed.ApiError▶

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

503Node unavailable. Retry.ApiError▶

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

defaultErrorApiError▶

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

← PreviousQuote an offer Next →Fill an offer