R/fun_statistics.R

In eddelbuettel/td: Access to the 'twelvedata' Financial Data API

.funstatisticssurl <- "https://api.twelvedata.com/statistics"

##' Retrieve Main Fundamental Data Statistics Including Valuation
##' Metrics and Financials from \sQuote{twelvedata}.
##'
##' \code{fun_statistics}.
##' @title Fundamental Data Accessor for Main Statistics from \sQuote{twelvedata}
##'      This API endpoint is available starting with the Pro plan.
##' @param sym (character)  A (single or vector) symbol for Indices. Defaults to unset.
##' @param exchange (optional, character)  Exchange. Defaults to unset.
##' @param country (optional, character)  An alpha code or country name. Defaults to unset.
##' @param apikey (optional character) An API key override, if missing a value cached from
##' package startup is used. The startup looks for either a file in the per-package config
##' directory provided by \code{tools::R_user_dir} (for R 4.0.0 or later), or the
##' \code{TWELVEDATA_API_KEY} variable.
##' @return The requested data is returned as a \code{list} object.
##' @seealso \url{https://twelvedata.com/docs}
fun_statistics <- function(sym,
                           exchange = "",
                           country = "",
                           apikey) {

  if (missing(apikey)) apikey <- .get_apikey()

  qry <- paste0(.funstatisticssurl, "?",
                "&apikey=", apikey)
  qry <- paste0(qry, "&symbol=", sym)
  if (exchange[1] != "") qry <- paste0(qry, "&exchange=", exchange)
  if (country[1] != "") qry <- paste0(qry, "&country=", country)

  accessed <- format(Sys.time(), tz = "UTC")
  res <- RcppSimdJson::fload(qry)

  if(length(sym) == 1) res <- list(res)
  names(res) <- sym

  attr(res, which = "accessed") <- accessed

  res
}