https://github.com/tooksoi/ScraXBRL

SEC Edgar Scraper and XBRL Parser/Renderer
https://github.com/tooksoi/ScraXBRL

edgar-scraper xbrl xbrl-parser

Last synced: about 2 months ago
JSON representation

SEC Edgar Scraper and XBRL Parser/Renderer

• Host: GitHub
• URL: https://github.com/tooksoi/ScraXBRL
• Owner: tooksoi
• License: mit
• Created: 2016-03-06T15:20:23.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-26T19:46:50.000Z (over 1 year ago)
• Last Synced: 2024-02-14T21:14:21.425Z (7 months ago)
• Topics: edgar-scraper, xbrl, xbrl-parser
• Language: Python
• Size: 883 KB
• Stars: 270
• Watchers: 23
• Forks: 90
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://raw.githubusercontent.com/computerpencils/ScraXBRL/master/aapl20130629.png)

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.