R/economic_data.R

In threadingdata/finnhubr: Integration with Finnhub.io API

#' @title Economic Data
#' @description Get economic data using an economic code
#'  
#' @param code Economic code - see economic_code()
#' 
#' @return
#' @export
#' 
#' @examples
#' economic_data('MA-USA-857882') # Unemployment Rate - United States

# Multiple codes at once
#' us_codes <- economic_code() %>%
#'   dplyr::filter(country == 'United States') %>%
#'   dplyr::slice(1:5) %>% # Top 5
#'   dplyr::pull(code)
#' us_codes

# Multipe U.S. codes and joined back to economic_code() metadata
#' us_econ_data <- purrr::map(us_codes, economic_data) %>% 
#'   dplyr::bind_rows() %>% 
#'   dplyr::left_join(economic_code(), by = 'code')
#' transcripts('AAPL_162777')
economic_data <- function(code, ...){
  
  url <- finnhub_endpoint('economic')
  
  df <- retry_get(url,
                  query = list(token = finnhub_key(),
                               code = code)) 
  
  df %>% 
    .[['data']] %>% 
    dplyr::mutate(date = lubridate::ymd(date, tz = finnhub_timezone),
                  code = code) %>% 
    dplyr::select(date, code, value)
}