bt_getdepositaddress: Retrieve the Address for a Specified Currency

View source: R/private-interface.r

bt_getdepositaddressR Documentation

Retrieve the Address for a Specified Currency

Description

The bt_getdepositaddress() retrieves or creates the account deposit address for a specified currency.

Usage

bt_getdepositaddress(currency)

Arguments

currency

currency to get the deposit address

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. If an address has not been generated this field will have value "ADDRESS_GENERATING" until it is available.

  • result: a data.frame with the one row and columns providing the currency and the address.

References

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

Examples

## Not run: 
# Note you must authenticate first.
bt_getdepositaddress("btc")
# $success
# [1] TRUE
#
# $message
# [1] ""
#
# $result
#   currency                            address
# 1      BTC 1Q6WissSMNF7NCNw3sDXQ2F7AbrSCYouj2

## End(Not run)

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