Place a redeem order on any pool

post/dex/pools/{poolNft}/orders/redeemapi_key

Moves the provision's NFT into a redeem order, in the same transaction claiming what the vault owes the provision. Needs the NFT in this wallet. Open on every pool, whatever its genesis, so liquidity can always leave.

Path parameters

poolNftstringrequired
The pool's NFT id, 64 hex characters

Request body

LDPoolRedeemRequest · application/json

provisionBoxIdstringrequired
The live provision box to close
executorFeestring
nanoERG the filler keeps. Omitted, from lithosdex.orders.
maxMinerFeestring
Most of the executor fee a broadcast fill may pay as a network fee. Below executorFee.

Responses

200The placementLDPoolOrderPlaced▶

outcomestringrequired
one ofacceptedrejecteduncertain
txIdstringrequired
poolNFTstringrequired
kindstringrequired
one ofSWAPDEPOSITREDEEM
orderBoxIdstringrequired
claimedXstring
A redeem placement: what it claimed from the vault
claimedYstring
provisionBoxIdstring
A redeem placement that claimed: the provision's successor

400The request is malformed, names a token the pool does not hold.ApiError▶

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

403Missing or wrong api_keyApiError▶

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

404No LithosDex pool with that NFT, or no live provision with that id.ApiError▶

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

409A box the placement spends moved, or another LithosDex mutation is running. Re-quote and resend.LDStateChangedResponse▶

errorintegerrequired
reasonstringrequired
detailstringrequired
What moved, and what it moved to
poolBoxIdstring
Current pool box id
vaultBoxIdstring
Current vault box id
provisionBoxIdstring
Current provision box id

422The pool can be drained, the pool cannot fill this, or the wallet cannot cover it.ApiError▶

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

503The pool index is still building, the pool's genesis could not be read, or the node or wallet did not answer. 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 a redeem order on any pool Next →LithosDex fee vault state