Get transfers data
POST
https://api.octusbridge.io/v1/transfers/search
200: OK Successful request
Copy {
"transfers": [
{
"tonUserAddress": "0:fdbc0c8ac30050ac2d3166ce714e3ca3a4641fe251a33751c037d88bbd514d49",
"transferStatus": "Confirmed",
"transferKind": "TonToEth",
"creditProcessorAddress": null,
"tonEthContractAddress": "0:3dbfd8d3d8ae79cc1a67af212e03c3646fd0c6f866000efeb3ac95c63587fcf8",
"tonEthChainId": 56,
"tonEthVolumeExec": "1240",
"tonEthVolumeUsdtExec": "1240",
"tonEthTonTokenAddress": "0:a519f99bb5d6d51ef958ed24d337ad75a1c770885dcd42d51d6663f9fcdacfb2",
"tonEthEthTokenAddress": "0x55d398326f99059ff775485246999027b3197955",
"tonEthProxyAddress": "0:a3023d7812aff9cafa73365853bdc11eeb010f09cd657de6e802adf16cfcd282",
"tonEthEthUserAddress": "0xa2a38f05baf66b20e89f87dd9a35ebcb840210ba",
"tonEthStatus": "Confirmed",
"tonEthRequiredVotes": 18,
"ethTonContractAddress": null,
"ethTonChainId": null,
"ethTonVolumeExec": null,
"ethTonVolumeUsdtExec": null,
"ethTonTonTokenAddress": null,
"ethTonEthTokenAddress": null,
"ethTonProxyAddress": null,
"ethTonEthUserAddress": null,
"ethTonTransactionHashEth": null,
"ethTonStatus": null,
"ethTonRequiredVotes": null,
"updatedAt": 1657215766000,
"createdAt": 1657215335000
},
...
}
],
"totalCount": 9369
}
This function returns all the details about transfer for specified user based on tokens transferred, transfer kind, amount transferred.
It can be used for filtering user’s transfers and displaying them in the list form with following details such as total number of transfers filtered, time of creation, credit processor, transfer contracts addresses, number of required votes, proxy addresses, volume, status etc.
Request parameters
Required body parameters:
Parameters used for test:
Response fields explanation
Example
Copy app . post ( '/transfers/search' , (req , res) => {
axios({
method : 'post' ,
url : `${apiUrl} / transfers / search` ,
data : {
createdAtGe : req . body . createdAtGe ,
createdAtLe : req . body . createdAtLe ,
ethTokenAddress : req . body . ethTokenAddress ,
ethTonChainId : req . body . ethTonChainId ,
limit : req . body . limit ,
offset : req . body . offset ,
ordering : req . body . ordering ,
status : req . body . status ,
tonEthChainId : req . body . tonEthChainId ,
tonTokenAddress : req . body . tonTokenAddress ,
transferKinds : req . body . transferKinds ,
updatedAtGe : req . body . updatedAtGe ,
updatedAtLe : req . body . updatedAtLe ,
userAddress : req . body . userAddress ,
volumeExecGe : req . body . volumeExecGe ,
volumeExecLe : req . body . volumeExecLe
}
})
. then ( function (response) {
res . send ( response . data )
})
. catch ( function(error) {
console . error (error)
res . send ( 'Error' )
})
})
Get not instant transfers data
POST
https://api.octusbridge.io/v1/transfers/search_not_instant
200: OK Successful request
Copy {
"transfers": [
{
"bounty": "7000",
"currentAmount": "0",
"status": "Close",
"userId": "0",
"payloadId": "0x5da3db5ce2e56676abe61cd11babab0bb4d06c7c13dc2fe13085ef695d1f305b",
"tonUserAddress": "0:76bb1dda9746d1366c57515e4d26ea8b3e9fa549444879a473cf96609e699ae3",
"contractAddress": "0:1adcc1fa516ea7d2e5d843a2353e53176374ff474bfb6267ced8de12e0ba748e",
"chainId": 43114,
"volumeExec": "0.00031000",
"volumeUsdtExec": "9.8003",
"tonTokenAddress": "0:2ba32b75870d572e255809b7b423f30f36dd5dea075bd5f026863fceb81f2bcf",
"ethTokenAddress": "0x50b7545627a5162f82a992c33b87adc75187b218",
"ethUserAddress": "0x02a312c4303037f12acfe3513e6b14a8d8daecf3",
"timestamp": 1654087434000
},
...
],
"totalCount": 70
}
This function returns all the details about transfer for a specified user based on tokens transferred, transfer kind, amount transferred, bounty amount.
It can be used for filtering user’s transfers and displaying them in the list form with following details such as total number of transfers filtered, time of creation, bounty amount, transfer contract address, number of required votes, user addresses, current balance, volume transferred, status etc.
Request parameters
Required body parameters:
Parameters used for test:
Response fields explanation
Example
Copy app . post ( '/transfers/search_not_instant' , (req , res) => {
axios({
method : 'post' ,
url : `${apiUrl} / transfers / search_not_instant` ,
data : {
bountyGe : req . body . bountyGe ,
bountyLe : req . body . bountyLe ,
chainId : req . body . chainId ,
contractAddress : req . body . contractAddress ,
createdAtGe : req . body . createdAtGe ,
createdAtLe : req . body . createdAtLe ,
ethTokenAddress : req . body . ethTokenAddress ,
limit : req . body . limit ,
offset : req . body . offset ,
ordering : req . body . ordering ,
status : req . body . status ,
tonTokenAddress : req . body . tonTokenAddress ,
userAddress : req . body . userAddress ,
volumeExecGe : req . body . volumeExecGe ,
volumeExecLe : req . body . volumeExecLe
}
})
. then ( function (response) {
res . send ( response . data )
})
. catch ( function(error) {
console . error (error)
res . send ( 'Error' )
})
})
Get transfers main page data
GET
https://api.octusbridge.io/v1/transfers/main_page
200: OK Successful request
Copy {
"volume24hUsdt": "103033.0836",
"volume24hUsdtChange": "-77.6500",
"volume7dUsdt": "1756514.8873",
"volume7dUsdtChange": "-28.6500",
"fromEverscaleUsdt": "76111457.8632",
"toEverscaleUsdt": "78524067.1362"
}
This function returns global transfer details such as volumes transferred from everscale network and to everscale network, 24h volume change, 7 days volume change.
It can be used for monitoring transfer data on the whole application level.
Request parameters
No required parameters
Response fields explanation
Example
Copy app . get ( '/transfers/main_page' , (req , res) => {
axios({
method : 'get' ,
url : `${apiUrl} / transfers / main_page`
})
. then ( function (response) {
res . send ( response . data )
})
. catch ( function(error) {
console . error (error)
res . send ( 'Error' )
})
})
Get transfers volume graph data
POST
https://api.octusbridge.io/v1/transfers/graph/volume
200: OK Successful request
Copy [
{
"ethTonVolume": "10.7100",
"tonEthVolume": "6980.2140",
"timestamp": 1654988400000
},
}
]
This function returns a list of transferred volumes from ethereum to everscale and vice versa as well as the date time of measured data inside of a given timespan hourly or daily, depending on how the parameter is set.
It can be used to show graphical representation of transfers in the given timespan.
Request parameters
Response fields explanation
Example
Copy app . post ( '/transfers/graph/volume' , (req , res) => {
axios({
method : 'post' ,
url : `${apiUrl} / transfers / graph / volume` ,
data : {
from : req . body . from ,
timeframe : req . body . timeframe ,
to : req . body . to
}
})
. then ( function (response) {
res . send ( response . data )
})
. catch ( function(error) {
console . error (error)
res . send ( 'Error' )
})
})