R/press_releases.R

In threadingdata/finnhubr: Integration with Finnhub.io API

#' @title Press Releases
#' @description Get press releases
#'
#' @param symbol Cryptocurrency symbol
#' @param from Begin date
#' @param to End date
#'
#' @importFrom tibble as_tibble
#' @importFrom lubridate today
#'
#' @return
#' @export
#'
#' @examples
#' press_releases('NVDA')
#' press_releases('NVDA', from = lubridate::today()-7, to = lubridate::today())
press_releases <- function(symbol, 
                           from = lubridate::today() - 365, 
                           to = lubridate::today()
                           , ...){
  
  url <- finnhub_endpoint('press_releases')

  df <- retry_get(url,
                  query = list(token = finnhub_key(),
                               symbol = symbol,
                               from = from,
                               to = to))
  df %>% 
    .[['majorDevelopment']] %>% 
    tibble::as_tibble()
}