bt_getbalance: Account Balance for a Specified Currency

View source: R/private-interface.r

bt_getbalanceR Documentation

Account Balance for a Specified Currency

Description

The bt_getbalance() function retrieves the account balance for a specified currency on https://bittrex.com. This function can only be used after you provide information for authentication.

Usage

bt_getbalance(currency)

Arguments

currency

currency to retrieve the account balance for.

Value

A named list with the following elements:

  • success: a boolean indicating whether the request was successful.

  • message: a string describing the error if the request was not successful, otherwise an empty string.

  • result: a data.frame with the currency, balance, available funds, the amount of any pending transactions, and cryptographic addresses that can be used to receive funding.

References

https://bittrex.com/api/v1.1/account/getbalances

See Also

bt_authenticate()

Examples

## Not run: 
Note you must authenticate first.
bt_getbalance("btc")$result
#   currency balance available pending                     crypto_address
# 1      BTC       0         0       0 1Q6WissSMNF7NCNw3sDXQ2F7AbrSCYouj2

## End(Not run)

kaneplusplus/bittrex documentation built on July 6, 2022, 10:02 p.m.