edgarQ

Query SEC EDGAR API by company concept using python. A serverless Flask route and helper functions to send requests and process responses. Live price data is requested from FMP and used to calculate EPS to price ratios.

Information is not accurate and there's a lot to explore. Please fork / refactor / contribute.

Usage

1. Create an .env file in project root, and add this:
   BASE_URL="http://localhost:3000/api" USER_AGENT="[your email of choice]" FMP_API_KEY="your api key". (Obtain yours here)
2. Run locally with vercel dev command. (You might have to install the vercel CLI, if so you can find instructions here).
3. Make queries in either of these ways:
   • http://localhost:3000 to see a basic form, add a ticker symbol or a filter value and submit to display all data as a prettified json.
   • http://localhost:3000/api/<function>?ticker=<example> to display a particular company concept. (replace <function> with any of the file names inside /api, and <example> with a valid ticker symbol). Sample request: http://localhost:3000/api/net_income?ticker=meli. Data is returned as a .json object with two fields: _data is pure .json data, and name is the same data formatted as an html string with html <table> tags added.
   • http://localhost:3000/api/filter?criterion=EPS&min_value=<example>. (replace <example> with a valid numerical value) to get a filtered list of companies that have an EPS greather than or equal to the provided value.

Updates

In case the list of CIK numbers stored locally at /lib/cik_local.json needs to be updated, you can find a script to automatically do so in /utilities/update_ciks.py