/availableBalance
1 min
POST
http://1.1.1.1/availableBalance
Query Parameters
- account_idintegerrequiredExampleDescriptionDefault1
- coin_typesstring[]requiredExample
[ "BTC" ]
DescriptionDefaultBTC
Body Parameters
- bodyavailableBalanceRequestDescription
- FunctionDataobjectDescription
- AccountIdintegerExampleDescriptionDefault1
- CoinsAndWalletsobject[]Description
- CoinTypestringExampleDescriptionDefaultBTC
- MetaMetaTokenavailableBalance
- FunctionNamestringExampleDescriptionDefaultavailableBalance
- RandomDatastringExampleDescriptionDefault288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229
- DestinationstringDescriptionDefaultb9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea
- TimestringExampleDescriptionDefault2021-02-07T18:37:46.948Z
- SourcestringDescriptionDefault048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99
- AccessTokenstringExampleDescriptionDefault51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087
Responses
200
- object
- FunctionDataobject
- Balancesobject[]Description
- Balancesobject[]Description
- BalancestringExampleDescriptionDefault1000
- DepositBalancestringExampleDescriptionDefault0
- WalletstringExampleDescriptionDefaultHOT
- CoinTypestringExampleDescriptionDefaultBTC
- MetaMetaResponse
- AccessTokenstringExampleDescriptionDefaulta3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6
- DestinationstringExampleDescriptionDefault042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622
- SourcestringExampleDescriptionDefaultdf4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355
- TimestringExampleDescriptionDefault2021-02-14 09:58:52.320
curl
curl --location 'http://1.1.1.1/availableBalance?account_id=6&coin_types=BTCeeee' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"FunctionData": {
"AccountId": 0,
"CoinsAndWallets": [
{
"CoinType": "BTC"
}
]
},
"Meta": {
"FunctionName": "availableBalance",
"RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
"Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
"Time": "2021-02-07T18:37:46.948Z",
"Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
"AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
}
}'javascript
var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
var raw = JSON.stringify({
"FunctionData": {
"AccountId": 0,
"CoinsAndWallets": [
{
"CoinType": "BTC"
}
]
},
"Meta": {
"FunctionName": "availableBalance",
"RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
"Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
"Time": "2021-02-07T18:37:46.948Z",
"Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
"AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
}
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("http://1.1.1.1/availableBalance?account_id=6&coin_types=BTCeeee", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("http://1.1.1.1/availableBalance?account_id=6&coin_types=BTCeeee")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
"FunctionData": {
"AccountId": 0,
"CoinsAndWallets": [
{
"CoinType": "BTC"
}
]
},
"Meta": {
"FunctionName": "availableBalance",
"RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
"Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
"Time": "2021-02-07T18:37:46.948Z",
"Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
"AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
}
})
response = http.request(request)
puts response.read_body
python
import requests
import json
url = "http://1.1.1.1/availableBalance?account_id=6&coin_types=BTCeeee"
payload = json.dumps({
"FunctionData": {
"AccountId": 0,
"CoinsAndWallets": [
{
"CoinType": "BTC"
}
]
},
"Meta": {
"FunctionName": "availableBalance",
"RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
"Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
"Time": "2021-02-07T18:37:46.948Z",
"Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
"AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
}
})
headers = {
'Accept': 'application/json',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// success
{
"FunctionData": {
"Balances": [
{
"Balances": [
{
"Balance": "1000",
"DepositBalance": "0",
"Wallet": "HOT"
}
],
"CoinType": "BTC"
}
]
},
"Meta": {
"AccessToken": "a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6",
"Destination": "042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622",
"Source": "df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355",
"Time": "2021-02-14 09:58:52.320"
}
}- This function is used to request the available balance information for a specific account and one or more coin types.
- return - available balance in wallets for given account and coin symbol in smallest unit such as wei, satoshi, lovelace, drops, etc...example:availableBalance(1,["BTC"])
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.