GET /trade/v1/{chainId}/quote/cross

Find all available quotes for cross-chain trade via Unizen DEX Aggregator

Get the best quote for a cross chain trade.

GET/trade/v1/{chainId}/quote/cross

Authorization

X-Api-Key

Path parameters

chainId*enum

The chain ID of the chain to quote on.

Example: 137

1137564311425010421618453-3980891822-174457306-33463083-3143381382

Query parameters

Response

200

The response is an array of objects, with each object representing one provider. Currently, we support two interoperable providers for cross-chain transactions: Stargate, Celer

Body

application/json

srcTradeList*array of string

If there is no trade required on source chain, srcTradeList is an empty array

dstTradeList*array of string

If there is no trade required on destination chain, dstTradeList is an empty array

srcTrade*all of

Source trade details

dstTrade*all of

Destination trade details

transactionData*object

An object containing information on the parameters of the transaction.

nativeValue*string

The total value of the transaction in native currency

Example: "29422186306758765852"

nativeFee*string

A string representation of the native fee associated with the transaction

Example: "1070050644652846329"

processingTime*number

The time it took for the transaction to be processed

Example: 1000

tradeProtocol*string

The protocol used to execute the transaction (CROSS_CHAIN_STARGATE | CROSS_CHAIN_CELER)

Example: "CROSS_CHAIN_CELER"

crossChainTradeQuotesType*string

Type of cross-chain trade quotes

Example: "TRADE_ON_BOTH"

sourceChainId*number

A CHAINS enum value representing the source chain

Example: 137

destinationChainId*number

A CHAINS enum value representing the destination chain

Example: 43114

contractVersion*string

Version of the contract, V1 or V2

Example: "V1"

providerInfo*object

The interoperability provider information

estimateGas*object

the estimated amount of gas needed for the transaction, if disableEstimate is set to false

Example: "11231133211313"

estimateGasError*object

the estimate gas error, returned from RPC, if disableEstimate is set to false

Example: "Execution reverted"

gasPrice*string

Gas Price

Example: "56442235035"

Request

JavaScriptCurlPython

const response = await fetch('/trade/v1/{chainId}/quote/cross?fromTokenAddress=text&toTokenAddress=text&amount=text&destinationChainId=1&sender=text', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer Bearer"
    },
});
const data = await response.json();

Response

200

[
  {
    "srcTradeList": [
      {}
    ],
    "dstTradeList": [
      {}
    ],
    "srcTrade": {
      "fromTokenAmount": "26031659637168024367",
      "toTokenAmount": "26031659637168024367",
      "deltaAmount": "26083722956442360416",
      "tokenFrom": {
        "name": "ZCX",
        "symbol": "ZCX",
        "decimals": 18,
        "contractAddress": "0xc52c326331e9ce41f04484d3b5e5648158028804",
        "priceInUsd": 0.1,
        "chainId": 1,
        "buyTax": 0,
        "sellTax": 0
      },
      "tokenTo": {
        "name": "ZCX",
        "symbol": "ZCX",
        "decimals": 18,
        "contractAddress": "0xc52c326331e9ce41f04484d3b5e5648158028804",
        "priceInUsd": 0.1,
        "chainId": 1,
        "buyTax": 0,
        "sellTax": 0
      },
      "protocol": [
        {}
      ],
      "transactionData": {
        "info": {
          "amountIn": "26031659637168024367",
          "amountOutMin": "26031659637168024367",
          "amountInMax": "26083722956442360416",
          "amountOut": "26083722956442360416",
          "actualQuote": "26083722956442360416",
          "srcToken": "text",
          "dstToken": "text",
          "uuid": "text",
          "apiId": "text",
          "userPSFee": 0,
          "deadline": 1684251,
          "tradeType": 0,
          "slippage": 0.1,
          "feePercent": 0,
          "sharePercent": 0,
          "tokenHasTaxes": false,
          "path": false,
          "v3Path": false
        },
        "amountInfo": {
          "amount": "26031659637168024367",
          "actualQuote": "26031659637168024367"
        },
        "call": [
          "text"
        ]
      }
    },
    "dstTrade": {
      "fromTokenAmount": "26031659637168024367",
      "toTokenAmount": "26031659637168024367",
      "deltaAmount": "26083722956442360416",
      "tokenFrom": {
        "name": "ZCX",
        "symbol": "ZCX",
        "decimals": 18,
        "contractAddress": "0xc52c326331e9ce41f04484d3b5e5648158028804",
        "priceInUsd": 0.1,
        "chainId": 1,
        "buyTax": 0,
        "sellTax": 0
      },
      "tokenTo": {
        "name": "ZCX",
        "symbol": "ZCX",
        "decimals": 18,
        "contractAddress": "0xc52c326331e9ce41f04484d3b5e5648158028804",
        "priceInUsd": 0.1,
        "chainId": 1,
        "buyTax": 0,
        "sellTax": 0
      },
      "protocol": [
        {}
      ],
      "transactionData": {
        "info": {
          "amountIn": "26031659637168024367",
          "amountOutMin": "26031659637168024367",
          "amountInMax": "26083722956442360416",
          "amountOut": "26083722956442360416",
          "actualQuote": "26083722956442360416",
          "srcToken": "text",
          "dstToken": "text",
          "uuid": "text",
          "apiId": "text",
          "userPSFee": 0,
          "deadline": 1684251,
          "tradeType": 0,
          "slippage": 0.1,
          "feePercent": 0,
          "sharePercent": 0,
          "tokenHasTaxes": false,
          "path": false,
          "v3Path": false
        },
        "amountInfo": {
          "amount": "26031659637168024367",
          "actualQuote": "26031659637168024367"
        },
        "call": [
          "text"
        ]
      }
    },
    "nativeValue": "29422186306758765852",
    "nativeFee": "1070050644652846329",
    "processingTime": 1000,
    "tradeProtocol": "CROSS_CHAIN_CELER",
    "crossChainTradeQuotesType": "TRADE_ON_BOTH",
    "sourceChainId": 137,
    "destinationChainId": 43114,
    "contractVersion": "V1",
    "providerInfo": {
      "name": "Celer",
      "contractVersion": "v2",
      "logo": "https://api.zcx.com/data/logo/interoperability-provider/cbridge.svg"
    },
    "estimateGas": "11231133211313",
    "estimateGasError": "Execution reverted",
    "gasPrice": "56442235035"
  }
]