PoloniexR (version 0.0.1)

ReturnLoanOrders,PoloniexPublicAPI-method: Returns a list of loan offers and demands for a given currency.

Description

Returns a list of loan offers and demands for a given currency.

Usage

# S4 method for PoloniexPublicAPI
ReturnLoanOrders(theObject, currency = "BTC")

Arguments

theObject

The object on which the function should be called

currency

- a length-one character vector Represents the currency for which loan information should be fetched.

Value

A list containing two items. Each item is a dataframe containing the actual loan offers or demands information. eg list$offers / list$demands - rows: offers / demand "order book" entries. - columns: rate, amount, min.days, max.days

Examples

# NOT RUN {
poloniex.public <- PoloniexPublicAPI()
currency        <- "BTC"
loan.orders     <- ReturnLoanOrders(poloniex.public)
# }