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 <https://sec-edgar.github.io/sec-edgar>`_.
.. |Tests Status| image:: https://github.com/sec-edgar/sec-edgar/workflows/Tests/badge.svg
:target: https://github.com/sec-edgar/sec-edgar/actions?query=workflow%3ATests
.. |Docs Status| image:: https://github.com/sec-edgar/sec-edgar/workflows/Build%20Docs/badge.svg
:target: https://github.com/sec-edgar/sec-edgar/actions?query=workflow%3A%22Build+Docs%22
Raw data
{
"_id": null,
"home_page": "https://github.com/sec-edgar/sec-edgar",
"name": "secedgar",
"maintainer": "Jack Moody",
"docs_url": null,
"requires_python": "",
"maintainer_email": "jacklaytonmoody@gmail.com",
"keywords": "SEC,EDGAR,crawler,filings",
"author": "Rahul Ranjan",
"author_email": "rahul.rrixe@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b6/cf/3b40daff20bb01d812ed864226738fe8aa3f3ce306128fe2c313221823c1/secedgar-0.5.0.tar.gz",
"platform": null,
"description": "sec-edgar\n=========\n\n|Tests Status| |Docs Status|\n\nGetting filings of various companies at once is really a pain, but\nSEC-Edgar does that for you. You can download all of a company\u2019s\nperiodic reports, filings and forms from the EDGAR database with a\nsingle command.\n\nInstallation\n------------\n\nYou can install the package using pip:\n\n.. code:: bash\n\n $ pip install secedgar\n\nOR\n\nYou can clone the project:\n\n.. code:: bash\n\n $ git clone https://github.com/sec-edgar/sec-edgar.git\n $ cd sec-edgar\n $ python setup.py install\n\nRunning\n-------\n\nCompany Filings\n~~~~~~~~~~~~~~~\n\nSingle Company\n^^^^^^^^^^^^^^\n\n.. code:: python\n\n from secedgar import filings, FilingType\n\n # 10Q filings for Apple (ticker \"aapl\")\n my_filings = filings(cik_lookup=\"aapl\",\n filing_type=FilingType.FILING_10Q,\n user_agent=\"Your name (your email)\")\n my_filings.save('/path/to/dir')\n\n\nMultiple Companies\n^^^^^^^^^^^^^^^^^^\n\n.. code:: python\n\n from secedgar import filings, FilingType\n\n # 10Q filings for Apple and Facebook (tickers \"aapl\" and \"fb\")\n my_filings = filings(cik_lookup=[\"aapl\", \"fb\"],\n filing_type=FilingType.FILING_10Q,\n user_agent=\"Your name (your email)\")\n my_filings.save('/path/to/dir')\n\n\nDaily Filings\n~~~~~~~~~~~~~\n\n\n.. code:: python\n\n from secedgar import filings\n from datetime import date\n\n daily_filings = filings(start_date=date(2021, 6, 30),\n user_agent=\"Your name (your email)\")\n daily_urls = daily_filings.get_urls()\n\n\n\nSupported Methods\n-----------------\n\nCurrently 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\nto be supported, please create an issue on GitHub.\n\nDocumentation\n--------------\nTo learn more about the APIs and latest changes in the project, read the `official documentation <https://sec-edgar.github.io/sec-edgar>`_.\n\n\n.. |Tests Status| image:: https://github.com/sec-edgar/sec-edgar/workflows/Tests/badge.svg\n :target: https://github.com/sec-edgar/sec-edgar/actions?query=workflow%3ATests\n.. |Docs Status| image:: https://github.com/sec-edgar/sec-edgar/workflows/Build%20Docs/badge.svg\n :target: https://github.com/sec-edgar/sec-edgar/actions?query=workflow%3A%22Build+Docs%22\n",
"bugtrack_url": null,
"license": "Apache License (2.0)",
"summary": "SEC-Edgar implements a basic crawler for downloading",
"version": "0.5.0",
"split_keywords": [
"sec",
"edgar",
"crawler",
"filings"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "aa9b2892e36d67a222d646d15f6bf874",
"sha256": "e9050faf57ad31cfaa365fd3a2da166002d2eafcf647ac426776305210b2a067"
},
"downloads": -1,
"filename": "secedgar-0.5.0-py3.11.egg",
"has_sig": false,
"md5_digest": "aa9b2892e36d67a222d646d15f6bf874",
"packagetype": "bdist_egg",
"python_version": "0.5.0",
"requires_python": null,
"size": 194616,
"upload_time": "2022-12-12T01:32:46",
"upload_time_iso_8601": "2022-12-12T01:32:46.952340Z",
"url": "https://files.pythonhosted.org/packages/d3/1a/eccba828807e06a769b78ccb9ebde3c87032c25e52deba59611ff4c4c826/secedgar-0.5.0-py3.11.egg",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "577d59d5537db8d30e9c98caae37ffdf",
"sha256": "8447ecea53c11bc3fe6920304b8392d96bfda87688ed0449e63e8f6f85e5d373"
},
"downloads": -1,
"filename": "secedgar-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "577d59d5537db8d30e9c98caae37ffdf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 67094,
"upload_time": "2022-12-12T01:32:44",
"upload_time_iso_8601": "2022-12-12T01:32:44.954468Z",
"url": "https://files.pythonhosted.org/packages/19/26/fb65e99c00113a927db436ff30c9c28c0cdac276af5698a777fde501ac79/secedgar-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "f1d3e5d613534578fee86b9776333f3f",
"sha256": "e56e5f5c851519ae563d50cc88d5bcd26b635353d5a9cf60d785593201d33d5f"
},
"downloads": -1,
"filename": "secedgar-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "f1d3e5d613534578fee86b9776333f3f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1143421,
"upload_time": "2022-12-12T01:32:49",
"upload_time_iso_8601": "2022-12-12T01:32:49.082575Z",
"url": "https://files.pythonhosted.org/packages/b6/cf/3b40daff20bb01d812ed864226738fe8aa3f3ce306128fe2c313221823c1/secedgar-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-12 01:32:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "sec-edgar",
"github_project": "sec-edgar",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "beautifulsoup4",
"specs": []
},
{
"name": "aiohttp",
"specs": []
},
{
"name": "async_timeout",
"specs": [
[
">=",
"3.0"
],
[
"<",
"4.0"
]
]
},
{
"name": "urllib3",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "lxml",
"specs": []
},
{
"name": "tqdm",
"specs": []
}
],
"lcname": "secedgar"
}
JSON
