Quote a deposit order
/dex/orders/deposit/checkQuote a deposit order offering amountX and amountY against the current pool. Shares are bought with the scarcer side, and the rest of the other side is returned when the order fills. /dex/deposit/check finds a balanced pair.
Request body
LDDepositOrderRequest · application/jsonamountXstringrequiredMost nanoERG the order offers to the reserves, not counting the provision box. Decimal string.
amountYstringrequiredRaw token units the order offers. Decimal string.
executorFeestringnanoERG paid to whoever fills the order. 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 deposit orderLDDepositOrderQuote▶
sharesstringrequiredShares the offer buys against the current pool. Decimal string.
amountXstringrequirednanoERG the pool would take. Decimal string.
amountYstringrequiredRaw token units the pool would take. Decimal string.
excessXstringrequirednanoERG offered beyond what the pool would take, returned with the fill. Decimal string.
excessYstringrequiredToken side of
excessX. Decimal string.shareOfSupplynumber · doublerequiredFraction of the pool the provision would represent once it lands
provisionBoxValuestringrequirednanoERG that funds the new provision box, on top of
amountX. Decimal string.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:
amountX,excessX,provisionBoxValue,executorFeeandergReturned. Decimal string.ergReturnedstringrequirednanoERG returned to the owner with the fill, beside the
ownerNFT, not countingexcessX. Decimal string.networkFeestringrequirednanoERG paid to place the order. Decimal string.
400Malformed body, a non-positive amount, or a `maxMinerFee` not below `executorFee`.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
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