Quote a redeem order
/dex/orders/redeem/checkQuote an order closing a provision. claimableX / claimableY are claimed by the transaction placing the order. unflushedX / unflushedY, and any fees earned while the order waits, are lost when it fills.
Request body
LDRedeemOrderRequest · application/jsonprovisionBoxIdstringrequiredexecutorFeestringnanoERG paid to whoever fills the order, out of the ERG it releases. A fill broadcast to the mempool pays its miner fee out of this. Miners skip orders paying less than they accept. Omit for the client's default. Decimal string.
maxMinerFeestringMost nanoERG a fill may pay as a miner fee, out of
executorFee. Must be belowexecutorFee. Omit for the client's default. Decimal string.
Responses
200Quote for the requested redeem orderLDRedeemOrderQuote▶
sharesstringrequiredLP shares the order would close. Decimal string.
amountXstringrequirednanoERG share of the reserves at the current pool. Decimal string.
amountYstringrequiredRaw token units share of the reserves at the current pool. Decimal string.
provisionValuestringrequirednanoERG held by the provision box, returned with the fill. Decimal string.
receivedXstringrequirednanoERG paid to the owner if the order fills against the current pool:
amountX,provisionValueandtotalErgRequired, lessexecutorFee. Decimal string.claimableXstringrequiredSettled ERG fees claimed by the transaction placing the order. Decimal string.
claimableYstringrequiredToken side of
claimableX. Decimal string.unflushedXstringrequiredERG fees earned but not yet flushed. They cannot be claimed at placement and are lost when the order fills. Decimal string.
unflushedYstringrequiredToken side of
unflushedX. Decimal string.withinMinSupplybooleanrequiredFalse when closing this provision would take supply under the contract's minimum. Such an order is refused.
executorFeestringrequiredThe executor fee applied, the request's or the client's default. Decimal string.
maxMinerFeestringrequiredThe miner fee cap applied. Decimal string.
totalErgRequiredstringrequirednanoERG locked in the order box beside the
ownerNFT, returned with the fill. Decimal string.networkFeestringrequirednanoERG paid to place the order. Decimal string.
400Malformed body, or a `maxMinerFee` not below `executorFee`.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
404No live provision with that id.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
409The provision moved. Re-read to find its current box id.LDStateChangedResponse▶
errorintegerrequiredreasonstringrequireddetailstringrequiredWhat moved, and what it moved to
poolBoxIdstringCurrent pool box id
vaultBoxIdstringCurrent vault box id
provisionBoxIdstringCurrent provision box id
503Node unavailable. Retry.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