Quote a liquidity deposit
/dex/deposit/checkQuote a deposit. Supply availableX and availableY for the most shares those funds buy, or shares for the cheapest deposit that buys exactly that many.
Request body
LDDepositRequest · application/jsonavailableXstringnanoERG available to deposit. Decimal string.
availableYstringRaw token units available to deposit. Decimal string.
sharesstringExact number of LP shares to buy. Decimal string.
Responses
200Quote for the requested depositLDDepositQuote▶
sharesstringrequiredLP shares the deposit unlocks; becomes the provision's size. Decimal string.
amountXstringrequirednanoERG the pool takes. Decimal string.
amountYstringrequiredRaw token units the pool takes. Decimal string.
shareOfSupplynumber · doublerequiredFraction of the pool the provision will represent once it lands
provisionBoxValuestringrequirednanoERG that must also fund the new provision box, on top of amountX. Decimal string.
totalErgRequiredstringrequiredTotal nanoERG leaving the wallet, network fee aside. Decimal string.
entryXstringrequiredAccumulator the provision enters at. It is owed nothing accrued before this. Decimal string.
entryYstringrequiredToken side of the same. Decimal string.
400Supply either `shares`, or both `availableX` and `availableY`.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