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

If you are using Jupyter Notebook, you’ll need to install and configure nest-asyncio:

pip install nest-asyncio

Then add the following code at the start of your notebook:

import nest_asyncio
nest_asyncio.apply()

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for secedgar-0.6.0.tar.gz
Algorithm Hash digest
SHA256 c5efbe03a128995a6c69bd53bacbc8ac574c2df890898b0187591209b9eaea0d
MD5 b9738c239b9b7879523b0bfbbf163ee5
BLAKE2b-256 caed0629ff4cfa94489058536abbe44fad5d82183c9ec0421663d3a6706eed2e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for secedgar-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 14f6735923aaddaab5e933394bb4251e61836bfac12fa659edb85f86e8990e5c
MD5 6226cf96652b383bbe820c8b07acd47d
BLAKE2b-256 846797f105c4f98bb89d42fdc822d5032d45895874bd20208a368a9f40bc6a84

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