Quote a direct redemption on any pool

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

What closing the provision now returns, and the fees the vault owes it that a direct redemption loses.

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

poolNFTstringrequired
provisionBoxIdstringrequired
sharesstringrequired
amountXstringrequired
amountYstringrequired
ergReturnedstringrequired
The provision box's ERG, which comes back beside the reserves
unclaimedXstringrequired
Fees the vault owes the provision now, lost when its box is spent
unclaimedYstringrequired
withinMinSupplybooleanrequired
networkFeestringrequired
poolBoxIdstringrequired

400The request is malformed, names a token the pool does not hold, or leaves out an acknowledgement it needs.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

422The pool can be drained, the pool cannot fill this at its depth or above the floor, or the wallet cannot cover it.ApiError▶

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

503Node or wallet unavailable. Retry.ApiError▶

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

← PreviousDeposit directly on any pool Next →Redeem a provision directly on any pool

Request

curl -X POST "http://localhost:9000/dex/pools/{poolNft}/redeem/check" \
  -H "Content-Type: application/json" \
  -d '{ "provisionBoxId": "string", "executorFee": "string", "maxMinerFee": "string" }'

Response

{
  "poolNFT": "string",
  "provisionBoxId": "string",
  "shares": "string",
  "amountX": "string",
  "amountY": "string",
  "ergReturned": "string",
  "unclaimedX": "string",
  "unclaimedY": "string",
  "withinMinSupply": true,
  "networkFee": "string",
  "poolBoxId": "string"
}