ipbase_api_key {ipbase}

Ipbase API Key

Description

ipbase.com requires authentication via an API key. For this package, the API key is saved as a environmental variable. In interactive mode, using ipbase_api_key will require you to enter an API key. Alternatively, you can also use Sys.setenv(IPBASE_API_KEY = <key>) to set the API key manually.

Usage

ipbase_api_key(force = FALSE)

Arguments

force

If TRUE, resets the API key & requires the user to provide a new API key. If FALSE and an API key already exists, the key will be printed to the console. If no key exists, you will be required to enter a key. force. Defaults to FALSE.

Value

Returns the set API key that has been stored as an enviroment variable.