Learn R Programming

lumendb (version 0.2.1)

lumenHTTP: Lumen Database HTTP Requests

Description

This is the workhorse function for executing API requests for the Lumen Database.

Usage

lumenHTTP(verb = "GET", path = "", query = list(), body = "", base = "https://lumendatabase.org", token = Sys.getenv("LUMEN_TOKEN"), ...)

Arguments

verb
A character string containing an HTTP verb, defaulting to “GET”.
path
A character string with the API endpoint (should begin with a slash).
query
A list specifying any query string arguments to pass to the API.
body
A character string of request body data.
base
A character string specifying the base URL for the API.
token
A character string containing a Lumen Database API token. If missing, defaults to value stored in environment variable LUMEN_TOKEN.
...
Additional arguments passed to an HTTP request function, such as GET.

Value

A list.

Details

This is mostly an internal function for executing API requests. In almost all cases, users do not need to access this directly.