R/api_tag.R

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

#' RobinHood API: Tag
#'
#' Backend function called by get_tag(). Returns a list of instrument ids.
#'
#' @param RH object of class RobinHood
#' @param tag (string) a hyphenated tag such as "100-most-popular"
#' @import httr magrittr
#' @export
api_tag <- function(RH, tag) {

  # URL and token
  url <- paste(RobinHood::api_endpoints("tags"), tag, "/", sep = "", collapse = "")
  token <- paste("Bearer", RH$api_response.access_token)

  # GET call
  dta <- GET(url,
             add_headers("Accept" = "application/json",
                         "Content-Type" = "application/json",
                         "Authorization" = token))
  httr::stop_for_status(dta)

  # format return
  dta <- RobinHood::mod_json(dta, "fromJSON")
  dta <- as.character(dta$instruments)

  return(dta)
}