List your positions and offers
/forwards/positionsapi_keyEvery position this wallet holds a side of, by window end, with its status and a mark against the strike; and every unspent offer it made, open or not, so expired ones can be cancelled.
Responses
200This wallet's positions and offersDFPositionList▶
heightinteger · int32requiredcurrentEpochinteger · int32required▶
positionsDFPositionView[]requiredboxIdstringrequiredsidestringrequiredThis wallet's side;
bothwhen it holds both keys.one oflongshortbothlongstringrequiredAddress the long side is paid to.
shortstringrequiredstrikestringrequirednotionalstringrequiredmarginstringrequiredwindowStartinteger · int32requiredwindowLengthinteger · int32requiredwindowEndinteger · int32requiredstatusstringrequiredwaitingbefore the window starts,in_windowuntil its last epoch is recorded,settleableonce it is, andrefundableonce its first epoch has left the accumulator, when each side gets its margin back.one ofwaitingin_windowsettleablerefundableepochsKnowninteger · int32requiredWindow epochs whose difficulty is known, recorded or current.
markDifficultystringThe window's mean with every unknown epoch at the newest difficulty known. Absent when refundable.
markMovenumber · doublemarkDifficultyagainst the strike, as a fraction.markPayoutstringLIT base units the long side would receive on top of its margin at the mark, negative when the short side is paid; at most the margin either way. Exact once settleable.
pnlstringmarkPayoutfrom this wallet's side; zero when it holds both.owedLongstringLIT base units a settlement now pays the long side, margin included. Present once settleable or refundable.
owedShortstring
▶
offersDFOfferView[]requiredEvery unspent offer this wallet made, open, expired or unfillable.
boxIdstringrequiredmakerstringrequiredAddress the maker is paid to.
makerSidestringrequiredlongis paid when the window's mean difficulty is above the strike,shortwhen below.one oflongshortstrikestringrequiredDifficulty the window's mean is measured against.
notionalstringrequiredLIT base units.
marginstringrequiredEach side's margin, a fifth of the notional, and the most either side can lose of it.
windowStartinteger · int32requiredwindowLengthinteger · int32requiredwindowEndinteger · int32requiredThe window's last epoch.
expiryinteger · int32requiredThe last height a fill can be mined at.
lastFillHeightinteger · int32requiredThe 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.
litstringrequiredLIT base units the offer holds.
nanoErgsstringrequiredtakerLitstringrequiredLIT base units a fill takes from the taker.
takerNanoErgsstringrequirednanoERG a fill takes from the taker, network fee included.
impliedMovenumber · doubleThe strike against the current difficulty, as a fraction.
impliedMoveNextnumber · doubleThe strike against
nextDifficulty, when known.minebooleanrequiredWhether this wallet made the offer.
fillablebooleanrequiredWhether this wallet's fill sent now would be accepted.
refusalstringWhy not, when
fillableis false.
truncatedbooleanrequiredWhether a scan stopped at 2,000 boxes, so older boxes may be missing.
403Missing or wrong api_keyApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
503Node or index unavailable. Never returns a partial list.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