get_instrument: Get a single instrument from the instruments resource.

In openaq: Access Air Quality Data from the 'OpenAQ' API

Get a single instrument from the instruments resource.

Description

Get a single instrument from the instruments resource.

Usage

get_instrument(
  instruments_id,
  as_data_frame = TRUE,
  dry_run = FALSE,
  rate_limit = FALSE,
  api_key = NULL
)

Arguments

instruments_id	An integer representing the OpenAQ instruments_id.
as_data_frame	A logical for toggling whether to return results as data frame or list, default is TRUE.
dry_run	A logical for toggling a dry run of the request, default is FALSE.
rate_limit	A logical for toggling automatic rate limiting based on rate limit headers, default is FALSE.
api_key	A valid OpenAQ API key string, default is NULL.

Value

A data frame or a list of the results.

Examples

instrument <- get_instrument(42)

openaq documentation built on March 19, 2026, 5:08 p.m.