R/estimates.R

In zac-garland/fmpr: lightweight R interface to Financial Modeling Prep API

#' Company analyst estimates
#'
#' @param ticker a stock ticker
#' @param period reporting period, quarter or annual
#' @seealso https://financialmodelingprep.com/developer/docs/
#' @export
#' @examples
#' fmp_analyst_estimates(ticker = "AAPL", period = "quarter")

fmp_analyst_estimates <- function(ticker = "AAPL", period = "quarter") {
  apikey <- fmp_api_key()

  fmp_url <- fmp_url_builder(glue::glue("analyst-estimates/{ticker}?period={period}&apikey={apikey}"))

  fmp_data(fmp_url)
}


#' Company analyst upgrades downgrades
#'
#' @param ticker a stock ticker
#' @seealso https://financialmodelingprep.com/developer/docs/
#' @export
#' @examples
#' fmp_analyst_upgrades(ticker = "AAPL")

fmp_analyst_upgrades <- function(ticker = "AAPL") {
  apikey <- fmp_api_key()

  fmp_url <- fmp_url_builder(glue::glue("upgrades-downgrades-consensus?symbol={ticker}&apikey={apikey}"),version = 4)

  fmp_data(fmp_url)
}