Make a GET call to API

rcax_GET(path, key = NULL, query = NULL, ...)

Arguments

path: what to add after the base api path
key: A CAX API key. See details.
query: a list of query parameters with their values, e.g. list(param=value)
...: Curl options passed to HttpClient

Details

API Key: rCAX includes a "read-only" API key. Thus for normal read-only use, you do not need an API key. If you need to use your own key, see the instructions in vignette("api_get", package = "rCAX").

User Agent String: rcax_ua() sets the user agent string that is passed to the CAX REST API. If the rCAX package code is reused (for another package), make sure to change the user agent string to indicate that the queries are from another package.

References

API docs at https://www.streamnet.org/resources/exchange-tools/rest-api-documentation/

This function is modeled off rl_GET() in https://github.com/ropensci/rredlist

Examples

if (FALSE) {
rcax_GET("ca/tables")
}