R/api-tiingo.R

In mdancho84/tidyquant: Tidy Quantitative Financial Analysis

#' Set Tiingo API Key
#'
#' Requires the riingo package to be installed.
#' @param api_key Optionally passed parameter to set Tiingo `api_key`.
#'
#' @return Returns invisibly the currently set `api_key`
#'
#' @details A wrapper for `riingo::ringo_set_token()`
#'
#' @seealso [tq_get()] `get = "tiingo"`
#'
#'
#' @examplesIf rlang::is_installed("riingo")
#' \dontrun{
#'   tiingo_api_key(api_key = "foobar")
#' }
#'
#' @export
tiingo_api_key <- function(api_key) {
    if(!requireNamespace("riingo", quietly = TRUE)) {
        stop("riingo must be installed to use this functionality.", call. = FALSE)
    }

    if (missing(api_key)) return(riingo::riingo_get_token())

    riingo::riingo_set_token(api_key)

}