Skip to contents

Fetches API credentials from environment variables or explicit arguments. Required environment variables: KC-API-KEY, KC-API-SECRET, KC-API-PASSPHRASE.

Usage

get_api_keys(
  api_key = Sys.getenv("KC-API-KEY"),
  api_secret = Sys.getenv("KC-API-SECRET"),
  api_passphrase = Sys.getenv("KC-API-PASSPHRASE"),
  key_version = "2"
)

Arguments

api_key

Character string; KuCoin API key. Defaults to Sys.getenv("KC-API-KEY").

api_secret

Character string; KuCoin API secret. Defaults to Sys.getenv("KC-API-SECRET").

api_passphrase

Character string; KuCoin API passphrase. Defaults to Sys.getenv("KC-API-PASSPHRASE").

key_version

Character string; API key version. Defaults to "2".

Value

Named list with api_key, api_secret, api_passphrase, key_version.

Examples

if (FALSE) { # \dontrun{
keys <- get_api_keys()
keys <- get_api_keys(api_key = "my_key", api_secret = "my_secret", api_passphrase = "my_pass")
} # }