ZaaS HTTP API

Please refer to the following server configuration and openapi file for the http API.

Common Parameters

Configuration

Value

Base URL

https://zap-api.kyberswap.com/{chain} where chain is one of the supported chain. For example: https://zap-api.kyberswap.com/arbitrum

Header X-Client-Id

Some value to identify your client.

Please contact [email protected] to whitelist your client id with more rate limit quota

Please refer to dex-ids.md and zaps-supported-chains-dexes.md for list of supported DEXes for each chain and their corresponding IDs

API list

Zap in

Get the best zap-in route.

get

Query parameters

dexstring · enumRequired

Refer to https://docs.kyberswap.com/kyberswap-solutions/kyberswap-zap-as-a-service/zaps-supported-chains-dexes for list of supported dexes for each chain

Example: DEX_UNISWAPV3Possible values:

pool.idstringRequired

id of the pool to zap into.

Example: 0x2f5e87c9312fa29aed5c179e456625d79015299c

position.idstringOptional

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

position.tickLowerinteger · int32Optional

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

Example: 120000

position.tickUpperinteger · int32Optional

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

Example: 480000

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[]Optional

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

Example: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE

amountInstring[]Optional

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

Example: 1000000000000000000

aggregatorOptions.disablebooleanOptional

whether to disable swapping with the aggregator

aggregatorOptions.includedSourcesstringOptional

comma-separated list of sources to use for aggregator

aggregatorOptions.excludedSourcesstringOptional

comma-separated list of sources to exclude for aggregator

aggregatorOptions.excludedPoolsstringOptional

comma-separated list of pools to exclude for aggregator

feeAddressstringOptional

the address of the fee recipient.

feePcminteger · int64Optional

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 · int64Optional

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%.

Example: 100

Header parameters

X-Client-IdstringOptional

Client Id

Example: zap-docs

X-Request-IdstringOptional

Request Id

Responses

200

A successful response.

application/json

Returns the best route to zap-in to the specified pool position.

codeinteger · int32Optional

messagestringOptional

requestIdstringOptional

400

Invalid Argument

application/json

404

Not Found

application/json

default

An unexpected error response.

application/json

get

/api/v1/in/route

GET /arbitrum/api/v1/in/route?dex=DEX_UNISWAPV3&pool.id=text&tokensIn=text&amountsIn=text HTTP/1.1
Host: zap-api.kyberswap.com
Accept: */*

{
  "message": "OK",
  "data": {
    "poolDetails": {
      "category": "common_pair",
      "uniswapV3": {
        "tick": 259661,
        "newTick": 259661,
        "sqrtP": "34441043722219267846042009462652656",
        "newSqrtP": "34441043737601305531684264539945030"
      }
    },
    "positionDetails": {
      "addedLiquidity": "1149974764979",
      "addedAmountUsd": "3670.40949860"
    },
    "zapDetails": {
      "initialAmountUsd": "3673.00201650",
      "actions": [
        {
          "type": "ACTION_TYPE_PROTOCOL_FEE",
          "protocolFee": {
            "pcm": 50,
            "tokens": [
              {
                "address": "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
                "amount": "500000000000000",
                "amountUsd": "1.83650101"
              }
            ]
          }
        },
        {
          "type": "ACTION_TYPE_AGGREGATOR_SWAP",
          "aggregatorSwap": {
            "swaps": [
              {
                "tokenIn": {
                  "address": "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
                  "amount": "499958741353837836",
                  "amountUsd": "1836.34946516"
                },
                "tokenOut": {
                  "address": "0x2f2a2543b76a4166549f7aab2e75bef0aefc5b0f",
                  "amount": "2644815",
                  "amountUsd": "1835.59443695"
                }
              }
            ]
          }
        },
        {
          "type": "ACTION_TYPE_POOL_SWAP",
          "poolSwap": {
            "swaps": [
              {
                "tokenIn": {
                  "address": "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",
                  "amount": "102872182233841",
                  "amountUsd": "0.37784973"
                },
                "tokenOut": {
                  "address": "0x2f2a2543b76a4166549f7aab2e75bef0aefc5b0f",
                  "amount": "544",
                  "amountUsd": "0.37755509"
                }
              }
            ]
          }
        },
        {
          "type": "ACTION_TYPE_ADD_LIQUIDITY",
          "addLiquidity": {
            "token0": {
              "address": "0x2f2a2543b76a4166549f7aab2e75bef0aefc5b0f",
              "amount": "2645358",
              "amountUsd": "1835.97129800"
            },
            "token1": {
              "address": "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",
              "amount": "499438386463928322",
              "amountUsd": "1834.43820060"
            }
          }
        }
      ],
      "finalAmountUsd": "3670.40949860",
      "priceImpact": 0.070583075
    },
    "route": "KLUv/WAdB00bAOY5nCNAj3JMrqhs1F7Rx8ZtyeIRkgGqIXfgSOampMyhZleOYZgzAYgAigChAM2d3Nn7iLnY66vzVWYuXVS7q9ecpZ+zuUgxlxgVb4CvKk5c764QuTno0imHOZAmq01WqNmBDoff4WhbyNyxdn8hlq4uHYQOP1BjCDWHV0uHsQX9crda1svR5WSJl+75T1b4y8HZzdt+qYcdjX0yKJX+s7wxlBi85iCX0RzlUjbnuKRa5Tb3XEbqyqp2Of//RpLLhIJJCiRtYlJRk0uHGLyGI0Dr/+ek+tNxrUdW3G9EDMDECqAxIvZvK0xEXR2gEM1dLrFL1zB4KVM9X3vb1XX/1/nXb69d/6uUL4VyQUzVXKVZTCIREw9Ecimj1lUzXeXyRNWcxaVVVsuo//zJzUVQkfdfeTvXWykzqsJeinEpk7nPJOIMUC4aIpOJRPSQtIN0WgHQJtgjYZSHhEk8709hFpZLksolagwRhAISwdd1/NluW+wXS/XMIaXQYo5lmQ/kbGQyoVwGBERzLbpMKpcyJ9Aa1BoBq0SYdulScxc+sie3wgC0sIeFPXjZI7oocGLv6/pSVr7bGV0UmiXCoOZaxGERCKsQaA+kshC1iQpDSMe+u1hx768GtLq65hwWh1ZfARm1VPGq5h6XMo1GJtPIVuqpmz/Vql6ZjPnoqlZTPS3icqW+WN2bIVLDPT0pXPxk76WsnZSHSw1MvnA961prlx+iOTS4hwRyEak0h+RySWGaQ1LQUAGJWIKloEEfEoBJRLmoPJBKBNAqKpdHU9FVcXnbs/+3ZT/sdW0/ns63cyvmUGYqZ6OyQrg6PTUymeZQXBImAmEgQAJCDDOmHZLEGJj0Yxm1rG2f2YZ071vZSmuTEYMc7ksXKTyQndCnyoI34X93YwbNI3xyLUJ6AY9LrS6IJcMwm/eSsBsVqAI2PFuTKUizGWTHhcFXrKvsl7iawsClp6xyNDBUSxoFdUsqRanhffuMrI+Aa2sqmbkA6Xgu21EIhh/cypg4W7hogNnGFhyT24o1cAeaZ5ILOW7cAQIfQCmJ49N52JNgQ7O7L1gWAkKhheQ60Elw0AKCCulGAVUHGJgaPIElWIKKTLpC06UHnCVX7TvCAMNuc2ogLKuyTnCUAPqFS2x0VeyCy+qwbowuW746oVmIAg==",
    "routerAddress": "0x6960f99e6F9A9A5EFcd44C5BaA3245aC2b145287",
    "gas": "1451371",
    "gasUsd": "0.05330889"
  },
  "requestId": "45fa8a6175f45233678b10fc2a72c4b9"
}

curl -X GET "https://zap-api.kyberswap.com/polygon/api/v1/in/route?dex=DEX_UNISWAPV3&pool.id=0xb46388f104ff88aac68626a316aaf3a924f32055&position.tickLower=-24800&position.tickUpper=32400&tokensIn=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE&amountsIn=1000000000000000000&slippage=100" \
 -H "accept: application/json"\
 -H "x-client-id: zap-docs"

fetch('https://zap-api.kyberswap.com/polygon/api/v1/in/route?dex=DEX_UNISWAPV3&pool.id=0xb46388f104ff88aac68626a316aaf3a924f32055&position.tickLower=-24800&position.tickUpper=32400&tokensIn=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE&amountsIn=1000000000000000000&slippage=100', {
  headers: {
    'accept': 'application/json',
    'x-client-id': 'zap-docs'
  }
});

import requests

headers = {
    'accept': 'application/json',
    'x-client-id': 'zap-docs',
}

params = {
    'dex': 'DEX_UNISWAPV3',
    'pool.id': '0xb46388f104ff88aac68626a316aaf3a924f32055',
    'position.tickLower': '-24800',
    'position.tickUpper': '32400',
    'tokensIn': '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE',
    'amountsIn': '1000000000000000000',
    'slippage': '100',
}

response = requests.get('https://zap-api.kyberswap.com/polygon/api/v1/in/route', params=params, headers=headers)

require 'net/http'

uri = URI('https://zap-api.kyberswap.com/polygon/api/v1/in/route?dex=DEX_UNISWAPV3&pool.id=0xb46388f104ff88aac68626a316aaf3a924f32055&position.tickLower=-24800&position.tickUpper=32400&tokensIn=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE&amountsIn=1000000000000000000&slippage=100')
req = Net::HTTP::Get.new(uri)
req['accept'] = 'application/json'
req['x-client-id'] = 'zap-docs'

req_options = {
  use_ssl: uri.scheme == 'https'
}
res = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(req)
end

Build Route

curl -X POST "https://zap-api.kyberswap.com/polygon/api/v1/in/route/build" \
 -H "accept: application/json"\
 -H "content-type: application/json"\
 -H "x-client-id: zap-docs" \
 -d '{"sender":"0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270","recipient":"0x5cb738DAe833Ec21fe65ae1719fAd8ab8cE7f23D","route":"KLUv/WALBWUVAKavgSFAb9qflX03+n9Wj9hEtiy3sD717uBIcklIUtb9UBVFASZwAG8AewCseGGDZz+f91M98txGAZqZqQsXPJhqdXGMHUIosW9O3X9D9ykvz587bZntFA+ybObckq051tD33d6immunvvu1fJ584ZaJB7tzeUH7jBfGkjJLmzw1GHNfFpS6uHNC7SJxoQMzFkbw7EKHR7EubGBGFDwMD76LRM+krFq9qkyNUC9kEi1HIhRHC7BQ8iwgDMREw9E88FRyoQUe3d1X1WmZdd13nzPVJkbpFzKe9ImUFau7UkkdoU7rrkob/cLF8yr1lzvRdntKumohg+d/c1MyvypzJ3ZnVvmqUP/CCZ4MFRR4b3mPgEmai5fykypW/M+uUGc6UqjV+vaERXQuLpywCFTMSWW+a2rki1JyJv301E6EuKEkvAnDloWPaYxxsAqB13BIFJo3IWEHB3k7n1FCrqvSKw5wk4ZUrp6p7OnTanbzoEAo2KPg8SYgEsWHb+4OUMcV4GmAOiwMlcrDQ6WC3tilpdQOpUrWinl/I8SaO19ljaGwCjy58OK5R0HTdAWK0Cu13SgoCBMNCNMGIhgMvlCiiXg8g4PuNRIRjmcBsBUAktd4MIa1iAeTaFy8CLOY4HlIKM1baBwUDqZ/XfvWqSrba5ma77q5X5V6i/o178ZAIBHMcHBY+BoKRIInQCBAAkOIkfEBRAi1htoyA+Fh2bFWvRh8hvz97PowAKx1qdsQ5xjp2pgs22UIOyQAShdlhjfwZzCdB+z1ohnGvFnSTTKxnORd4epZFuIeA+w2wAw7LgAorNLwQsqNf+xgg82V4vgsD37S9QzcQQb7FtadgPK3lKx7U4HBskxWQGuCP0HydKwMJ+YSsBBVIoM2YptDA0F2jZS8pJQuID3loJeJAg==","deadline":1800000000,"source":"zap-docs"}'

fetch('https://zap-api.kyberswap.com/polygon/api/v1/in/route/build', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'content-type': 'application/json',
    'x-client-id': 'zap-docs'
  },
  body: JSON.stringify({
    'sender': '0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270',
    'recipient': '0x5cb738DAe833Ec21fe65ae1719fAd8ab8cE7f23D',
    'route': 'KLUv/WALBWUVAKavgSFAb9qflX03+n9Wj9hEtiy3sD717uBIcklIUtb9UBVFASZwAG8AewCseGGDZz+f91M98txGAZqZqQsXPJhqdXGMHUIosW9O3X9D9ykvz587bZntFA+ybObckq051tD33d6immunvvu1fJ584ZaJB7tzeUH7jBfGkjJLmzw1GHNfFpS6uHNC7SJxoQMzFkbw7EKHR7EubGBGFDwMD76LRM+krFq9qkyNUC9kEi1HIhRHC7BQ8iwgDMREw9E88FRyoQUe3d1X1WmZdd13nzPVJkbpFzKe9ImUFau7UkkdoU7rrkob/cLF8yr1lzvRdntKumohg+d/c1MyvypzJ3ZnVvmqUP/CCZ4MFRR4b3mPgEmai5fykypW/M+uUGc6UqjV+vaERXQuLpywCFTMSWW+a2rki1JyJv301E6EuKEkvAnDloWPaYxxsAqB13BIFJo3IWEHB3k7n1FCrqvSKw5wk4ZUrp6p7OnTanbzoEAo2KPg8SYgEsWHb+4OUMcV4GmAOiwMlcrDQ6WC3tilpdQOpUrWinl/I8SaO19ljaGwCjy58OK5R0HTdAWK0Cu13SgoCBMNCNMGIhgMvlCiiXg8g4PuNRIRjmcBsBUAktd4MIa1iAeTaFy8CLOY4HlIKM1baBwUDqZ/XfvWqSrba5ma77q5X5V6i/o178ZAIBHMcHBY+BoKRIInQCBAAkOIkfEBRAi1htoyA+Fh2bFWvRh8hvz97PowAKx1qdsQ5xjp2pgs22UIOyQAShdlhjfwZzCdB+z1ohnGvFnSTTKxnORd4epZFuIeA+w2wAw7LgAorNLwQsqNf+xgg82V4vgsD37S9QzcQQb7FtadgPK3lKx7U4HBskxWQGuCP0HydKwMJ+YSsBBVIoM2YptDA0F2jZS8pJQuID3loJeJAg==',
    'deadline': 1800000000,
    'source': 'zap-docs'
  })
});

import requests

headers = {
    'accept': 'application/json',
    'content-type': 'application/json',
    'x-client-id': 'zap-docs',
}

json_data = {
    'sender': '0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270',
    'recipient': '0x5cb738DAe833Ec21fe65ae1719fAd8ab8cE7f23D',
    'route': 'KLUv/WALBWUVAKavgSFAb9qflX03+n9Wj9hEtiy3sD717uBIcklIUtb9UBVFASZwAG8AewCseGGDZz+f91M98txGAZqZqQsXPJhqdXGMHUIosW9O3X9D9ykvz587bZntFA+ybObckq051tD33d6immunvvu1fJ584ZaJB7tzeUH7jBfGkjJLmzw1GHNfFpS6uHNC7SJxoQMzFkbw7EKHR7EubGBGFDwMD76LRM+krFq9qkyNUC9kEi1HIhRHC7BQ8iwgDMREw9E88FRyoQUe3d1X1WmZdd13nzPVJkbpFzKe9ImUFau7UkkdoU7rrkob/cLF8yr1lzvRdntKumohg+d/c1MyvypzJ3ZnVvmqUP/CCZ4MFRR4b3mPgEmai5fykypW/M+uUGc6UqjV+vaERXQuLpywCFTMSWW+a2rki1JyJv301E6EuKEkvAnDloWPaYxxsAqB13BIFJo3IWEHB3k7n1FCrqvSKw5wk4ZUrp6p7OnTanbzoEAo2KPg8SYgEsWHb+4OUMcV4GmAOiwMlcrDQ6WC3tilpdQOpUrWinl/I8SaO19ljaGwCjy58OK5R0HTdAWK0Cu13SgoCBMNCNMGIhgMvlCiiXg8g4PuNRIRjmcBsBUAktd4MIa1iAeTaFy8CLOY4HlIKM1baBwUDqZ/XfvWqSrba5ma77q5X5V6i/o178ZAIBHMcHBY+BoKRIInQCBAAkOIkfEBRAi1htoyA+Fh2bFWvRh8hvz97PowAKx1qdsQ5xjp2pgs22UIOyQAShdlhjfwZzCdB+z1ohnGvFnSTTKxnORd4epZFuIeA+w2wAw7LgAorNLwQsqNf+xgg82V4vgsD37S9QzcQQb7FtadgPK3lKx7U4HBskxWQGuCP0HydKwMJ+YSsBBVIoM2YptDA0F2jZS8pJQuID3loJeJAg==',
    'deadline': 1800000000,
    'source': 'zap-docs',
}

response = requests.post('https://zap-api.kyberswap.com/polygon/api/v1/in/route/build', headers=headers, json=json_data)

require 'net/http'
require 'json'

uri = URI('https://zap-api.kyberswap.com/polygon/api/v1/in/route/build')
req = Net::HTTP::Post.new(uri)
req.content_type = 'application/json'
req['accept'] = 'application/json'
req['x-client-id'] = 'zap-docs'

req.body = {
  'sender' => '0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270',
  'recipient' => '0x5cb738DAe833Ec21fe65ae1719fAd8ab8cE7f23D',
  'route' => 'KLUv/WALBWUVAKavgSFAb9qflX03+n9Wj9hEtiy3sD717uBIcklIUtb9UBVFASZwAG8AewCseGGDZz+f91M98txGAZqZqQsXPJhqdXGMHUIosW9O3X9D9ykvz587bZntFA+ybObckq051tD33d6immunvvu1fJ584ZaJB7tzeUH7jBfGkjJLmzw1GHNfFpS6uHNC7SJxoQMzFkbw7EKHR7EubGBGFDwMD76LRM+krFq9qkyNUC9kEi1HIhRHC7BQ8iwgDMREw9E88FRyoQUe3d1X1WmZdd13nzPVJkbpFzKe9ImUFau7UkkdoU7rrkob/cLF8yr1lzvRdntKumohg+d/c1MyvypzJ3ZnVvmqUP/CCZ4MFRR4b3mPgEmai5fykypW/M+uUGc6UqjV+vaERXQuLpywCFTMSWW+a2rki1JyJv301E6EuKEkvAnDloWPaYxxsAqB13BIFJo3IWEHB3k7n1FCrqvSKw5wk4ZUrp6p7OnTanbzoEAo2KPg8SYgEsWHb+4OUMcV4GmAOiwMlcrDQ6WC3tilpdQOpUrWinl/I8SaO19ljaGwCjy58OK5R0HTdAWK0Cu13SgoCBMNCNMGIhgMvlCiiXg8g4PuNRIRjmcBsBUAktd4MIa1iAeTaFy8CLOY4HlIKM1baBwUDqZ/XfvWqSrba5ma77q5X5V6i/o178ZAIBHMcHBY+BoKRIInQCBAAkOIkfEBRAi1htoyA+Fh2bFWvRh8hvz97PowAKx1qdsQ5xjp2pgs22UIOyQAShdlhjfwZzCdB+z1ohnGvFnSTTKxnORd4epZFuIeA+w2wAw7LgAorNLwQsqNf+xgg82V4vgsD37S9QzcQQb7FtadgPK3lKx7U4HBskxWQGuCP0HydKwMJ+YSsBBVIoM2YptDA0F2jZS8pJQuID3loJeJAg==',
  'deadline' => 1800000000,
  'source' => 'zap-docs'
}.to_json

req_options = {
  use_ssl: uri.scheme == 'https'
}
res = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(req)
end

Zap Migrate

Get the best zap-migrate route.

get

Query parameters

dexFromstring · enumRequired

Refer to https://docs.kyberswap.com/kyberswap-solutions/kyberswap-zap-as-a-service/zaps-supported-chains-dexes for list of supported dexes for each chain

Example: DEX_UNISWAPV3Possible values:

dexTostring · enumRequired

Refer to https://docs.kyberswap.com/kyberswap-solutions/kyberswap-zap-as-a-service/zaps-supported-chains-dexes for list of supported dexes for each chain

Example: DEX_UNISWAPV3Possible values:

poolFrom.idstringRequired

id of the pool to zap into.

poolTo.idstringRequired

id of the pool to zap into.

positionFrom.idstringRequired

id of the position to withdraw from

positionTo.idstringOptional

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

positionTo.tickLowerinteger · int32Optional

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

positionTo.tickUpperinteger · int32Optional

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

liquidityOutstringOptional

liquidity amount to withdraw, or empty or 0 to withdraw all

aggregatorOptions.disablebooleanOptional

whether to disable swapping with the aggregator

aggregatorOptions.includedSourcesstringOptional

comma-separated list of sources to use for aggregator

aggregatorOptions.excludedSourcesstringOptional

comma-separated list of sources to exclude for aggregator

aggregatorOptions.excludedPoolsstringOptional

comma-separated list of pools to exclude for aggregator

feeAddressstringOptional

options for getting aggregator routes the address of the fee recipient.

feePcminteger · int64Optional

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 · int64Optional

Example: 100

Header parameters

X-Client-IdstringOptional

Client Id

Example: zap-docs

X-Request-IdstringOptional

Request Id

Responses

200

application/json

Returns the best route to zap-migrate from an existing position to the specified pool position.

codeinteger · int32Optional

messagestringOptional

requestIdstringOptional

400

Invalid Argument

application/json

404

Not Found

application/json

default

An unexpected error response.

application/json

get

/api/v1/migrate/route

GET /arbitrum/api/v1/migrate/route?dexFrom=DEX_UNISWAPV3&dexTo=DEX_UNISWAPV3&poolFrom.id=text&poolTo.id=text&positionFrom.id=text HTTP/1.1
Host: zap-api.kyberswap.com
Accept: */*

{
  "code": 0,
  "data": {}
}

Zap Out

Get the best zap-out route.

get

Query parameters

dexFromstring · enumRequired

Refer to https://docs.kyberswap.com/kyberswap-solutions/kyberswap-zap-as-a-service/zaps-supported-chains-dexes for list of supported dexes for each chain

Example: DEX_UNISWAPV3Possible values:

poolFrom.idstringRequired

id of the pool to withdraw from.

positionFrom.idstringRequired

id of the position to withdraw from

liquidityOutstringOptional

liquidity amount to withdraw, or empty or 0 to withdraw all

tokenOutstringRequired

aggregatorOptions.disablebooleanOptional

whether to disable swapping with the aggregator

aggregatorOptions.includedSourcesstringOptional

comma-separated list of sources to use for aggregator

aggregatorOptions.excludedSourcesstringOptional

comma-separated list of sources to exclude for aggregator

aggregatorOptions.excludedPoolsstringOptional

comma-separated list of pools to exclude for aggregator

feeAddressstringOptional

fee recipient

feePcminteger · int64Optional

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 · int64Optional

Example: 100

Header parameters

X-Client-IdstringOptional

Client Id

Example: zap-docs

X-Request-IdstringOptional

Request Id

Responses

200

application/json

Returns the best route to zap-out from an existing position to the specified pool position.

codeinteger · int32Optional

messagestringOptional

requestIdstringOptional

400

Invalid Argument

application/json

404

Not Found

application/json

default

An unexpected error response.

application/json

get

/api/v1/out/route

GET /arbitrum/api/v1/out/route?dexFrom=DEX_UNISWAPV3&poolFrom.id=text&positionFrom.id=text&tokenOut=text HTTP/1.1
Host: zap-api.kyberswap.com
Accept: */*

{
  "code": 0,
  "data": {}
}

PreviousAPI Reference NextZaaS GRPC API

Last updated 1 month ago

Was this helpful?