set_api_key: Set the API authorization key

Description Usage Arguments Value Examples

View source: R/set_api_key.R

Description

This function creates an R environment variable called fannieapi_key, which is used by subsequent functions to make API calls.

Usage

1
set_api_key(api_key)

Arguments

api_key

The API key or user token as a character. This can be obtained by from your account profile at https://developer.theexchange.fanniemae.com/.

Value

Invisibly returns the the R environment variable fannieapi_key, which is set as the api_key parameter in this function.

Examples

1
2
set_api_key("abc123")
Sys.getenv("fannieapi_key")

saadaslam/fannieapi documentation built on May 16, 2019, 9:11 p.m.