Routes
GET /v2/route/active-routes/users
Request
- The document declares no server URL.
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
userAddressstring required
Address of user starting the route.
sort'updatedAt' | 'createdAt'
Sort param for routes.
offsetstring
Offset for fetching active routes.
limitstring
Number of active routes to return in one API call.
routeStatus'PENDING' | 'COMPLETED'
Status of the route. The route will only be marked completed if all the user txs have been completed.
fromChainIdstring
Id of sending chain
toChainIdstring
Id of destination chain.
fromTokenAddressstring
Address of token on source chain.
toTokenAddressstring
Token address on destination chain.
Headers
API-KEYstring
Response
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.
Example response
{
"success": true,
"result": {
"activeRouteId": 420,
"userAddress": "0x3e8cB4bd04d81498aB4b94a392c334F5328b237b",
"totalUserTx": 3,
"fromChainId": 137,
"toChainId": 56,
"fromAssetAddress": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
"toAssetAddress": "0x1AF3F329e8BE154074D8769D1FFa4eE058B1DBc3",
"fromAmount": "100000000",
"toAmount": "100000000",
"routeStatus": "PENDING",
"currentUserTxIndex": 1642009930239,
"fromAsset": {
"name": "USD Coin",
"address": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
"icon": "https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg",
"decimals": 6,
"symbol": "USDC"
},
"toAsset": {
"name": "USD Coin",
"address": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
"icon": "https://maticnetwork.github.io/polygon-token-assets/assets/usdc.svg",
"decimals": 6,
"symbol": "USDC"
}
}
}Changes
No recorded changes to this operation across all 3 revisions of this API.