Chart the long-short ratios

The long-short ratio is a market sentiment indicator on expected price movement.

Usage

addLSRatio(chart, LSR)

Arguments

chart

a kline() or ohlc() chart

LSR

The Fear and Greed Index created by getLSRatio()

Value

Invisbly returns a plotly object.

See also

Other chart indicators: addBBands(), addEvents(), addFGIndex(), addMACD(), addMA(), addRSI(), addVolume(), chart()

Examples

# Example on loading
# long-short ratio
# for the last days
# on the 15 minute candle
# wrapped in try to avoid
# failure on Github

# 1) long-short ratio
# on BTCUSDT pair
BTC_LSR <- try(
  expr = cryptoQuotes::getLSRatio(
    ticker = 'BTCUSDT',
    interval = '15m',
    from = Sys.Date() - 1,
    to   = Sys.Date()
  ),
  silent = TRUE
)

# 2) BTCSDT in same period
# as the long-short ratio;
BTCUSDT <- try(
  cryptoQuotes::getQuote(
    ticker = 'BTCUSDT',
    futures = TRUE,
    interval = '15m',
    from = Sys.Date() - 1,
    to   = Sys.Date()
  )
)
#> Error in cryptoQuotes::getQuote(ticker = "BTCUSDT", futures = TRUE, interval = "15m",  : 
#>   Service unavailable from a restricted location according to 'b. Eligibility' in https://www.binance.com/en/terms. Please contact customer service if you believe you received this message in error.

if (!inherits(x = BTC_LSR, what = 'try-error') & !inherits(x = BTCUSDT, what = "try-error")) {

  # 3) head the data
  # and display contents
  head(
    BTC_LSR
  )

  # 4) plot BTCUSDT-pair
  # with long-short ratio
  cryptoQuotes::chart(
    chart = cryptoQuotes::kline(
      BTCUSDT
    ) %>% cryptoQuotes::addLSRatio(
      LSR = BTC_LSR
    )
  )

}

# end of scrtipt;