Skip to main content

ActiveRoutesController_getActiveRoutesForUser

GET 
https://api.socket.tech/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​

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.

Schema

    success booleanrequired

    Status of API response.

    result

    object

    required

    activeRouteId numberrequired

    Id of the Active Route.

    userAddress stringrequired

    Address of user doing the Active Route.

    totalUserTx numberrequired

    Total number of txs required in Active Route.

    userTxs object[]required

    Array of user txs.

    fromChainId numberrequired

    Id of source chain.

    toChainId numberrequired

    Id of destination chain.

    fromAssetAddress stringrequired

    Address of token on source chain.

    toAssetAddress stringrequired

    Address of token on destination chain.

    fromAmount stringrequired

    Amount of sending tokens.

    toAmount stringrequired

    Approximate amount of receiving tokens.

    routeStatus stringrequired

    Status of the Active Route.

    createdAt date-timerequired

    Timestamp of Route start.

    updatedAt date-timerequired

    Timestamp of last route update.

    currentUserTxIndex numberrequired

    Index of current tx in userTxs array.

    fromAsset

    object

    required

    name string

    Name of token.

    address stringrequired

    Address of token.

    icon string

    URL for icon of token.

    decimals number

    Decimal used for token.

    symbol stringrequired

    Symbol of token.

    chainId stringrequired

    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]

    Chain id of the token

    logoURI string

    URL for icon of token.

    chainAgnosticId string

    Unique Id over all chains

    toAsset

    object

    required

    name string

    Name of token.

    address stringrequired

    Address of token.

    icon string

    URL for icon of token.

    decimals number

    Decimal used for token.

    symbol stringrequired

    Symbol of token.

    chainId stringrequired

    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]

    Chain id of the token

    logoURI string

    URL for icon of token.

    chainAgnosticId string

    Unique Id over all chains

Loading...