R/peers.R

In threadingdata/finnhubr: Integration with Finnhub.io API

#' @title Company Peers
#' @description Company competitors list
#'  
#' @param symbol Ticker symbol
#' 
#' @importFrom tibble tibble
#' 
#' @return
#' @export
#' 
#' @examples
#' peers('NVDA')
peers <- function(symbol, ...){
  
  url <- finnhub_endpoint('peers')
  
  df <- retry_get(url, 
                  query = list(token = finnhub_key(),
                               symbol = symbol)) 
  df %>% 
    tibble::tibble(symbol = symbol, peers = .)
}