Skip to main content

SEC-Edgar implements a basic crawler for downloading

Project description

Tests Status Docs Status

Getting filings of various companies at once is really a pain, but SEC-Edgar does that for you. You can download all of a company’s periodic reports, filings and forms from the EDGAR database with a single command.

Installation

You can install the package using pip:

$ pip install secedgar

OR

You can clone the project:

$ git clone https://github.com/sec-edgar/sec-edgar.git
$ cd sec-edgar
$ python setup.py install

Running

Company Filings

Single Company

from secedgar import filings, FilingType

# 10Q filings for Apple (ticker "aapl")
my_filings = filings(cik_lookup="aapl",
                     filing_type=FilingType.FILING_10Q,
                     user_agent="Your name (your email)")
my_filings.save('/path/to/dir')

Multiple Companies

from secedgar import filings, FilingType

# 10Q filings for Apple and Facebook (tickers "aapl" and "fb")
my_filings = filings(cik_lookup=["aapl", "fb"],
                     filing_type=FilingType.FILING_10Q,
                     user_agent="Your name (your email)")
my_filings.save('/path/to/dir')

Daily Filings

from secedgar import filings
from datetime import date

daily_filings = filings(start_date=date(2021, 6, 30),
                        user_agent="Your name (your email)")
daily_urls = daily_filings.get_urls()

Supported Methods

Currently this crawler supports many different filing types. To see the full list, please refer to the docs. If you don’t see a filing type you would like to be supported, please create an issue on GitHub.

Documentation

To learn more about the APIs and latest changes in the project, read the official documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

secedgar-0.6.0a0.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

secedgar-0.6.0a0-py3-none-any.whl (62.5 kB view details)

Uploaded Python 3

File details

Details for the file secedgar-0.6.0a0.tar.gz.

File metadata

  • Download URL: secedgar-0.6.0a0.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for secedgar-0.6.0a0.tar.gz
Algorithm Hash digest
SHA256 df027639768e028b35666082b0ed7bbb4e4f47104b3379732097b52ddf54c12a
MD5 fca2fdbdcfc1b6e4e0cbae2578061ef5
BLAKE2b-256 ddbfd2f8776a715e232886cf887a4a0532cc8960eec2b8fb84a6ede984bdcaf8

See more details on using hashes here.

File details

Details for the file secedgar-0.6.0a0-py3-none-any.whl.

File metadata

  • Download URL: secedgar-0.6.0a0-py3-none-any.whl
  • Upload date:
  • Size: 62.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for secedgar-0.6.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 42c38c0baf36a8800d1f18e80ef56228e2d6d910c5b29ea7209e411357242b32
MD5 e2ba6fa1e27f0e265c05524b7de324fa
BLAKE2b-256 82baba0542700fb7e8a9ed7109a8911498dbf4b6f42a01a0e52976c6fb8ecaa9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page