https://github.com/nfriedly/vfi-edgar

Basic API for EDGAR data
https://github.com/nfriedly/vfi-edgar

Last synced: 17 days ago
JSON representation

Basic API for EDGAR data

• Host: GitHub
• URL: https://github.com/nfriedly/vfi-edgar
• Owner: nfriedly
• Created: 2019-09-06T16:47:33.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-07-24T20:54:41.000Z (over 4 years ago)
• Last Synced: 2024-10-12T16:14:42.388Z (about 1 month ago)
• Language: JavaScript
• Size: 156 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# EDGAR Data API

Tool to serve up EDGAR data from a local database.

Includes a script to fetch recent sample data and import it into a SQLite DB.

## Setup

### Prerequisites

- Bash ("Git Bash" works on Windows)

- SQLite 3

- Node.js >= 8

### Getting started

1. Run `create_db.sh` to generate the `edgar.db` database.

2. Run `npm install` to install dependencies

3. Run `npm start` to start the HTTP API server.

4. Visit https://localhost:3000 to see several examples of using the API

## Thoughts on the project

The original request here was fairly open-ended, but I believe this meets the goals of storing the data in a repeatable fashion and making it available to a front-end.

It seems that the Submissions are the primary data here, and that when viewing a given Submission, the associated Numbers and Presentation of Statements data would also be desired. So, the primary API endpoint combines all three of these together.

It makes for a fairly heavy request, but it seemed like the most-appropriate option.

I considered also including the Tag data with a Submission but decided against it, as the data there seems like it would less commonly be required.

Also to keep the Submission response size and time from balooning any further.

Normally I'd add some unit and integration tests, but the linting (`npm run lint`) will have to do for now.