I recently realized that edgarWebR 1.0 was released a while ago without much fanfare. 1.0 is a major milestone for the library, bringing the full set of (initial) planned functionality along with some bonus features.
- 100% coverage of SEC search tools.
- Parsing of submissions into component files and 10-x filings into items and parts.
- A dataset of SIC mappings
- Bugfixes - corner cases keep popping up that need fixing
- Parsing Improvements - I have some ideas about table handling that will help anyone interested in getting data out of older filings
The EDGAR System provides a number of tools for filing and entity lookup and examination. As of v1.0, edgarWebR supports all public search and browse interfaces.
|Fund Voting Records||https://www.sec.gov/edgar/searchedgar/n-px.htm||Use
|Var. Insurance Products||https://www.sec.gov/edgar/searchedgar/vinsurancesearch.html||
|Confidential treatment orders||https://www.sec.gov/edgar/searchedgar/ctorders.htm||Use
Once a filing is found via any of the above, there are a number of functions to process the result -
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 component 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 documents. 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.
There is one dataset provided with edgarWebR,
sic_codes, providing a catalog of SIC codes and their hierarchy.
There are also a number of utility functions to help construct useful URL’s once you have a company CIK, submission accession number or specific file.
company_href()for linking to the company page
submission_index_href()and its family of related functions for linking to a specific submission and file.
edgarWebR is available from CRAN, so can be simply installed via
To install the development version,
# Install the development version from GitHub: # install.packages("devtools") devtools::install_github("mwaldstein/edgarWebR")
If you’ve found this package helpful, contributions are always appreciated at the page on github:
- Bug Reports
- Code improvements
I’m also always excited to hear about how the package is being used. If this package has helped you in any way, drop me a note!