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.5.0.tar.gz (1.1 MB view details)

Uploaded Source

Built Distributions

secedgar-0.5.0-py3.11.egg (194.6 kB view details)

Uploaded Source

secedgar-0.5.0-py3-none-any.whl (67.1 kB view details)

Uploaded Python 3

File details

Details for the file secedgar-0.5.0.tar.gz.

File metadata

  • Download URL: secedgar-0.5.0.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for secedgar-0.5.0.tar.gz
Algorithm Hash digest
SHA256 e56e5f5c851519ae563d50cc88d5bcd26b635353d5a9cf60d785593201d33d5f
MD5 f1d3e5d613534578fee86b9776333f3f
BLAKE2b-256 b6cf3b40daff20bb01d812ed864226738fe8aa3f3ce306128fe2c313221823c1

See more details on using hashes here.

File details

Details for the file secedgar-0.5.0-py3.11.egg.

File metadata

  • Download URL: secedgar-0.5.0-py3.11.egg
  • Upload date:
  • Size: 194.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for secedgar-0.5.0-py3.11.egg
Algorithm Hash digest
SHA256 e9050faf57ad31cfaa365fd3a2da166002d2eafcf647ac426776305210b2a067
MD5 aa9b2892e36d67a222d646d15f6bf874
BLAKE2b-256 d31aeccba828807e06a769b78ccb9ebde3c87032c25e52deba59611ff4c4c826

See more details on using hashes here.

File details

Details for the file secedgar-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: secedgar-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 67.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for secedgar-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8447ecea53c11bc3fe6920304b8392d96bfda87688ed0449e63e8f6f85e5d373
MD5 577d59d5537db8d30e9c98caae37ffdf
BLAKE2b-256 1926fb65e99c00113a927db436ff30c9c28c0cdac276af5698a777fde501ac79

See more details on using hashes here.

Supported by

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