R/similarity_index.R

In threadingdata/finnhubr: Integration with Finnhub.io API

#' @title Similarity Index
#' @description Similarity index
#'  
#' @param symbol Ticker symbol
#' @param freq annual or quarterly
#' 
#' @importFrom purrr set_names
#' @importFrom dplyr mutate_at vars mutate select everything
#' @importFrom lubridate ymd_hms
#' 
#' @return
#' @export
#' 
#' @examples
#' similarity_index('BAC', freq = 'annual')
#' similarity_index('BAC', freq = 'quarterly')
similarity_index <- function(symbol, freq = 'annual', ...){
  
  url <- finnhub_endpoint('similarity_index')
  
  df <- retry_get(url,
                  query = list(token = finnhub_key(),
                               symbol = symbol,
                               freq = freq)) 
  df %>% 
    .[['similarity']] %>% 
    dplyr::mutate_at(vars(filedDate, acceptedDate), 
                     ~ lubridate::ymd_hms(.x, tz = finnhub_timezone)) %>% 
    mutate(symbol = symbol) %>% 
    purrr::set_names(c('cik', 'access_number', 'item_1' ,'item_2', 'item_1a', 
                       'item_7', 'item7a', 'form', 'report_url', 'filing_url', 
                       'filed_date', 'accepted_date', 'symbol')) %>% 
    dplyr::select(symbol, form, filed_date, dplyr::everything())
}