Comment on page

Active-Routes/Users

Returns active route of an address

v2/route/active-routes
How this endpoint is used:
This endpoint returns all the routes a user has bridged from 
It can be used to show the user their transaction history 
API-KEY needs to be passed in the headers while making the GET request
get
https://api.socket.tech/v2
/route/active-routes/users
Returns transaction history of user
Description of response parameters : 
Parameter
Value
success
Indicates successful response from endpoint, as intended.
activeRoutes
Array of active routes
activeRouteId 
ID of route
userAddress
Address of user bridging via the route
totalUserTx 
Number of transactions user has to perform on the route
userTxs
Array of objects breaking down each user transaction
userTxs.sender
Address of tx sender
userTxs.txType
Type of transaction. Values in Types page ​
userTxs.chainId
ID of chain for transaction
userTxs.gasFees.asset
Object with metadata of gas token for chain
userTxs.gasFees.gasLimit
Estimated gasLimit for transaction 
userTxs.gasFees.feesInUsd
Estimated gas fee in USD to display on UI. This could vary as per gas prices. 
userTxs.toAsset
Object with metadata of receiving token in given tx
userTxs.protocol
Object with metadata of protocol
userTxs.toAmount
Amount of toAsset token to be received in given tx
userTxs.fromAsset
Object with metadata of sending token in given tx
userTxs.recipient
Address of recipient in given tx
userTxs.fromAmount
Amount of fromAsset token sent in given tx
userTxs.userTxType
Action of transaction user performs. Values in Types page ​
userTxs.userTxIndex
Index of transaction from totalUserTx
userTxs.approvalData
Object with data for token approval
fromChainId
ID of source chain
toChainId
ID of destination chain
fromAssetAddress
Address of sending token
toAssetAddress
Address of receiving token
fromAmount
Amount of sending token being bridged
toAmount
Amount of destination token received 
routeStatus
Status of route. Values on Types page.
transactionData
Object with hashes of transactions performed by user 
createdAt
Timestamp of route being created 
updatedAt
Timestamp of route being last updated
currentUserTxIndex
Index of transaction user last performed 
fromAsset
Object with metadata of sending token
toAsset
Object with metadata of receiving token
pagination
Object highlighting offset, limit and totalRecords
​
TEST QUERY : https://api.socket.tech/v2/swagger/#/Routes/ActiveRoutesController_getActiveRoutesForUser​

Parameter	Value
`success`	Indicates successful response from endpoint, as intended.
`activeRoutes`	Array of active routes
`activeRouteId`	ID of route
`userAddress`	Address of user bridging via the route
`totalUserTx`	Number of transactions user has to perform on the route
`userTxs`	Array of objects breaking down each user transaction
`userTxs.sender`	Address of tx sender
`userTxs.txType`	Type of transaction. Values in Types page
`userTxs.chainId`	ID of chain for transaction
`userTxs.gasFees.asset`	Object with metadata of gas token for chain
`userTxs.gasFees.gasLimit`	Estimated gasLimit for transaction
`userTxs.gasFees.feesInUsd`	Estimated gas fee in USD to display on UI. This could vary as per gas prices.
`userTxs.toAsset`	Object with metadata of receiving token in given tx
`userTxs.protocol`	Object with metadata of protocol
`userTxs.toAmount`	Amount of `toAsset` token to be received in given tx
`userTxs.fromAsset`	Object with metadata of sending token in given tx
`userTxs.recipient`	Address of recipient in given tx
`userTxs.fromAmount`	Amount of `fromAsset` token sent in given tx
`userTxs.userTxType`	Action of transaction user performs. Values in Types page
`userTxs.userTxIndex`	Index of transaction from `totalUserTx`
`userTxs.approvalData`	Object with data for token approval
`fromChainId`	ID of source chain
`toChainId`	ID of destination chain
`fromAssetAddress`	Address of sending token
`toAssetAddress`	Address of receiving token
`fromAmount`	Amount of sending token being bridged
`toAmount`	Amount of destination token received
`routeStatus`	Status of route. Values on Types page.
`transactionData`	Object with hashes of transactions performed by user
`createdAt`	Timestamp of route being created
`updatedAt`	Timestamp of route being last updated
`currentUserTxIndex`	Index of transaction user last performed
`fromAsset`	Object with metadata of sending token
`toAsset`	Object with metadata of receiving token
`pagination`	Object highlighting offset, limit and totalRecords

Active-Routes

Build-Next-Tx

Last modified 1yr ago