xbrlus-package: xbrlus: Interface to XBRL US API

Description Details References

Description

This package provides an interface to XBRL US API.

Details

All APIs (except for the CIKLookup) require use of a valid XBRL US API key. You can get the key and read the terms of usage at http://xbrl.us/use/howto/data-analysis-toolkit/.

xbrlus functions will read the API key from environment variable XBRLUS_API_KEY. To start R session with the initialized environvent variable create an .Renviron file in your R home with a line like this:

XBRLUS_API_KEY=************

To check where your R home is, try normalizePath("~").

References


bergant/xbrlus documentation built on May 12, 2019, 3:06 p.m.