Skip to content

Version 4.0.0
Compare
Choose a tag to compare
@jadchaar jadchaar released this 18 Jan 04:27
· 40 commits to master since this release
4.0.0
f950221
This commit was created on github.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

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.

Added

  • 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 query kwarg:
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 txt file. 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.
  • Path objects can now be used to specify a download_folder when constructing a Downloader object.
  • Added type annotations throughout the codebase.

Changed

  • The current working directory is now used as the default download location. Custom paths can be specified when constructing Downloader objects.
  • All arguments passed to dl.get() other than filing and ticker_or_cik must 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, and num_filings_to_download kwargs have been renamed to after, before, and amount, respectively.
Assets 2
Loading