Repository files navigation

• Author/Maintainer:Micah J Waldstein
• License:MIT

edgarWebR provides an interface to access theSEC’s EDGARsystem for companyfinancial filings.

edgarWebR doesnot provide any functionality to extract financial dataor other information from filings, only the metadata and companyinformation. For processing of the financial data.

Because of abusive use of this library, the SEC is likely to block itsuse “as is” without setting a custom ‘User Agent’ identifier. Detailsfor setting a custom agent are below.

Users of this library are required to follow the SEC’sPrivacy andSecurity Policy. Failure tofollow that guidance may result in having your requests blocked. Per theSEC’sDeveloper Resources:

To ensure that everyone has equitable access to SEC EDGAR content,please use efficient scripting, downloading only what you need andplease moderate requests to minimize server load. Current guidelineslimit each user to a total of no more than 10 requests per second,regardless of the number of machines used to submit requests.

To ensure that SEC.gov remains available to all users, we reserve theright to block IP addresses that submit excessive requests. The SECdoes not allow “unclassified” bots or automated tools to crawl thesite. Any request that has been identified as part of an unclassifiedbot or an automated tool outside of the acceptable policy will bemanaged to ensure fair access for all users.

Users of this library are advised to set a custom user-agent by settingthe environment variableEDGARWEBR_USER_AGENT.

The EDGAR System provides a number oftools for filing andentity lookup and examination. As of v1.0, edgarWebR supports all publicsearch and browse interfaces.

Search Interfaces:

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

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

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

• parse_submission() - takes a full submission SGML document andparses out component documents. Most of the time, the documents ofinterest in a particular submission will be online and accessibleviafiling_documents() - this function is to unpack the rawsubmission to get all the documents. You may also find it moreefficient if you’re regularly downloading all of the files in agiven submission.
• parse_filing() - Takes a HTML narrative filing and annotates eachparagraph with item and part numbers.

There is one dataset provided with edgarWebR -sic_codes, providing acatalog of SIC codes and their hierarchy.

There are also a number of utility functions to help construct usefulURL’s once you have a company CIK, submission accession number orspecific file.

• company_href() for linking to the company page
• submission_index_href() and its family of related functions forlinking to a specific submission and file.

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")

company_filings("AAPL",type="10-K",count=10)#>        accession_number act file_number filing_date accepted_date#> 1  0000320193-19-000119  34   001-36743  2019-10-31    2019-10-30#> 2  0000320193-18-000145  34   001-36743  2018-11-05    2018-11-05#> 3  0000320193-17-000070  34   001-36743  2017-11-03    2017-11-03#> 4  0001628280-16-020309  34   001-36743  2016-10-26    2016-10-26#> 5  0001193125-15-356351  34   001-36743  2015-10-28    2015-10-28#> 6  0001193125-14-383437  34   000-10030  2014-10-27    2014-10-27#> 7  0001193125-13-416534  34   000-10030  2013-10-30    2013-10-29#> 8  0001193125-12-444068  34   000-10030  2012-10-31    2012-10-31#> 9  0001193125-11-282113  34   000-10030  2011-10-26    2011-10-26#> 10 0001193125-10-238044  34   000-10030  2010-10-27    2010-10-27#>                                                                                                href#> 1  https://www.sec.gov/Archives/edgar/data/320193/000032019319000119/0000320193-19-000119-index.htm#> 2  https://www.sec.gov/Archives/edgar/data/320193/000032019318000145/0000320193-18-000145-index.htm#> 3  https://www.sec.gov/Archives/edgar/data/320193/000032019317000070/0000320193-17-000070-index.htm#> 4  https://www.sec.gov/Archives/edgar/data/320193/000162828016020309/0001628280-16-020309-index.htm#> 5  https://www.sec.gov/Archives/edgar/data/320193/000119312515356351/0001193125-15-356351-index.htm#> 6  https://www.sec.gov/Archives/edgar/data/320193/000119312514383437/0001193125-14-383437-index.htm#> 7  https://www.sec.gov/Archives/edgar/data/320193/000119312513416534/0001193125-13-416534-index.htm#> 8  https://www.sec.gov/Archives/edgar/data/320193/000119312512444068/0001193125-12-444068-index.htm#> 9  https://www.sec.gov/Archives/edgar/data/320193/000119312511282113/0001193125-11-282113-index.htm#> 10 https://www.sec.gov/Archives/edgar/data/320193/000119312510238044/0001193125-10-238044-index.htm#>    type film_number                                              form_name#> 1  10-K   191181423 Annual report [Section 13 and 15(d), not S-K Item 405]#> 2  10-K   181158788 Annual report [Section 13 and 15(d), not S-K Item 405]#> 3  10-K   171174673 Annual report [Section 13 and 15(d), not S-K Item 405]#> 4  10-K   161953070 Annual report [Section 13 and 15(d), not S-K Item 405]#> 5  10-K   151180619 Annual report [Section 13 and 15(d), not S-K Item 405]#> 6  10-K   141175110 Annual report [Section 13 and 15(d), not S-K Item 405]#> 7  10-K   131177575 Annual report [Section 13 and 15(d), not S-K Item 405]#> 8  10-K   121171452 Annual report [Section 13 and 15(d), not S-K Item 405]#> 9  10-K   111159350 Annual report [Section 13 and 15(d), not S-K Item 405]#> 10 10-K   101145250 Annual report [Section 13 and 15(d), not S-K Item 405]#>    description  size#> 1         <NA> 12 MB#> 2         <NA> 12 MB#> 3         <NA> 14 MB#> 4         <NA> 13 MB#> 5         <NA>  9 MB#> 6         <NA> 12 MB#> 7         <NA> 11 MB#> 8         <NA>  9 MB#> 9         <NA>  9 MB#> 10        <NA> 13 MB

• XBRL - Low levelextration of data from XBRL financial files
• finstr - Process XBRL toextract data, combine periods, and make basic financial calulations.
• finreportr - All inone to pull finnacials and information from EDGAR

Please note that this project is released with aContributor Code ofConduct. Byparticipating in this project you agree to abide by its terms. Reportviolations to (micah@waldste.in).