sec-edgar-downloader 5.1.0

Installation

Install and update this package using pip:

$ pip install -U sec-edgar-downloader

Basic Usage

from sec_edgar_downloader import Downloader

# Initialize a downloader instance. Download filings to the current
# working directory. Must declare company name and email address
# to form a user-agent string that complies with the SEC Edgar's
# programmatic downloading fair access policy.
# More info: https://www.sec.gov/os/webmaster-faq#code-support
# Company name and email are used to form a user-agent of the form:
# User-Agent: <Company Name> <Email Address>
dl = Downloader("MyCompanyName", "my.email@domain.com")

# Get all 8-K filings for Apple (ticker: AAPL)
dl.get("8-K", "AAPL")

# Get all 8-K filings for Apple, including filing amends (8-K/A)
dl.get("8-K", "AAPL", include_amends=True)

# Get all 8-K filings for Apple after January 1, 2017 and before March 25, 2017
# Note: after and before strings must be in the form "YYYY-MM-DD"
dl.get("8-K", "AAPL", after="2017-01-01", before="2017-03-25")

# Get the five most recent 8-K filings for Apple
dl.get("8-K", "AAPL", limit=5)

# Get all 10-K filings for Microsoft
dl.get("10-K", "MSFT")

# Get the latest 10-K filing for Microsoft
dl.get("10-K", "MSFT", limit=1)

# Get all 10-Q filings for Visa
dl.get("10-Q", "V")

# Get all 13F-NT filings for the Vanguard Group
dl.get("13F-NT", "0000102909")

# Get all 13F-HR filings for the Vanguard Group
dl.get("13F-HR", "0000102909")

# Get all SC 13G filings for Apple
dl.get("SC 13G", "AAPL")

# Get all SD filings for Apple
dl.get("SD", "AAPL")

Advanced Usage

from sec_edgar_downloader import Downloader

# Download filings to the current working directory
dl = Downloader("MyCompanyName", "my.email@domain.com", "/path/to/save/location")

# Get all 10-K filings for Microsoft without the filing details
dl.get("10-K", "MSFT", download_details=False)

# Get the latest supported filings, if available, for Apple
for filing_type in dl.supported_filings:
    dl.get(filing_type, "AAPL", limit=1)

# Get the latest supported filings, if available, for a
# specified list of tickers and CIKs
equity_ids = ["AAPL", "MSFT", "0000102909", "V", "FB"]
for equity_id in equity_ids:
    for filing_type in dl.supported_filings:
        dl.get(filing_type, equity_id, limit=1)

Development

In order to validate local code changes before creating a pull request, you can run the following commands:

# Run unit test suite on all locally-installed Python versions
$ tox

# Run unit test suite on a single Python version (e.g. Python 3.11)
$ tox -e py311

# Run end-to-end integration tests
$ tox -e integration

# Lint
$ tox -e lint

# Validate documentation
$ tox -e docs

Release

In order to create a new release, complete the following steps:

1. Outline changes made in the new release in CHANGELOG.md.

2. Bump the version in _version.py and push change to master branch.

3. Ensure all unit and integration tests pass locally and in the GitHub Actions testing workflow.

4. Create and push tags for the latest version specified in _version.py by running make tag.

5. Once the tag is pushed, a GitHub Actions release workflow will be kicked off that automatically creates the package artifacts and uploads them to PyPI.

6. Create a new version based off of the published tag on the GitHub repository’s release page.