Quote a redeem order on any pool

post/dex/pools/{poolNft}/orders/redeem/check

What closing a provision through an order returns now, and the fees the placement would claim from the vault first. A fill forfeits anything left unclaimed.

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 quoteLDPoolRedeemQuote▶

poolNFTstringrequired
provisionBoxIdstringrequired
sharesstringrequired
amountXstringrequired
The provision's share of reserve X; nanoERG for an ERG/token pool
amountYstringrequired
claimableXstringrequired
Claimed from the vault by the placement. A fill forfeits anything unclaimed.
claimableYstringrequired
provisionValuestringrequired
ergReturnedstringrequired
nanoERG back beside the reserves, net of the fee where it comes out of them
withinMinSupplybooleanrequired
False when the pool refuses to close this provision
executorFeestringrequired
maxMinerFeestringrequired
totalErgRequiredstringrequired
networkFeestringrequired

400The request is malformed, or 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

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

503The pool index is still building, or the node could not be read. 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

← PreviousPlace a deposit order on any pool Next →Place a redeem order on any pool