https://github.com/sec-edgar/sec-edgar

Download all companies periodic reports, filings and forms from EDGAR database.
https://github.com/sec-edgar/sec-edgar

cik edgar edgar-crawler edgar-database finance financials python sec

Last synced: 10 days ago
JSON representation

Download all companies periodic reports, filings and forms from EDGAR database.

• Host: GitHub
• URL: https://github.com/sec-edgar/sec-edgar
• Owner: sec-edgar
• License: apache-2.0
• Created: 2013-11-27T21:27:22.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2024-04-04T19:23:32.000Z (7 months ago)
• Last Synced: 2024-05-01T16:16:09.321Z (7 months ago)
• Topics: cik, edgar, edgar-crawler, edgar-database, finance, financials, python, sec
• Language: Python
• Homepage: https://sec-edgar.github.io/sec-edgar/
• Size: 14 MB
• Stars: 956
• Watchers: 36
• Forks: 274
• Open Issues: 29
• Metadata Files:
  • Readme: README.rst
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
sec-edgar

=========

|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:

.. code:: bash

   $ pip install secedgar

OR

You can clone the project:

.. code:: bash

   $ git clone https://github.com/sec-edgar/sec-edgar.git

   $ cd sec-edgar

   $ python setup.py install

Running

-------

Company Filings

~~~~~~~~~~~~~~~

Single Company

^^^^^^^^^^^^^^

.. code:: python

    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

^^^^^^^^^^^^^^^^^^

.. code:: python

    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

~~~~~~~~~~~~~

.. code:: python

    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 `_.

.. |Tests Status| image:: https://github.com/sec-edgar/sec-edgar/actions/workflows/test.yml/badge.svg

   :target: https://github.com/sec-edgar/sec-edgar/actions/workflows/test.yml

.. |Docs Status| image:: https://github.com/sec-edgar/sec-edgar/actions/workflows/docs.yml/badge.svg

   :target: https://github.com/sec-edgar/sec-edgar/actions/workflows/docs.yml