tickers: Retrieve Cryptocurrency Data

In program--/cryptocurr: R-based Cryptocurrency Platform API Wrapper

Description

Calls the Bitfinex API to retrieve cryptocurrency data.

Usage

tickers(SYMBOLS = c("ALL"))

Arguments

SYMBOLS

Character vector containing ticker symbols for cryptocurrencies, or ALL for all possible tickers. Must be prepended with a t or f to specify trading or funding cryptocurrencies, respectively.

Details

tibble descriptions:

• SYMBOL: The symbol/ticker of the requested data

• FRR: Flash Return Rate - average of all fixed rate funding over the last hour (funding tickers only)

• BID: Price of last highest bid

• BID_PERIOD: Bid period covered in days (funding tickers only)

• BID_SIZE: Sum of the 25 highest bid sizes

• ASK: Price of last lowest ask

• ASK_PERIOD: Ask period covered in days (funding tickers only)

• ASK_SIZE: Sum of the 25 lowest ask sizes

• DAILY_CHANGE: Amount that the last price has changed since yesterday

• DAILY_CHANGE_RELATIVE: Relative price change since yesterday (*100 for percentage change)

• LAST_PRICE: Price of the last trade

• VOLUME: Daily volume

• HIGH: Daily high

• LOW: Daily low

• FRR_AMOUNT_AVAILABLE: The amount of funding that is available at the Flash Return Rate (funding tickers only)

Value

A list with tibble attributes: funding and trading. See details.

Examples

## Not run: 
    # Get Bitcoin and Litecoin info
    tickers(SYMBOLS = c("tBTCUSD", "tLTCUSD"))
    # Returns $trading tibble with 2 rows
    # and $funding tibble with 0 rows

    # Get USD info
    tickers(SYMBOLS = "fUSD")
    # Return $trading tibble with 0 rows
    # and $funding tibble with 1 row

## End(Not run)

program--/cryptocurr documentation built on Jan. 26, 2021, 1:36 a.m.