Quote a swap order on any pool

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

What a swap order selling tokenIn would fill at against the pool now, for either kind of pool. tokenIn is ERG or one of the pool's tokens.

Path parameters

poolNftstringrequired
The pool's NFT id, 64 hex characters

Request body

LDPoolSwapRequest · application/json

tokenInstringrequired
ERG, or one of the pool's tokens
amountInstringrequired
Base units sold
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 quoteLDPoolSwapQuote▶

poolNFTstringrequired
tokenInstringrequired
tokenOutstringrequired
ERG, or the pool's other token
amountInstringrequired
amountOutstringrequired
What the pool gives for amountIn
minAmountInstring
The least input that still buys amountOut. Anything above it buys nothing more, which matters for a token whose single unit is worth a lot. Absent when nothing comes out.
netOutputstringrequired
What the owner receives
executablebooleanrequired
Whether the pool can fill this at all
executorFeestringrequired
maxMinerFeestringrequired
totalErgRequiredstringrequired
nanoERG the order box holds
▶
tokensRequiredLDTokenAmount[]required
Tokens the order box holds
- tokenIdstringrequired
- amountstringrequired
  Raw token units. Decimal string.
ergReturnedstringrequired
nanoERG returned beside the fill
networkFeestringrequired
The placement's own fee
priceImpactnumber · double
How far the fill falls short of the pool's price before it, fees included, as a fraction
protocolFeestring
Of tokenIn, set aside for the pool's providers
ammFeestring
Of tokenIn, the curve's own fee, which stays in the reserves

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

← PreviousCreate a LithosDex pool Next →Place a swap order on any pool

curl -X POST "http://localhost:9000/dex/pools/{poolNft}/orders/swap/check" \ -H "Content-Type: application/json" \ -d '{ "tokenIn": "ERG", "amountIn": "1000000000", "executorFee": "string", "maxMinerFee": "string" }'

{ "poolNFT": "string", "tokenIn": "string", "tokenOut": "string", "amountIn": "string", "amountOut": "string", "minAmountIn": "string", "netOutput": "string", "executable": true, "executorFee": "string", "maxMinerFee": "string", "totalErgRequired": "string", "tokensRequired": [ { "tokenId": "86e272f770aa4ef48ad7e6d6dbe98b5069edd8383a403a8edb3ceed8a3d5cea3", "amount": "152000000" } ], "ergReturned": "string", "networkFee": "string", "priceImpact": 0, "protocolFee": "string", "ammFee": "string" }