SEC Filings Access

A set of methods to access and parse live filing information from the U.S. Securities and Exchange Commission (SEC - < https://sec.gov>) including company and fund filings along with all associated metadata.


CRAN_Status_Badge Travis-CI Build Status AppVeyor Build Status codecov.io

Introduction

edgarWebR provides an interface to access the SEC's EDGAR system for company financial filings.

EdgarWebR does not provide any functionality to extract financial data or other information from filings, only the metadata and company information. For processing of the financia data.

EDGAR Tools

The EDGAR System provides a number of tools for filing and entity lookup and examination. edgarWebR will eventually support all of the provided tools, but for now it is focused on covering company and fund search and resultant filings.

Search Interfaces:

Tool URL edgarWebR function(s)
Company https://www.sec.gov/edgar/searchedgar/companysearch.html company_information(), company_details(), company_filings()
Recent Filings https://www.sec.gov/cgi-bin/browse-edgar?action=getcurrent latest_filings()
Full Text http://searchwww.sec.gov/EDGARFSClient/jsp/EDGAR_MainAccess.jsp full_text()
Header Search https://www.sec.gov/cgi-bin/srch-edgar header_search()
Fund Disclosures https://www.sec.gov/edgar/searchedgar/prospectus.htm N/A
Fund Voting Records https://www.sec.gov/edgar/searchedgar/n-px.htm N/A
Fund Search https://www.sec.gov/edgar/searchedgar/mutualsearch.html fund_search()
Var. Insurance Products https://www.sec.gov/edgar/searchedgar/vinsurancesearch.html N/A
Confidential treatment orders https://www.sec.gov/edgar/searchedgar/ctorders.htm N/A
Effectiveness notices https://www.sec.gov/cgi-bin/browse-edgar?action=geteffect N/A
CIK https://www.sec.gov/edgar/searchedgar/cik.htm N/A
Daily Filings https://www.sec.gov/edgar/searchedgar/currentevents.htm N/A
Correspondence https://www.sec.gov/answers/edgarletters.htm N/A

Once a filing is found via any of the above, there are a number of functions to process the result -

  • filing_documents()
  • filing_filers()
  • filing_funds()
  • filing_information()
  • filing_details() - returns all 4 of the filing components in a list.

While edgarWebR is primarily focused on providing an interface to the online SEC tools, there are a few activities for handling filing documents for which no current tools exist.

  • parse_submission() - takes a full submission SGML document and parses out compontent documents. Most of the time, the documents of interest in a particular submission will be online and accessible via filing_documents() - this function is to unpack the raw submission to get all the doucments. You may also find it more efficient if you're regularly downloading all of the files in a given submission.
  • parse_filing() - Takes a HTML narrative filing and annotates each paragraph with item and part numbers.

Installation

edgarWebR is available from CRAN, so can be simply installed via

install.packages("edgarWebR")

To install the development version,

# Install the development version from GitHub:
# install.packages("devtools")
devtools::install_github("mwaldstein/edgarWebR")

Example

company_filings("AAPL", type = "10-K", count = 10)
#>        accession_number act file_number filing_date accepted_date
#> 1  0000320193-17-000070  34   001-36743  2017-11-03    2017-11-03
#> 2  0001628280-16-020309  34   001-36743  2016-10-26    2016-10-26
#>                                                                                                href
#> 1  https://www.sec.gov/Archives/edgar/data/320193/000032019317000070/0000320193-17-000070-index.htm
#> 2  https://www.sec.gov/Archives/edgar/data/320193/000162828016020309/0001628280-16-020309-index.htm
#>      type film_number
#> 1    10-K   171174673
#> 2    10-K   161953070
#>                                                 form_name description
#> 1  Annual report [Section 13 and 15(d), not S-K Item 405]        <NA>
#> 2  Annual report [Section 13 and 15(d), not S-K Item 405]        <NA>
#>     size
#> 1  14 MB
#> 2  13 MB
#>  [ reached getOption("max.print") -- omitted 8 rows ]

Related Packages

  • XBRL - Low level extration of data from XBRL financial files
  • finstr - Process XBRL to extract data, combine periods, and make basic financial calulations.
  • finreportr - All in one to pull finnacials and information from EDGAR

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Report violations to ([email protected]).

News

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("edgarWebR")

0.3.1 by Micah J Waldstein, 3 months ago


https://mwaldstein.github.io/edgarWebR, https://github.com/mwaldstein/edgarWebR


Report a bug at https://github.com/mwaldstein/edgarWebR/issues


Browse source code at https://github.com/cran/edgarWebR


Authors: Micah J Waldstein [aut, cre]


Documentation:   PDF Manual  


MIT + file LICENSE license


Imports xml2, methods, httr

Suggests covr, ggplot2, knitr, purrr, rmarkdown, httptest, devtools, dplyr, tidyr, roxygen2


See at CRAN