EDGAR-CRAWLER

Crawl and fetch all publicly-traded companies annual reports from SEC's EDGAR database.

edgar-crawler is an optimized toolkit that retrieves textual information from financial reports, such as 10-K, 10-Q or 8-K filings.

More specifically, it can:

Crawl and download financial reports for each publicly-traded company, for specified years, through the edgar_crawler.py module.
Extract and clean specific text sections, such as Risk Factors, MD&A, and others, through the extract_items.py module. Currently, we only support extraction of 10-K filings (i.e., annual reports).

The purpose of EDGAR-CRAWLER is to speed up research and experiments that rely on financial information, as they are widely seen in the research literature of economics, finance, business and management.

🚨 News

2023-01-16: EDGAR-CORPUS, a derivative dataset generated from EDGAR-CRAWLER, is available as a HuggingFace 🤗 dataset card. See Accompanying Resources for more details.
2022-10-13: Updated documentation and fixed a minor import bug.
2022-04-03: EDGAR-CRAWLER is available for Windows systems too.
2021-11-11: We presented EDGAR-CRAWLER at ECONLP 2021, which took place in conjunction with EMNLP at the Dominican Republic.
2021-09-16: The research paper is accepted at the 3rd Economics and Natural Language Processing Workshop.

Install
Usage
Citation
Accompanying Resources
Contributing
License

Install

Before starting, it's recommended to create a new virtual environment using Python 3.8 or greater. We recommend installing and using Anaconda for this.
Install dependencies via pip install -r requirements.txt

Usage

Before running any script, you should edit the config.json file.
- Arguments for edgar_crawler.py, the module to download financial reports:
  - --start_year XXXX: the year range to start from (default is 2021)
  - --end_year YYYY: the year range to end to (default is 2021)
  - --quarters: the quarters that you want to download filings from (List).
    Default value is: [1, 2, 3, 4].
  - --filing_types: list of filing types to download.
    Default value is: ['10-K', '10-K405', '10-KT'].
  - --cik_tickers: list or path of file containing CIKs or Tickers. e.g. [789019, "1018724", "AAPL", "TWTR"]
    In case of file, provide each CIK or Ticker in a different line.
    If this argument is not provided, then the toolkit will download annual reports for all the U.S. publicly traded companies.
  - --user_agent: the User-agent (name/email) that will be declared to SEC EDGAR.
  - --raw_filings_folder: the name of the folder where downloaded filings will be stored.
    Default value is 'RAW_FILINGS'.
  - --indices_folder: the name of the folder where EDGAR TSV files will be stored. These are used to locate the annual reports. Default value is 'INDICES'.
  - --filings_metadata_file: CSV filename to save metadata from the reports.
  - --skip_present_indices: Whether to skip already downloaded EDGAR indices or download them nonetheless.
    Default value is True.
- Arguments for extract_items.py, the module to clean and extract textual data from already-downloaded 10-K reports:
  - --raw_filings_folder: the name of the folder where the downloaded documents are stored.
    Default value s 'RAW_FILINGS'.
  - --extracted_filings_folder: the name of the folder where extracted documents will be stored.
    Default value is 'EXTRACTED_FILINGS'.
    For each downloaded report, a corresponding JSON file will be created containing the item sections as key-pair values.
  - --filings_metadata_file: CSV filename to load reports metadata (Provide the same csv file as in edgar_crawler.py)
  - --items_to_extract: a list with the certain item sections to extract.
    e.g. ['7','8'] to extract 'Management’s Discussion and Analysis' and 'Financial Statements' section items.
    The default list contains all item sections.
  - remove_tables: Whether to remove tables containing mostly numerical (financial) data. This work is mostly to facilitate NLP research and often numerical tables are not useful
  - skip_extracted_filings: Whether to skip already extracted filings or extract them nonetheless.
    Default value is True.
To download financial reports from EDGAR, run python edgar_crawler.py
To clean and extract specific item sections from already-downloaded 10-K documents, run python extract_items.py.
- Reminder: We currently support the extraction of 10-K documents.

Citation

If this work helps or inspires you in any way, please consider citing the relevant paper published at the 3rd Economics and Natural Language Processing (ECONLP) workshop at EMNLP 2021 (Punta Cana, Dominican Republic):

@inproceedings{loukas-etal-2021-edgar,
    title = "{EDGAR}-{CORPUS}: Billions of Tokens Make The World Go Round",
    author = "Loukas, Lefteris  and
      Fergadiotis, Manos  and
      Androutsopoulos, Ion  and
      Malakasiotis, Prodromos",
    booktitle = "Proceedings of the Third Workshop on Economics and Natural Language Processing",
    month = nov,
    year = "2021",
    address = "Punta Cana, Dominican Republic",
    publisher = "Association for Computational Linguistics",
    url = "https://aclanthology.org/2021.econlp-1.2",
    pages = "13--18",
}

Read the paper here: https://arxiv.org/abs/2109.14394

Accompanying Resources

[corpus] EDGAR-CORPUS: A corpus for financial NLP research, built from SEC's EDGAR - https://zenodo.org/record/5528490
- [corpus but as a HuggingFace 🤗 dataset card] -https://huggingface.co/datasets/eloukas/edgar-corpus/
[word embeddings] EDGAR-W2V: Word2vec Embeddings trained on EDGAR-CORPUS - https://zenodo.org/record/5524358

Contributing

PRs and contributions are accepted.

Please use the Feature Branch Workflow.

Issues

Please create an issue on GitHub instead of emailing us directly so all possible users can benefit from the troubleshooting.

License

Please see the GNU General Public License v3.0

conceptofmind / edgar-crawler