v1

latestOpenAPI 3.0.12026-07-2342024.5 KB
Service

Get the best zap-in route.

get/api/v1/in/route

Query parameters

dex'DEX_UNISWAPV3' required
pool.idstring required

id of the pool to zap into.

position.idstring

id of the position to add liquidity to; omit to create a new uniswapV3 position. for uniswapV2 this is user address

position.tickLowerinteger

min tick of the position, required if creating a new uniswapV3 position.

position.tickUpperinteger

max tick of the position, required if creating a new uniswapV3 position.

tokensInstring[] required

which token(s) to use as zap source. also accepts comma separated addresses

amountsInstring[] required

amount(s) to zap including fee, corresponding to tokenIn. also accepts comma separated amounts.

tokenInstring[]

which token(s) to use as zap source. also accepts comma separated addresses. deprecated: use tokens_in. if both fields are specified, they are combined

amountInstring[]

amount(s) to zap including fee, corresponding to tokenIn. also accepts comma separated amounts. deprecated: use amounts_in. if both fields are specified, they are combined

aggregatorOptions.disableboolean

whether to disable swapping with the aggregator

aggregatorOptions.includedSourcesstring

comma-separated list of sources to use for aggregator

aggregatorOptions.excludedSourcesstring

comma-separated list of sources to exclude for aggregator

aggregatorOptions.excludedPoolsstring

comma-separated list of pools to exclude for aggregator

feeAddressstring

the address of the fee recipient.

feePcminteger

fee percentage in per cent mille (0.001% or 1 in 100,000). Ignored if feeAddress is empty. From 0 to 100,000 inclusively. Example: 1 for 0.001%.

slippageinteger

maximum slippage tolerance in basis points (0.01%), used for aggregator (exceeding which the transaction will revert) and pool swap during zap (for additional zapping and for refund). From 0 to 10,000 inclusively. Example: 1 for 0.01%.

Headers

X-Client-Idstring

Client Id

X-Request-Idstring

Request Id

Response

A successful response.

codeinteger
messagestring
requestIdstring
All 4 operations