Skip to content

Latest commit

 

History

History
13 lines (12 loc) · 803 Bytes

README.md

File metadata and controls

13 lines (12 loc) · 803 Bytes

ScraXBRL

SEC Edgar Scraper and XBRL Parser/Renderer

To use:

  1. Install requirements from requirements.txt
  2. Change settings.py to fit your needs. Raw scraped data will be stored in data/raw_data and
    extracted data will be stored in data/extracted_data by default.
  3. Run python main.py. This will begin the scrape and extract process.
  4. To view data in terminal (data must have already been scraped from the SEC EDGAR website): alt tag Data is stored in a pickle file. To use DataViewer, create instance of DataView class and enter
    the necessary parameters (ticker_symbol, filing_date, filing_type). The data will then be stored in
    [instance name].data, and it is an OrderedDict.