getXBRL: Fetch a list of XBRLs

Description Usage Arguments Details Value Examples

View source: R/getXBRL.R

Description

Fetches the XBRLs of the tickers specified from the SEC's EDGAR.

Usage

1
2
3
4
5
6
7
8
9
getXBRL(
  tickers = NULL,
  type = "10-Q",
  count = 1,
  until = NULL,
  force.new = FALSE,
  xbrl.cache = "xbrl.Cache",
  xbrl.rds.cache = "xbrl.rds.Cache"
)

Arguments

tickers

A ticker character value or vector

type

Defaults to 10-Q. Type of filling like 10-Q or 10-K

count

Number of maximum filings. If until parameter is set, the number of filings returned could be less.

until

yyyymmdd fillings are downloaded starting from the until parameter until the oldest, or until it reaches the count limit.

force.new

Defaults to FALSE. If TRUE.

xbrl.cache

Folder where XBRL taxonomies are saved. If null then it wont save cache.

xbrl.rds.cache

Folder where XBRL lists are saved as .rds If null, it wont save cache.

Details

This function will fetch the XBRL documents of the specified tickers. It will return a list of XBRL list. Each XBRL list contains the data.frames returned by the library XBRL. Each ticker XBRL from a data are cached as a .rds in the folder xbrl.rds.Cache. All XBRL taxonomies are cached in the folder xbrl.Cache. These behaviors can be modified using parameters. If any ticker doesn´t exist, it will be dropped. It´s recomended to check if the length of the tickers is equal to the returned list.

Value

List with ticker names which have lists of data.frames, formated as XBRL

Examples

1
getXBRL(c("AAPL", "TSLA", "GE"), type = "10-Q")

kossal/fundfi documentation built on April 6, 2020, 8:41 a.m.