R/limiting.R

In ewenme/discogger: Interface to the 'Discogs' API

#' Check Discogs API user rate limits
#'
#' This function prints a users Discogs API rate limit information. All calls to the API
#' deduct one unit from rate limits. Discogs rate limiting tracks your requests using a moving
#' average over a 60 second window. If no requests are made in 60 seconds, your window will reset.
#' For more information, check the \href{https://www.discogs.com/developers/#page:home,header:home-rate-limiting}{rate limiting API documentation}
#'
#' @inheritParams discogs_artist
#'
#' @return None (invisible NULL)
#'
#' @export
#' @examples \dontrun{
#' discogs_rate_limit()
#' }
discogs_rate_limit <- function(access_token=discogs_api_token()) {

  # hit api
  req <- discogs_get(
    base_url, ua,
    add_headers(Authorization = glue("Discogs token={access_token}")
                )
    )

  # extract headers
  headers <- headers(req)

  # print rate limit info

  cat(headers$`x-discogs-ratelimit-used`, " / ", headers$`x-discogs-ratelimit`,
      " (", headers$`x-discogs-ratelimit-remaining`, " requests remaining) as of ",
      headers$date, "\nN.B. Discogs rate limiting tracks your requests using a moving average over a 60 second window.", sep = "")
}