EVM Swaps

KyberSwap Aggregator EVM APIs

Download OpenAPI specification:

41KB

Kyber-Swap-Aggregator-APIs.yaml

Note on integrations: clientID

In order to continuously improve the KyberSwap Aggregator, our APIs implement a clientData or source field that enables us to understand how the APIs are being utilized. As a developer integrating with our APIs, please add your clientID (i.e. company name) to the clientData/source fields to enable us to serve you better.

Example

• [V1]GET

  • clientData={"source":"yourCompanyNameHere"}

• [V2]POST

  • source="yourCompanyNameHere"

EVM swap APIs

[V1] Get Swap Info with Encoded Data

Retrieve the information about a Swap between 2 tokens with encoded data to submit to KyberSwap router contract

GEThttps://aggregator-api.kyberswap.com/{chain}/route/encode

Path parameters

chain*string

Supported chains:

• arbitrum
• aurora
• avalanche
• bsc
• bttc
• cronos
• ethereum
• fantom
• oasis
• polygon
• velas
• optimism

Query parameters

Header parameters

Response

200

Swap Found

Body

application/json

inputAmountstring

The input amount of tokenIn, in wei

outputAmountstring

The input amount of tokenOut, in wei

totalGasinteger

Estimated gas fee

gasPriceGweistring

Current gas price in Gwei

gasUsdnumber

Current gas price in USD

amountInUsdnumber

Estimate of input value, in USD

amountOutUsdnumber

Estimate of out value, in USD

receivedUsdnumber

Estimate of final received value, in USD

swapsarray of array of SwapSequence (object)

Swap path, a 2-dimen array describe how swap is executed

encodedSwapDatastring

The encoded data to be sent to our router address

routerAddressstring

The KyberSwap router address

Request

JavaScriptCurl

const response = await fetch('https://aggregator-api.kyberswap.com/{chain}/route/encode', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "inputAmount": "text",
  "outputAmount": "text",
  "gasPriceGwei": "text",
  "gasUsd": 0,
  "amountInUsd": 0,
  "amountOutUsd": 0,
  "receivedUsd": 0,
  "swaps": [
    [
      {
        "pool": "text",
        "tokenIn": "text",
        "tokenOut": "text",
        "swapAmount": "text",
        "amountOut": "text",
        "limitReturnAmount": "text",
        "maxPrice": "text",
        "exchange": "text",
        "poolType": "text"
      }
    ]
  ],
  "encodedSwapData": "text",
  "routerAddress": "text"
}

[V2] Get Swap Route

Retrieve the route information about a Swap between 2 tokens. Please use V2 GET API for a more performant route query. The route returned can then be combined with transaction specific params in the POST API payload to get the encoded data for submission to the KyberSwap router contract.

GEThttps://aggregator-api.kyberswap.com/{chain}/api/v1/routes

Path parameters

chain*string

Supported chains:

• arbitrum
• aurora
• avalanche
• bsc
• bttc
• cronos
• ethereum
• fantom
• oasis
• polygon
• velas
• optimism

Query parameters

Response

200

Swap Found

Body

application/json

codestring

Response code

messagestring

Response message

dataobject

Response data

Request

JavaScriptCurl

const response = await fetch('https://aggregator-api.kyberswap.com/{chain}/api/v1/routes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "code": "text",
  "message": "text",
  "data": {
    "routeSummary": {
      "tokenIn": "text",
      "amountIn": "text",
      "amountInUsd": "text",
      "tokenOut": "text",
      "amountOut": "text",
      "amountOutUsd": "text",
      "gas": "text",
      "gasPrice": "text",
      "gasUsd": "text",
      "extraFee": {
        "feeAmount": "text",
        "chargeFeeBy": "currency_in",
        "isInBps": "text",
        "feeReceiver": "text"
      },
      "route": [
        [
          {
            "pool": "text",
            "tokenIn": "text",
            "tokenOut": "text",
            "limitReturnAmount": "text",
            "swapAmount": "text",
            "amountOut": "text",
            "exchange": "text",
            "poolType": "text",
            "extra": "text"
          }
        ]
      ]
    },
    "routerAddress": "text"
  }
}

[V2] Post Swap Route For Encoded Data

Get the encoded swap route to be forwarded to the KyberSwap router contract. For simplicity, the request body should contain the routeSummary returned by [V2] Get Swap Route appended with the additional tx parameters.

POSThttps://aggregator-api.kyberswap.com/{chain}/api/v1/route/build

Path parameters

chain*string

Supported chains:

• arbitrum
• aurora
• avalanche
• bsc
• bttc
• cronos
• ethereum
• fantom
• oasis
• polygon
• velas
• optimism

Body

application/json

routeSummary*object

The summarised routing data

deadlineinteger

Deadline (in Unix time second) for the transaction to be executed. Default will be +20 minute. Cannot be in the past.

slippageToleranceinteger

This is the amount of slippage the user can accept for his trade. The unit is bip. The value is in ranges [0, 2000], 10 means 0.1%. Default value is 50/10000 ~ 0.5%.

sender*string

Address which the swap input tokens will be debited from

recipient*string

Address which the swap output tokens will be sent to

sourcestring

String to present to your client (i.e. clientID)

skipSimulateTxboolean

Returns the encoded data without price impact checks. For advanced trades.

Response

200

Successfully encoded

Body

application/json

codestring

Response code

messagestring

Response message

dataobject

Response data for encoded swap

Request

JavaScriptCurl

const response = await fetch('https://aggregator-api.kyberswap.com/{chain}/api/v1/route/build', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "routeSummary": {
        "tokenIn": "text",
        "amountIn": "text",
        "amountInUsd": "text",
        "tokenOut": "text",
        "amountOut": "text",
        "amountOutUsd": "text",
        "gas": "text",
        "gasPrice": "text",
        "gasUsd": "text",
        "route": [
          [
            {
              "pool": "text",
              "tokenIn": "text",
              "tokenOut": "text",
              "limitReturnAmount": "text",
              "swapAmount": "text",
              "amountOut": "text",
              "exchange": "text",
              "poolType": "text",
              "extra": "text"
            }
          ]
        ]
      },
      "sender": "text",
      "recipient": "text"
    }),
});
const data = await response.json();

Response

{
  "code": "text",
  "message": "text",
  "data": {
    "amountIn": "text",
    "amountInUsd": "text",
    "amountOut": "text",
    "amountOutUsd": "text",
    "gas": "text",
    "gasUsd": "text",
    "outputChange": {
      "amount": "text",
      "percent": 0,
      "level": 0
    },
    "data": "text",
    "routerAddress": "text"
  }
}