R/get_fundamentals.R

In RobinHood: Interface for the RobinHood.com No Commission Investing Platform

#' Get fundamental investment statistics for a particular ticker symbol
#'
#' @param RH object of class RobinHood
#' @param ticker (string) vector of ticker symbols
#' @param include_description (logical) include a long description of the company (default: FALSE)
#' @import httr magrittr
#' @export
#' @examples
#' \dontrun{
#' # Login in to your RobinHood account
#' RH <- RobinHood("username", "password")
#'
#' get_fundamentals(RH, "CAT")
#'}
get_fundamentals <- function(RH, ticker, include_description = FALSE) {

  # Check if RH is valid
  RobinHood::check_rh(RH)

  # Collapse tickers into a single string
  symbol <- ticker
  ticker <- paste(ticker, collapse = ",")

  # Investment fundamentals call
  fundamentals <- RobinHood::api_fundamentals(RH, ticker)

  # Empty dataframe for results
  x <- data.frame(
    open                   = NA,
    high                   = NA,
    low                    = NA,
    volume                 = NA,
    market_date            = NA,
    average_volume_2_weeks = NA,
    average_volume         = NA,
    high_52_weeks          = NA,
    dividend_yield         = NA,
    float                  = NA,
    low_52_weeks           = NA,
    market_cap             = NA,
    pb_ratio               = NA,
    pe_ratio               = NA,
    shares_outstanding     = NA,
    description            = NA,
    instrument             = NA,
    ceo                    = NA,
    headquarters_city      = NA,
    headquarters_state     = NA,
    sector                 = NA,
    industry               = NA,
    num_employees          = NA,
    year_founded           = NA
  )

  # If the return all is empty then assign the NA dataframe
  if (nrow(fundamentals) == 0) {
    fundamentals <- x
  }

  # Remove the long description field
  if (include_description == FALSE) {
    fundamentals <- fundamentals[, !names(fundamentals) %in% c("description", "instrument")]
  }

  # Add the symbol vector back, not part of api_fundamentals
  fundamentals <- cbind(symbol, fundamentals)

  # Format
  fundamentals <- fundamentals %>%
    dplyr::mutate_at(c("open", "high", "low", "volume", "average_volume_2_weeks",
                       "average_volume", "high_52_weeks", "dividend_yield", "float",
                       "low_52_weeks", "market_cap", "pb_ratio", "pe_ratio", "shares_outstanding"),
                     as.numeric)

  return(fundamentals)
}