- Downloads will no longer halt prematurely if a filing document (full or detail) cannot be found (e.g. when the EDGAR Search API outputs incorrect download URLs). Now, the package will automatically catch such network errors, print a helpful warning message, and then proceed to download the remaining filings.
This is a major breaking release. Please see the v4 migration guide for information on how to upgrade and adapt your existing codebase to the new package version.
- The SEC Edgar Full-Text Search API is now used to fetch filing download URLs. This approach replaces the existing fragile scraping and ATOM RSS implementation used in existing versions of this package.
- Note: this API only allows for fetching filings after December 1, 2000.
- Added support for searching and downloading filings via a
querykwarg:
dl = Downloader()
# Download all Apple proxy statements that contain the word "antitrust"
dl.get("DEF 14A", "AAPL", query="antitrust")- Filing details, whose extensions vary based on filing type, are now downloaded in addition to the full submission
txtfile. See the migration guide for information on the revamped folder structure. - Added the ability to download all available SEC filings. Please see the README for a full list of all supported filings.
Pathobjects can now be used to specify adownload_folderwhen constructing aDownloaderobject.- Added type annotations throughout the codebase.
- The current working directory is now used as the default download location. Custom paths can be specified when constructing
Downloaderobjects. - All arguments passed to
dl.get()other thanfilingandticker_or_cikmust be used with a keyword:
dl = Downloader()
dl.get(
"10-K",
"AAPL",
# All other arguments must be used with a keyword
amount=1,
after="2019-01-01",
before="2021-01-01",
include_amends=True,
download_details=True,
query="sample query"
)- The
after_date,before_date, andnum_filings_to_downloadkwargs have been renamed toafter,before, andamount, respectively.
- Added support for DEF 14A filings (proxy statements).
- Added
tox.iniandMakefileto distribution package.
- Fixed a failing test in the distributed package due to missing sample filings test data.
- Added support for 20-F filings.
- Added support for form 4 filings.
- Added a 0.15s delay to download logic in order to prevent rate-limiting by SEC Edgar.
- Added support for S-1 filings.
- Added the ability to download more than 100 filings.
- Added the ability to specify an
after_dateargument to thegetmethod. Example usage:
from sec_edgar_downloader import Downloader
dl = Downloader()
# Get all 8-K filings for Apple after January 1, 2017 and before March 25, 2017
dl.get("8-K", "AAPL", after_date="20170101", before_date="20170325")- Added a
supported_filingsproperty to theDownloaderclass, which gets a list of all filings supported by thesec_edgar_downloaderpackage. Example usage:
from sec_edgar_downloader import Downloader
dl = Downloader()
dl.supported_filings- Package has been completely re-written from the ground up.
- The
Downloaderclass now has a singlegetentry point method. This change was made to improve and ease maintainability. Here is the new stub for thegetmethod:
class Downloader:
def get(
self,
filing_type,
ticker_or_cik,
num_filings_to_download=None,
after_date=None,
before_date=None,
include_amends=False
)Example usage of the new method:
from sec_edgar_downloader import Downloader
dl = Downloader()
# Get all 8-K filings for Apple
dl.get("8-K", "AAPL")- Replaced retrieval methods for each filing type with a single point of entry. The bulk method
get_all_available_filingshas also been removed, so any bulk actions need to be completed manually as follows:
# Get the latest supported filings, if available, for Apple
for filing_type in dl.supported_filings:
dl.get(filing_type, "AAPL", 1)
# Get the latest supported filings, if available, for a
# specified list of tickers and CIKs
symbols = ["AAPL", "MSFT", "0000102909", "V", "FB"]
for s in symbols:
for filing_type in dl.supported_filings:
dl.get(filing_type, s, 1)- Added support for form 10KSB.
- Added docs and tests to PyPI distribution package.
- Locked the
requestsdependency tov2.22.0or greater to ensure optimal performance and compatibility.
sec-edgar-downloaderis now fully documented 🎉. You can view the latest documentation at sec-edgar-downloader.readthedocs.io.- Changed file encoding for filing downloads from
utf-8toascii. This switch was made because SEC filings should be submitted in ASCII format. - Locked the
lxmldependency tov4.3.4or greater to fix Python 3.8 install issues.
- Added
before_dateparameter to each filing download method. If this value is not specified, it will default to the current date. - Added
include_amendsparameter to each filing download method. If this value is not specified, it will default to false. - Added support for passing relative (e.g.
./,../) and user (e.g.~/) download paths to theDownloaderconstructor - An
IOErroris no longer thrown when an invalid download path is passed to theDownloaderconstructor. Instead,sec_edgar_downloaderwill create all the necessary directories in the path if they do not exist. - Filing documents are no longer downloaded in streamed chunks.
- Downloads are now written to disk with UTF-8 encoding.
- Added
__version__variable to package. - Travis CI now uses tox to lint and run tests.
- Added
verboseflag toDownloaderconstructor to enable information printing (e.g. how many filings are found and downloaded).verbosewill default to false, meaning that no download information will be printed by default.
- Cleaned up README
- Tweaked package naming in setup.py
- The method for obtaining 13F filings has been split up into two methods: one for obtaining 13F-NT filings and another one for obtaining 13F-HR filings
- You can read about the differences here
- You can now specify the number of filings to download in the
get_all_available_filingsmethod - Simplified API by combining ticker and CIK functionality into a single method for each filing type
- Available methods:
get_8k_filings,get_10k_filings,get_10q_filings,get_13f_nt_filings,get_13f_hr_filings,get_sc_13g_filings,get_sd_filings,get_all_available_filings - All these methods can be passed either a CIK or ticker string
- Available methods:
- Removed ticker validation to facilitate this simplified API change
- Added a full suite of unit and integration tests along with an internal Travis CI pipeline for increased reliability
- Class methods now return the number of filings downloaded
- Added Python 3.8 support
- Added the ability to specify the number of filings to download
- For example, you can download the latest 10-K for MSFT with this command:
downloader.get_10k_filing_for_ticker("MSFT", 1) - This is available for all non-bulk methods:
get_8k_filing_for_ticker,get_10k_filing_for_ticker,get_10q_filing_for_ticker,get_13f_filing_for_ticker,get_sc_13g_filing_for_ticker,get_sd_filing_for_ticker, and the CIK equivalents
- For example, you can download the latest 10-K for MSFT with this command:
- Internal renaming changes
- Reduced size of ticker validation data by changing an internal data structure
- Fixed the "FileNotFoundError" on import
- Tweaked PyPI description
- Filing downloads are now handled in chunks to improve download and save speed
- Removed get_select_filings_for_ticker() to reduce redundancy
- Added support for SC 13G filings
- Separated ticker and CIK class methods for easier use
- Added ticker symbol validation
- Files now save as ".txt" rather than ".html"
- Initial release