PoloniexR (version 0.0.1)

ReturnCompleteBalances,PoloniexTradingAPI-method: Returns all of your account balances, including available balance, balance on orders, and the estimated BTC value of your balance. By default, this call is limited to your exchange account; set the all.balances input parameter to TRUE to include your margin and lending accounts.

Description

Returns all of your account balances, including available balance, balance on orders, and the estimated BTC value of your balance. By default, this call is limited to your exchange account; set the all.balances input parameter to TRUE to include your margin and lending accounts.

Usage

# S4 method for PoloniexTradingAPI
ReturnCompleteBalances(theObject,
  all.balances = FALSE)

Arguments

theObject

The Trading client API object on which the function should be called.

all.balances

logical - set to TRUE to also return margin and lending account balances.

Value

todo

Examples

# NOT RUN {
poloniex.trading <- PoloniexTradingAPI(your.key, your.secret)
balances         <- ReturnCompleteBalances(poloniex.trading)
head(balances)

balances.all <- ReturnCompleteBalances(poloniex.trading)
head(balances.all)
# }