query: query

In steveputman/renverus: API Wrapper for Enverus

Description

Query for the v2 API

Usage

query(
  dataset,
  output = "df",
  manretry = 2,
  api_key = NULL,
  access_token = NULL,
  pagesize = 10000,
  ...
)

Arguments

dataset	A valid Enverus DirectAccess v2 API dataset as a string. For a complete list of datasets, see Enverus API
output	A string indicating the type of output returned by the query: df attempts to convert the query response into a tibble (the default). json returns a raw list of lists
manretry	Number of retries for user-related errors (authentication, query parameters, etc.)
api_key	A valid Enverus DirectAccess v2 API key as a string. If a key is not provided, the query will attempt to use the ENVERUS_API_KEY environment variable.
access_token	A temporary token, as a string, authenticating the user. If a token is not supplied, the query will attempt to authenticate the user with the ENVERUS_CLIENT_ID and ENVERUS_CLIENT_SECRET environment variables. See get_access_token()
pagesize	Number of items per page received. Defaults to 10,000.
...	A named list of query filters, such as deleteddate = "null" to be passed to the query. See the Enverus API

steveputman/renverus documentation built on Dec. 23, 2021, 5:34 a.m.