ActiveRoutesController_getActiveRoutesForUser

GET 
/v2/route/active-routes/users

ActiveRoutesController_getActiveRoutesForUser

Request

Query Parameters

userAddress stringrequired
Address of user starting the route.
Example: 0x3e8cB4bd04d81498aB4b94a392c334F5328b237b
sort string

Possible values: [updatedAt, createdAt]

Sort param for routes.

offset string

Offset for fetching active routes.

limit string

Number of active routes to return in one API call.

routeStatus string

Possible values: [READY, PENDING, COMPLETED, FAILED]

Status of the route. The route will only be marked completed if all the user txs have been completed.

fromChainId string
Id of sending chain
Example: 137
toChainId string
Id of destination chain.
Example: 56
fromTokenAddress string
Address of token on source chain.
Example: 0x2791bca1f2de4661ed88a30c99a7a9449aa84174
toTokenAddress string
Token address on destination chain.
Example: 0x1af3f329e8be154074d8769d1ffa4ee058b1dbc3

Header Parameters

API-KEY string

Responses

200

Get all the active routes from a user address. Filters like fromChainId, toChainId and token addresses can be used to get back specific active routes.

application/json

Schema

Schema

successbooleanrequired
Status of API response.
Example: true

result

object

required

activeRouteIdnumberrequired

Id of the Active Route.

Example: 420

userAddressstringrequired

Address of user doing the Active Route.

Example: 0x3e8cB4bd04d81498aB4b94a392c334F5328b237b

totalUserTxnumberrequired

Total number of txs required in Active Route.

Example: 3

userTxsobject[]required

Array of user txs.

fromChainIdnumberrequired

Id of source chain.

Example: 137

toChainIdnumberrequired

Id of destination chain.

Example: 56

fromAssetAddressstringrequired

Address of token on source chain.

Example: 0x2791bca1f2de4661ed88a30c99a7a9449aa84174

toAssetAddressstringrequired

Address of token on destination chain.

Example: 0x1af3f329e8be154074d8769d1ffa4ee058b1dbc3

fromAmountstringrequired

Amount of sending tokens.

Example: 100000000

toAmountstringrequired

Approximate amount of receiving tokens.

Example: 100000000

routeStatusstringrequired

Status of the Active Route.

Example: PENDING

createdAtdate-timerequired

Timestamp of Route start.

Example: 1642009930239

updatedAtdate-timerequired

Timestamp of last route update.

Example: 1642009930239

currentUserTxIndexnumberrequired

Index of current tx in userTxs array.

Example: 1642009930239

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

Example (from schema)

{
  "success": true,
  "result": {
    "activeRouteId": 420,
    "userAddress": "0x3e8cB4bd04d81498aB4b94a392c334F5328b237b",
    "totalUserTx": 3,
    "userTxs": [
      {}
    ],
    "fromChainId": 137,
    "toChainId": 56,
    "fromAssetAddress": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
    "toAssetAddress": "0x1af3f329e8be154074d8769d1ffa4ee058b1dbc3",
    "fromAmount": "100000000",
    "toAmount": "100000000",
    "routeStatus": "PENDING",
    "createdAt": 1642009930239,
    "updatedAt": 1642009930239,
    "currentUserTxIndex": 1642009930239,
    "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"
    }
  }
}