Skip to contents

CFBD API Key Endpoint Overview

Source: R/cfbd_api_key.R
cfbd_api_key.Rd

  • cfbd_api_key_info(): Get information about your API key, including your Patreon level and usage limits.

  • register_cfbd: How to save your API key as the CFBD_API_KEY environment variable, with Sys.setenv(CFBD_API_KEY = "...") for one session or a line in ~/.Renviron for every session. register_cfbd is a help page, not a function.

  • cfbd_key(): Retrieve the CFBD API key from the CFBD_API_KEY environment variable.

  • has_cfbd_key(): Check whether a CFBD API key is registered in the current session.

Details

Get information about your CFBD API key

cfbd_api_key_info()

Register / save your CFBD API key

Sys.setenv(CFBD_API_KEY = "YOUR-API-KEY-HERE")

Retrieve the CFBD API key

cfbd_key()

Check whether a CFBD API key is registered

has_cfbd_key()