list_countries: Get a list of countries from the countries resource.

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

Get a list of countries from the countries resource.

Description

Get a list of countries from the countries resource.

Usage

list_countries(
  providers_id = NULL,
  parameters_id = NULL,
  order_by = NULL,
  sort_order = NULL,
  limit = NULL,
  page = NULL,
  as_data_frame = TRUE,
  dry_run = FALSE,
  rate_limit = FALSE,
  api_key = NULL
)

Arguments

providers_id	A numeric vector of length 1 or more, containing the ID(s) of the providers to use for filtering results. If multiple IDs are provided, results matching any of the IDs will be returned.
parameters_id	A numeric vector of length 1 or more, containing the ID(s) of the parameters to use for filtering results. If multiple IDs are provided, results matching any of the IDs will be returned.
order_by	A character string specifying the field to order results by.
sort_order	A character string specifying sort direction, either "asc" or "desc".
limit	An integer specifying the maximum number of results to return, default is 100.
page	An integer specifying the page number for paginated results, default is 1.
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

countries <- list_countries()

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