Sign in

v1

latestOpenAPI 3.0.32026-07-2495744.0 KB
quote

Quote

To get the best priced quote, and retrieved quote will be used in POST /v1/{networkId}/swap.

get/v1/{networkId}/quote

Path parameters

networkIdstring required
Example:bsc

EVM chain network identifier (e.g. bsc, eth, base, sonic, tron)

Query parameters

inputTokenstring required

Input token address

outputTokenstring required

Output token address

amountinteger required

The amount to swap, have to factor in the token decimals.

dexes'bluefin_spot' | 'cetus_clmm'

DEX list, separated by comma. If not specified, all DEXs will be used. Different DEXs are available on different chains:

Ethereum (chainId: 1): uniswap_v2, uniswap_v3, uniswap_v4, curve_stable_ng, curve_stable_plain, fluid_lite, fluid_t1, pancakeswap_v2, pancakeswap_v3, balancer_v3, ekubo, rfq_native, lido, lite_psm, mavericks_v2, rfq_swaap, rfq_bebop, pendle, usdd_psm, ring_v2, cyphereth, erc4626

BNB Chain (chainId: 56): pancakeswap_v2, pancakeswap_v3, pancakeswap_v4, pancakeswap_bin_v4, fourmeme, uniswap_v3, uniswap_v4, rfq_native, rfq_swaap, mavericks_v2, flap, pancake_stable, lista_stable, ring_v2, rfq_bebop

Base (chainId: 8453): pancakeswap_v2, pancakeswap_v3, pancakeswap_v4, pancakeswap_bin_v4, uniswap_v2, uniswap_v3, uniswap_v4, sushiswap_v3, aerodrome_cl, aerodrome_vamm, rfq_native, rfq_swaap

Sonic: shadow_v2, shadow_v3, wagmi_v3, solidly_v3

Tron (chainId: 728126428): sunswap_v2, sunswap_v3

Plasma: dyorswap_v2, uniswap_v3

Monad: uniswap_v2, uniswap_v3, uniswap_v4, curve_stable_plain, curve_stable_ng, pancakeswap_v2, pancakeswap_v3, pancakeswap_v4, pancakeswap_bin_v4

excludeDexes'bluefin_spot' | 'cetus_clmm'

DEX list to be excluded, separated by comma. If not specified, all DEXs will be used. Different DEXs are available on different chains:

Ethereum (chainId: 1): uniswap_v2, uniswap_v3, uniswap_v4, curve_stable_ng, curve_stable_plain, fluid_lite, fluid_t1, pancakeswap_v2, pancakeswap_v3, balancer_v3, ekubo, rfq_native, lido, lite_psm, mavericks_v2, rfq_swaap, rfq_bebop, pendle, usdd_psm, ring_v2, cyphereth, erc4626

BNB Chain (chainId: 56): pancakeswap_v2, pancakeswap_v3, pancakeswap_v4, pancakeswap_bin_v4, fourmeme, uniswap_v3, uniswap_v4, rfq_native, rfq_swaap, mavericks_v2, flap, pancake_stable, lista_stable, ring_v2, rfq_bebop

Base (chainId: 8453): pancakeswap_v2, pancakeswap_v3, pancakeswap_v4, pancakeswap_bin_v4, uniswap_v2, uniswap_v3, uniswap_v4, sushiswap_v3, aerodrome_cl, aerodrome_vamm, rfq_native, rfq_swaap

Sonic: shadow_v2, shadow_v3, wagmi_v3, solidly_v3

Tron (chainId: 728126428): sunswap_v2, sunswap_v3

Plasma: dyorswap_v2, uniswap_v3

Monad: uniswap_v2, uniswap_v3, uniswap_v4, curve_stable_plain, curve_stable_ng, pancakeswap_v2, pancakeswap_v3, pancakeswap_v4, pancakeswap_bin_v4

commissionDirectionboolean
Example:true

Commission direction. true means charge from inputToken, false means charge from outputToken

commissionRateinteger
Example:5

Commission rate, in basis points (bps), e.g. 15 means 0.15%. When charging inputToken, deduct from amountIn before quote; when charging outputToken, quote first then deduct from amountOut

userAddressstring
Example:0x7C1E2BBA36790f003063fE4117223FD483Ce6BCC

user address

Response

Successful response, to be used in /v1/{networkId}/swap

OR

Example response

{
  "msg": "success",
  "data": {
    "inputToken": "0x2::sui::SUI",
    "outputToken": "0xe1b45a0e641b9955a20aa0ad1c1f4ad86aad8afb07296d4085e349a50e90bdca::blue::BLUE",
    "routePlans": [
      {
        "router": "0xe1b45a0e641b9955a20aa0ad1c1f4ad86aad8afb07296d4085e349a50e90bdca::blue::BLUE - 0x2::sui::SUI",
        "subRouters": [
          {
            "fromToken": "0x2::sui::SUI",
            "toToken": "0xe1b45a0e641b9955a20aa0ad1c1f4ad86aad8afb07296d4085e349a50e90bdca::blue::BLUE",
            "dexes": [
              {
                "dex": "bluefin_spot",
                "poolAddress": "0x198c607644a07d500b5b2bd076e54eecd022f471b714f89a336e38749559a496",
                "weight": 10000,
                "extraInfo": "{}"
              }
            ]
          }
        ]
      }
    ]
  }
}
All 9 operations