R/av_api_key.R

In alphavantagepf: Comprehensive R Wrapper for 'Alphavantage Financial Data' API

#' Set the Alpha Vantage API Key
#'
#' @name av_api_key
#' @description
#' `av_api_key()` sets Alphavantage API key and entitlement code
#'
#' @param api_key A character string with your Alpha Vantage API Key.
#' @param entitlement A character string with your Alpha Vantage entitlement status.  If not "delayed" or "realtime" entitlement not added to API string.
#'
#' @returns Invisibly returns two item list with API key and entitlement string once set). Use print method to view.
#'
#' @details
#' The Alpha Vantage API key must be set prior to using [av_get_pf()]. You can obtain
#' an API key at the [Alpha Vantage Website](https://www.alphavantage.co/).
#'
#' @seealso [av_get_pf()]
#'
#' @examples
#' \dontrun{
#' av_api_key("YOUR_API_KEY",entitlement="delayed")
#' av_get_pf("IBM", "TIME_SERIES_INTRADAY")
#' }
#'
#' @rdname av_api_key
#' @export
av_api_key <- function(api_key,entitlement=NULL) {
    if (!missing(api_key)) {
        options(av_api_key = api_key)
    }
  if (!is.null(entitlement)) {
    if( tolower(entitlement) %in% c("delayed","realtime")) {
        options(av_api_entitlement = entitlement)
    }
  }
  invisible(c(getOption('av_api_key'),getOption('av_api_entitlement',default=NA_character_)))
}