pa_getGroupsList: Retrieve all groups owned by the provided 'api_key'.

In MazamaScience/AirSensor: Process and Display Data from Air Quality Sensors

Retrieve all groups owned by the provided api_key.

Description

Sends a request to the PurpleAirAPI API endpoint described at: https://api.purpleair.com/#api-groups-get-groups-list

Usage

pa_getGroupsList(
  api_key = NULL,
  baseUrl = "https://api.purpleair.com/v1/groups"
)

Arguments

api_key	PurpleAir API READ ey.
baseUrl	URL endpoint for the "Get Groups List" API.

Value

List containing all groups owned by api_key.

Examples

# Fail gracefully if any resources are not available
try({

library(AirSensor)

  pa_getGroupsList(
    api_key = PURPLE_AIR_API_READ_KEY
  )

}, silent = FALSE)

MazamaScience/AirSensor documentation built on April 28, 2023, 11:16 a.m.