Quote an offer
/forwards/offers/checkWhat creating an offer would lock and when it would expire, without sending anything. The same checks as POST /forwards/offers, and the conditions worth reading first as warnings.
Request body
DFOfferRequest · application/jsonmakerSidestringrequiredThe side this wallet takes.
one oflongshortstrikestringrequiredDifficulty the window's mean is measured against.
notionalstringrequiredLIT base units. Each side's margin is a fifth of it.
windowStartinteger · int32requiredFirst epoch of the window, 2 to 120 epochs after the current one.
windowLengthinteger · int32required1 – 120expiryinteger · int32Last height a fill can be mined at. Defaults to the last block of the current epoch.
Responses
200Quote for the offerDFOfferQuote▶
makerSidestringrequiredone oflongshortstrikestringrequirednotionalstringrequiredmarginstringrequiredwindowStartinteger · int32requiredwindowLengthinteger · int32requiredwindowEndinteger · int32requiredexpiryinteger · int32requiredexpiresInBlocksinteger · int32requiredBlocks after the next one until the offer expires.
lastFillHeightinteger · int32requiredlitstringrequiredLIT base units locked in the offer, the margin plus 7.5 LIT of rewards.
nanoErgsstringrequirednanoERG locked in the offer.
networkFeestringrequiredmaxLossstringrequiredThe most this wallet can lose once the offer is filled, its margin plus 7.5 LIT.
impliedMovenumber · doubleimpliedMoveNextnumber · doublewarningsstring[]required
400Malformed body, or terms no fill accepts.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
422No fill could reach the window, the notional is over the short-window limit, or no accumulator is deployed.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
503Node unavailable. Retry.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
defaultErrorApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description