QuoteController_getT2BQuote

GET 
/v2/quote/t2b

QuoteController_getT2BQuote

Request

Query Parameters

fromChainId stringrequired
Chain id of source chain.
Example: 137
fromTokenAddress stringrequired
Token address on source chain.
Example: 0x2791bca1f2de4661ed88a30c99a7a9449aa84174
toChainId stringrequired
Chain id of destination chain.
Example: 56
toTokenAddress stringrequired
Token address on destination chain.
Example: 0x1af3f329e8be154074d8769d1ffa4ee058b1dbc3
fromAmount stringrequired
Amount of sending tokens.
Example: 100000000
userAddress stringrequired
Address of user. This will be used to check approvals.
Example: 0x3e8cB4bd04d81498aB4b94a392c334F5328b237b
recipient string
Address of recipient. This will be used to check approvals.
Example: 0x3e8cB4bd04d81498aB4b94a392c334F5328b237b
uniqueRoutesPerBridge booleanrequired
Flag to return only best route per bridge using the sort criteria
Example: true
disableSwapping boolean

Flag to specify if routes that have dex swap should be ignored.

includeDexes string[]

Possible values: [oneinch, zerox, rainbow]

Specify Dexes that should be included in routes.

excludeDexes string[]

Possible values: [oneinch, zerox, rainbow]

Specify Dexes that should be excluded in routes. This option will be ignored if includeDexes is specified.

includeBridges string[]

Possible values: [hop, hopCctp, anyswap, anyswap-router-v4, anyswap-router-v6, polygon-bridge, arbitrum-bridge, hyphen, across, optimism-bridge, celer, refuel-bridge, stargate, connext, cctp, synapse, base-bridge, zora-bridge, zksync-native, symbiosis, gnosis-native-bridge, mantle-native-bridge, scroll-native-bridge, mode-native-bridge, super-bridge, stargate-v2]

Specify Bridges that should be included in routes.

excludeBridges string[]

Possible values: [hop, hopCctp, anyswap, anyswap-router-v4, anyswap-router-v6, polygon-bridge, arbitrum-bridge, hyphen, across, optimism-bridge, celer, refuel-bridge, stargate, connext, cctp, synapse, base-bridge, zora-bridge, zksync-native, symbiosis, gnosis-native-bridge, mantle-native-bridge, scroll-native-bridge, mode-native-bridge, super-bridge, stargate-v2]

Specify Bridges that should be excluded in routes. This option will be ignored if includeBridges is specified.

sort stringrequired

Possible values: [output, gas, time]

Param to sort routes based on.

maxUserTxs string

Maximum number of transactions. This option will be ignored if singleTxOnly is marked as true.

singleTxOnly boolean

Only get quotes with one user transaction to bridge.

isContractCall boolean

Only get quotes with that are compatible with contracts

bridgeWithGas boolean

include gas transfer with bridging tx

bridgeWithInsurance boolean

include insurance with bridging tx

defaultBridgeSlippage string

default bridge slippage for the route in percent between 0 and 100. Default Slippage assumed if not passed. NOTE - Slippage is not present for all bridges.

defaultSwapSlippage string

default swap slippage for the route in percent between 0 and 100. Default Slippage assumed if not passed.

destinationPayload string

destination payload for contract call

destinationGasLimit string

destination gas limit for contract call

feePercent string

feePercentage to be cut, this is only available on SocketGateway Contracts.

feeTakerAddress string

feeTakerAddress is the address where the fee is sent, this is only available on Socket Gateway Contracts.

Header Parameters

API-KEY string

Responses

200

Returns all the possible routes for bridging tokens from one chain to another. One of the routes can be selected and passed in to start the route.

application/json

Schema

Schema

successbooleanrequired
Status of API.
Example: true

result

object

required

routes

object[]

Array [

routeIdstringrequired

Unique id for each route.

Example: 6a4c26b6-b008-431d-a37c-028e0b30482b

isOnlySwapRoutebooleanrequired

Contains only on single swap.

Example: false

fromAmountstringrequired

Sending token amount.

Example: 100000000000000000000

chainGasBalances

object

required

minimumGasBalances

object

required

toAmountstringrequired

Approximate receiving token amount.

Example: 100000000000000000000

usedBridgeNamesstring[]required

Array of bridges used in the route

Possible values: [hop, hopCctp, anyswap, anyswap-router-v4, anyswap-router-v6, polygon-bridge, arbitrum-bridge, hyphen, across, optimism-bridge, celer, refuel-bridge, stargate, connext, cctp, synapse, base-bridge, zora-bridge, zksync-native, symbiosis, gnosis-native-bridge, mantle-native-bridge, scroll-native-bridge, mode-native-bridge, super-bridge, stargate-v2]

Example: [anyswap-router-v4]

totalUserTxnumberrequired

Total number of transactions for the route.

Example: 3

totalGasFeesInUsdnumberrequired

Combined USD gas fees for all transactions in the route.

Example: 125.4

recipientstringrequired

Address of user receiving the amount.

Example: 0x3e8cB4bd04d81498aB4b94a392c334F5328b237b

senderstringrequired

Address of user making the transactions.

Example: 0x3e8cB4bd04d81498aB4b94a392c334F5328b237b

userTxsobject[]required

Array of user transactions.

receivedValueInUsdnumber

Receive Value

inputValueInUsdnumber

outputValueInUsdnumber

serviceTimenumberrequired

Estimate of total time in seconds, excluding the transaction time.

Example: 600

maxServiceTimenumberrequired

Estimate of max time to exit from the chain in seconds.

Example: 600

integratorFee

object

required

feeTakerAddressstring

amountstring

asset

object

namestring

Name of token.

Example: USD Coin

addressstring

Address of token.

Example: 0x2791bca1f2de4661ed88a30c99a7a9449aa84174

iconstring

URL for icon of token.

Example: https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg

decimalsnumber

Decimal used for token.

Example: 6

symbolstring

Symbol of token.

Example: USDC

chainIdstring

Chain id of the token

Possible values: [MAINNET_CHAIN_ID, OPTIMISM_CHAIN_ID, BSC_CHAIN_ID, XDAI_CHAIN_ID, POLYGON_CHAIN_ID, FANTOM_CHAIN_ID, ZKSYNC_ERA_CHAIN_ID, POLYGON_ZKEVM_CHAIN_ID, MANTLE_CHAIN_ID, BASE_CHAIN_ID, MODE_CHAIN_ID, ARBITRUM_CHAIN_ID, AVAX_CHAIN_ID, LINEA_CHAIN_ID, BLAST_CHAIN_ID, SCROLL_CHAIN_ID, ZORA_CHAIN_ID, AURORA_CHAIN_ID]

Example: 137

logoURIstring

URL for icon of token.

Example: https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg

chainAgnosticIdstring

Unique Id over all chains

Example: DAI

t2bReceiverAddressstring

extraDataobject

]

fromChainIdnumber

fromAsset

object

namestring

Name of token.

Example: USD Coin

addressstringrequired

Address of token.

Example: 0x2791bca1f2de4661ed88a30c99a7a9449aa84174

iconstring

URL for icon of token.

Example: https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg

decimalsnumber

Decimal used for token.

Example: 6

symbolstringrequired

Symbol of token.

Example: USDC

chainIdstringrequired

Chain id of the token

Possible values: [MAINNET_CHAIN_ID, OPTIMISM_CHAIN_ID, BSC_CHAIN_ID, XDAI_CHAIN_ID, POLYGON_CHAIN_ID, FANTOM_CHAIN_ID, ZKSYNC_ERA_CHAIN_ID, POLYGON_ZKEVM_CHAIN_ID, MANTLE_CHAIN_ID, BASE_CHAIN_ID, MODE_CHAIN_ID, ARBITRUM_CHAIN_ID, AVAX_CHAIN_ID, LINEA_CHAIN_ID, BLAST_CHAIN_ID, SCROLL_CHAIN_ID, ZORA_CHAIN_ID, AURORA_CHAIN_ID]

Example: 137

logoURIstring

URL for icon of token.

Example: https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg

chainAgnosticIdstring

Unique Id over all chains

Example: DAI

toChainIdnumber

toAsset

object

namestring

Name of token.

Example: USD Coin

addressstringrequired

Address of token.

Example: 0x2791bca1f2de4661ed88a30c99a7a9449aa84174

iconstring

URL for icon of token.

Example: https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg

decimalsnumber

Decimal used for token.

Example: 6

symbolstringrequired

Symbol of token.

Example: USDC

chainIdstringrequired

Chain id of the token

Possible values: [MAINNET_CHAIN_ID, OPTIMISM_CHAIN_ID, BSC_CHAIN_ID, XDAI_CHAIN_ID, POLYGON_CHAIN_ID, FANTOM_CHAIN_ID, ZKSYNC_ERA_CHAIN_ID, POLYGON_ZKEVM_CHAIN_ID, MANTLE_CHAIN_ID, BASE_CHAIN_ID, MODE_CHAIN_ID, ARBITRUM_CHAIN_ID, AVAX_CHAIN_ID, LINEA_CHAIN_ID, BLAST_CHAIN_ID, SCROLL_CHAIN_ID, ZORA_CHAIN_ID, AURORA_CHAIN_ID]

Example: 137

logoURIstring

URL for icon of token.

Example: https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg

chainAgnosticIdstring

Unique Id over all chains

Example: DAI

refuel

object

nullable

fromAmountstringrequired

toAmountstringrequired

gasFees

object

required

gasLimitnumberrequired

Approx Gas Limit of the transaction.

Example: 250000

feesInUsdnumberrequired

USD value of gas fees at current gas price.

Example: 125.4

asset

object

required

Gas token details.

namestring

Name of token.

Example: USD Coin

addressstringrequired

Address of token.

Example: 0x2791bca1f2de4661ed88a30c99a7a9449aa84174

iconstring

URL for icon of token.

Example: https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg

decimalsnumber

Decimal used for token.

Example: 6

symbolstringrequired

Symbol of token.

Example: USDC

chainIdstringrequired

Chain id of the token

Possible values: [MAINNET_CHAIN_ID, OPTIMISM_CHAIN_ID, BSC_CHAIN_ID, XDAI_CHAIN_ID, POLYGON_CHAIN_ID, FANTOM_CHAIN_ID, ZKSYNC_ERA_CHAIN_ID, POLYGON_ZKEVM_CHAIN_ID, MANTLE_CHAIN_ID, BASE_CHAIN_ID, MODE_CHAIN_ID, ARBITRUM_CHAIN_ID, AVAX_CHAIN_ID, LINEA_CHAIN_ID, BLAST_CHAIN_ID, SCROLL_CHAIN_ID, ZORA_CHAIN_ID, AURORA_CHAIN_ID]

Example: 137

logoURIstring

URL for icon of token.

Example: https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg

chainAgnosticIdstring

Unique Id over all chains

Example: DAI

gasAmountstringrequired

Estimated Amount of gas token will be used

recipientstringrequired

serviceTimenumberrequired

fromAsset

object

required

namestring

Name of token.

Example: USD Coin

addressstringrequired

Address of token.

Example: 0x2791bca1f2de4661ed88a30c99a7a9449aa84174

iconstring

URL for icon of token.

Example: https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg

decimalsnumber

Decimal used for token.

Example: 6

symbolstringrequired

Symbol of token.

Example: USDC

chainIdstringrequired

Chain id of the token

Possible values: [MAINNET_CHAIN_ID, OPTIMISM_CHAIN_ID, BSC_CHAIN_ID, XDAI_CHAIN_ID, POLYGON_CHAIN_ID, FANTOM_CHAIN_ID, ZKSYNC_ERA_CHAIN_ID, POLYGON_ZKEVM_CHAIN_ID, MANTLE_CHAIN_ID, BASE_CHAIN_ID, MODE_CHAIN_ID, ARBITRUM_CHAIN_ID, AVAX_CHAIN_ID, LINEA_CHAIN_ID, BLAST_CHAIN_ID, SCROLL_CHAIN_ID, ZORA_CHAIN_ID, AURORA_CHAIN_ID]

Example: 137

logoURIstring

URL for icon of token.

Example: https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg

chainAgnosticIdstring

Unique Id over all chains

Example: DAI

toAsset

object

required

namestring

Name of token.

Example: USD Coin

addressstringrequired

Address of token.

Example: 0x2791bca1f2de4661ed88a30c99a7a9449aa84174

iconstring

URL for icon of token.

Example: https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg

decimalsnumber

Decimal used for token.

Example: 6

symbolstringrequired

Symbol of token.

Example: USDC

chainIdstringrequired

Chain id of the token

Possible values: [MAINNET_CHAIN_ID, OPTIMISM_CHAIN_ID, BSC_CHAIN_ID, XDAI_CHAIN_ID, POLYGON_CHAIN_ID, FANTOM_CHAIN_ID, ZKSYNC_ERA_CHAIN_ID, POLYGON_ZKEVM_CHAIN_ID, MANTLE_CHAIN_ID, BASE_CHAIN_ID, MODE_CHAIN_ID, ARBITRUM_CHAIN_ID, AVAX_CHAIN_ID, LINEA_CHAIN_ID, BLAST_CHAIN_ID, SCROLL_CHAIN_ID, ZORA_CHAIN_ID, AURORA_CHAIN_ID]

Example: 137

logoURIstring

URL for icon of token.

Example: https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg

chainAgnosticIdstring

Unique Id over all chains

Example: DAI

fromChainIdnumberrequired

toChainIdnumberrequired

Example (from schema)

{
  "success": true,
  "result": {
    "routes": [
      {
        "routeId": "6a4c26b6-b008-431d-a37c-028e0b30482b",
        "isOnlySwapRoute": false,
        "fromAmount": "100000000000000000000",
        "chainGasBalances": {},
        "minimumGasBalances": {},
        "toAmount": "100000000000000000000",
        "usedBridgeNames": "[anyswap-router-v4]",
        "totalUserTx": 3,
        "totalGasFeesInUsd": 125.4,
        "recipient": "0x3e8cB4bd04d81498aB4b94a392c334F5328b237b",
        "sender": "0x3e8cB4bd04d81498aB4b94a392c334F5328b237b",
        "userTxs": [
          {}
        ],
        "receivedValueInUsd": 0,
        "inputValueInUsd": 0,
        "outputValueInUsd": 0,
        "serviceTime": 600,
        "maxServiceTime": 600,
        "integratorFee": {
          "feeTakerAddress": "string",
          "amount": "string",
          "asset": {
            "name": "USD Coin",
            "address": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
            "icon": "https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg",
            "decimals": 6,
            "symbol": "USDC",
            "chainId": 137,
            "logoURI": "https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg",
            "chainAgnosticId": "DAI"
          }
        },
        "t2bReceiverAddress": "string",
        "extraData": {}
      }
    ],
    "fromChainId": 0,
    "fromAsset": {
      "name": "USD Coin",
      "address": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
      "icon": "https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg",
      "decimals": 6,
      "symbol": "USDC",
      "chainId": 137,
      "logoURI": "https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg",
      "chainAgnosticId": "DAI"
    },
    "toChainId": 0,
    "toAsset": {
      "name": "USD Coin",
      "address": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
      "icon": "https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg",
      "decimals": 6,
      "symbol": "USDC",
      "chainId": 137,
      "logoURI": "https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg",
      "chainAgnosticId": "DAI"
    },
    "refuel": {
      "fromAmount": "string",
      "toAmount": "string",
      "gasFees": {
        "gasLimit": 250000,
        "feesInUsd": 125.4,
        "asset": {
          "name": "USD Coin",
          "address": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
          "icon": "https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg",
          "decimals": 6,
          "symbol": "USDC",
          "chainId": 137,
          "logoURI": "https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg",
          "chainAgnosticId": "DAI"
        },
        "gasAmount": "string"
      },
      "recipient": "string",
      "serviceTime": 0,
      "fromAsset": {
        "name": "USD Coin",
        "address": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
        "icon": "https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg",
        "decimals": 6,
        "symbol": "USDC",
        "chainId": 137,
        "logoURI": "https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg",
        "chainAgnosticId": "DAI"
      },
      "toAsset": {
        "name": "USD Coin",
        "address": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
        "icon": "https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg",
        "decimals": 6,
        "symbol": "USDC",
        "chainId": 137,
        "logoURI": "https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg",
        "chainAgnosticId": "DAI"
      },
      "fromChainId": 0,
      "toChainId": 0
    }
  }
}