/availableBalance

1 min

POST

/availableBalance

Call this endpoint to request the available balance of one or more coins for a specified account.

return: Available balance in all wallets for the given account and coin symbol. The balance is displayed in the coin's smallest unit, such as wei, satoshi, lovelace, drops, etc...

-------------------- Request --------------------

  {
      "FunctionData": {
          "AccountId": 1,
          "CoinsAndWallets": [
              {
                  "CoinType": "BTC"
              },
              {
                  "CoinType": "ETH"
              },
              {
                  "CoinType": "BCH"
              },
              {
                  "CoinType": "XRP"
              },
              {
                  "CoinType": "XLM"
              },
              {
                  "CoinType": "ADA"
              }
          ]
      },
      "Meta": {
          "AccessToken": "7bfc0d75ad498ec3aee3fa38c3223acee7aeb961a0e49839980b27dfe311bef4",
          "Destination": "414939906fb533af444db36049486bd16a7d3d857e9e045209ffc0793db2702f0dbbefec7c8e95698014508d3cd17dd413d0c636ce77d6ff5d9f6722d6e822d38c",
          "FunctionName": "availableBalance",
          "RandomData": "1250914eb3da9e16e9c9ecc38d45f315726c079005b099237dbd129d773addcf",
          "Source": "0468e5f9446d88c5991c8bc40e7707af258b2a34cba8c51850e5c04373de82df0ae1b8a3ba76e058cc943980ac2516dfd198c7ee773fe1a5dd11a8fd510b83eaf7",
          "Time": "2025-01-29 19:07:21.731558"
      }
  }

  -------------------- Response --------------------

  {
      "FunctionData": {
          "Balances": [
              {
                  "Balances": [
                      {
                          "Balance": "0",
                          "DepositBalance": "0",
                          "Wallet": "HOT"
                      },
                      {
                          "Balance": "0",
                          "Wallet": "COLD"
                      }
                  ],
                  "CoinType": "BTC"
              },
              {
                  "Balances": [
                      {
                          "Balance": "600000000000000000",
                          "DepositBalance": "0",
                          "Wallet": "HOT"
                      },
                      {
                          "Balance": "0",
                          "Wallet": "COLD"
                      }
                  ],
                  "CoinType": "ETH"
              },
              {
                  "Balances": [
                      {
                          "Balance": "0",
                          "DepositBalance": "0",
                          "Wallet": "HOT"
                      },
                      {
                          "Balance": "0",
                          "Wallet": "COLD"
                      }
                  ],
                  "CoinType": "BCH"
              },
              {
                  "Balances": [
                      {
                          "Balance": "0",
                          "DepositBalance": "0",
                          "Wallet": "HOT"
                      },
                      {
                          "Balance": "0",
                          "Wallet": "COLD"
                      }
                  ],
                  "CoinType": "XRP"
              },
              {
                  "Balances": [
                      {
                          "Balance": "0",
                          "DepositBalance": "0",
                          "Wallet": "HOT"
                      },
                      {
                          "Balance": "0",
                          "Wallet": "COLD"
                      }
                  ],
                  "CoinType": "XLM"
              },
              {
                  "Balances": [
                      {
                          "Balance": "22818307",
                          "DepositBalance": "0",
                          "Wallet": "HOT"
                      },
                      {
                          "Balance": "17000000",
                          "Wallet": "COLD"
                      }
                  ],
                  "CoinType": "ADA"
              }
          ]
      },
      "Meta": {
          "AccessToken": "ba9581366666383492b86dcea18b2b20cf786971ba818a4f6402f060ea57a325",
          "Destination": "0468e5f9446d88c5991c8bc40e7707af258b2a34cba8c51850e5c04373de82df0ae1b8a3ba76e058cc943980ac2516dfd198c7ee773fe1a5dd11a8fd510b83eaf7",
          "Source": "414939906fb533af444db36049486bd16a7d3d857e9e045209ffc0793db2702f0dbbefec7c8e95698014508d3cd17dd413d0c636ce77d6ff5d9f6722d6e822d38c",
          "Time": "2025-01-29 19:07:23.434"
      }
  }

account_idintegerThe account ID to use in this operation.

coin_typesarrayThe coin symbol to use in this operation.

acceptstringGenerated from available response content types

bodyobjectRequest to retrieve the current available balance of specified coins across all wallets on the account.

200success

curl --request POST \
     --url '/availableBalance?account_id=1&coin_types=BTC' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "FunctionData": {
     "AccountId": 1,
     "CoinsAndWallets": [
     {
     "CoinType": "BTC"
     }
     ]
     },
     "Meta": {
     "FunctionName": "availableBalance",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'