Create an offer
/forwards/offersapi_keyLock this wallet's side of a forward, its margin plus 7.5 LIT of rewards, in an offer any taker can fill. Cancel it with POST /forwards/offers/{boxId}/cancel while it is unfilled.
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
200Result of the transaction creating the offerDFOfferResult▶
txIdstringrequiredoutcomestringrequiredone ofacceptedrejecteduncertainofferBoxIdstringrequired
400Malformed body, or terms no fill accepts.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
403Missing or wrong api_keyApiError▶
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, no accumulator is deployed, or the wallet cannot cover the LIT and ERG.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
503Node, wallet or transaction engine unavailable, or the request ran out of time. The message says whether anything was sent. When it says the outcome is unknown, check this wallet's offers and positions before retrying.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