List open offers

get/forwards/offers

Offers a fill in a coming block could still take: holding the maker's whole side, unexpired, and with a window that starts 2 to 120 epochs after the current one. Unconfirmed offers are included and offers already being spent are not. Ordered by window start, then length, then strike.

Query parameters

offsetintegerdefault 0
limitintegerdefault 50

Responses

200One page of open offersDFOfferBook▶

heightinteger · int32required
currentEpochinteger · int32required
▶
offersDFOfferView[]required
- 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.
totalintegerrequired
Open offers in all, before offset and limit.
truncatedbooleanrequired
Whether the scan stopped at 2,000 boxes, so older offers may be missing.

400`offset` is negative or `limit` is outside 1 to 200.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 list.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

← PreviousDifficulty accumulator and the next epoch's difficulty Next →Create an offer