Check the validity and type for the provided api_key.

Source: R/pa_API.R

Sends a request to the PurpleAirAPI API endpoint described at: https://api.purpleair.com/#api-keys-check-api-key

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

Arguments

api_key

PurpleAir API key.

baseUrl

URL endpoint for the "Check Key" API.

Value

List containing key type information.

Examples

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

library(AirSensor)

  pa_checkAPIKey(
    api_key = PURPLE_AIR_API_READ_KEY
  )

}, silent = FALSE)
#> Error in MazamaCoreUtils::stopIfNull(api_key) : 
#>   object 'PURPLE_AIR_API_READ_KEY' not found
# }