R/get_organization_data.R

In PurpleAir: Query the 'PurpleAir' Application Programming Interface

#' Get Organization Data
#'
#' Use the PurpleAir API to retrieve information for the organization containing the provided api_key
#' Find more details on this function at https://api.purpleair.com/#api-organization-get-organization-data
#' @param purple_air_api_key A character that is your PurpleAir API `READ` key
#' @returns A list of organization info
#' @export
#' @seealso check_api_key
#' @examples
#' \dontrun{
#' get_organization_data()
#' }
get_organization_data <- function(purple_air_api_key = Sys.getenv("PURPLE_AIR_API_KEY")) {
  resp <-
    purple_air_request(
      purple_air_api_key = purple_air_api_key,
      resource = "organization",
      success_code = as.integer(200)
    ) |>
    httr2::req_perform()
  out <- httr2::resp_body_json(resp)
  out$time_stamp <- as.POSIXct.numeric(out$time_stamp)
  return(out)
}