R/general_news.R

In threadingdata/finnhubr: Integration with Finnhub.io API

#' @title General Market News
#' @description Get general market news
#'  
#' @param min_id News ID to get the latest news
#' 
#' @importFrom purrr set_names
#' @importFrom lubridate as_datetime
#' @importFrom dplyr mutate
#' 
#' @return
#' @export
#' 
#' @examples
#' general_news()
general_news <- function(min_id = 0, ...){
  
  url <- finnhub_endpoint('general_news')
  
  retry_get(url, 
            query = list(token = finnhub_key(),
                         category = 'general',
                         minId = min_id)) %>% 
    purrr::set_names(c('news_category', 'unixtime', 'headline', 'id', 
                       'image', 'related', 'source', 'summary', 'url')) %>% 
    dplyr::mutate(date = lubridate::as_datetime(unixtime, tz = finnhub_timezone))
}