POST 
/v2/route/start

Function that takes in a route and starts the selected route. Function is responsible for

• Saving the selected route to bridge tokens from one chain to another.
• Saving the fromChain, toChain, and fromAsssetAddress and toAssetAddress
• Returns the Active Route Id, Current Tx, Total number of txs, txType

Request

Header Parameters

API-KEY string

application/json

Body

required

fromChainIdstringrequired
Chain id of source chain.
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
toChainIdstringrequired
Chain id of destination chain.
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: 56
fromAssetAddressstringrequired
Token address on source chain.
Example: 0x2791bca1f2de4661ed88a30c99a7a9449aa84174
toAssetAddressstringrequired
Token address on destination chain.
Example: 0x1af3f329e8be154074d8769d1ffa4ee058b1dbc3
includeFirstTxDetailsboolean
Include the tx details for the first user transaction. If true it will return the txData txType etc. If false, it will only return the active route Id of the selected route.
Example: true
routeobjectrequired
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
chainGasBalancesobjectrequired
minimumGasBalancesobjectrequired
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
refuelobjectrequired
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

destinationCallData

object

destinationPayloadstringrequired

destinationGasLimitstringrequired

bridgeInsuranceData

object

amountstringrequired

Amount of token to be used in insurance.

Responses

200

Starts the Active Route and gives back the data to start the route

application/json

Schema

Schema

userTxTypestring

Possible values: [approve, fund-movr, claim, dex-swap, sign]

txTargetstring
chainIdstring

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]

activeRouteIdnumberrequired
txDatastring
txTypestring

Possible values: [eth_sendTransaction, eth_signMessage]

valuestring
userTxIndexnumber
totalUserTxnumberrequired

approvalData

object

minimumApprovalAmountstringrequired

Minimum amount of approval needed.

Example: 10000000000000000

approvalTokenAddressstringrequired

Address of token for which approval is required.

Example: 0x2791bca1f2de4661ed88a30c99a7a9449aa84174

allowanceTargetstringrequired

Contract address that needs approval.

Example: 0x2791bca1f2de4661ed88a30c99a7a9449aa84174

ownerstringrequired

Address of owner.

Example: 0x3e8cB4bd04d81498aB4b94a392c334F5328b237b

Example (from schema)

{
  "userTxType": "approve",
  "txTarget": "string",
  "chainId": "MAINNET_CHAIN_ID",
  "activeRouteId": 0,
  "txData": "string",
  "txType": "eth_sendTransaction",
  "value": "string",
  "userTxIndex": 0,
  "totalUserTx": 0,
  "approvalData": {
    "minimumApprovalAmount": "10000000000000000",
    "approvalTokenAddress": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
    "allowanceTarget": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
    "owner": "0x3e8cB4bd04d81498aB4b94a392c334F5328b237b"
  }
}

201