Sign in

v1

latestOpenAPI 3.0.02026-07-17243469.7 KB
Routes

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
post/v2/route/start

Headers

API-KEYstring

Request body

fromChainId'ETHEREUM' | 'OPTIMISM' | 'BSC' | 'XDAI' | 'POLYGON' | 'FANTOM' | 'ARBITRUM' | 'AVALANCHE' required

Chain id of source chain.

toChainId'ETHEREUM' | 'OPTIMISM' | 'BSC' | 'XDAI' | 'POLYGON' | 'FANTOM' | 'ARBITRUM' | 'AVALANCHE' required

Chain id of destination chain.

fromAssetAddressstring required

Token address on source chain.

toAssetAddressstring required

Token address on destination chain.

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 request

{
  "fromAssetAddress": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
  "toAssetAddress": "0x1AF3F329e8BE154074D8769D1FFa4eE058B1DBc3",
  "includeFirstTxDetails": true,
  "route": {
    "routeId": "6a4c26b6-b008-431d-a37c-028e0b30482b",
    "fromAmount": "100000000000000000000",
    "toAmount": "100000000000000000000",
    "totalUserTx": 3,
    "totalGasFeesInUsd": 125.4,
    "sender": "0x3e8cB4bd04d81498aB4b94a392c334F5328b237b",
    "serviceTime": 600
  }
}

Response

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

userTxType'approve' | 'fund-movr' | 'claim' | 'dex-swap' | 'sign'
txTargetstring
chainId'ETHEREUM' | 'OPTIMISM' | 'BSC' | 'XDAI' | 'POLYGON' | 'FANTOM' | 'ARBITRUM' | 'AVALANCHE'
activeRouteIdnumber required
txDatastring
txType'eth_sendTransaction' | 'eth_signMessage'
valuestring
userTxIndexnumber
totalUserTxnumber required

Example response

{
  "approvalData": {
    "minimumApprovalAmount": "10000000000000000",
    "approvalTokenAddress": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
    "allowanceTarget": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
    "owner": "0x3e8cB4bd04d81498aB4b94a392c334F5328b237b"
  }
}