Skip to content

digits-api-tda is the service responsible for handling TDAmeritrade API data to the main API and the UI.

Notifications You must be signed in to change notification settings

mxchinegod/digits-api-tda

Repository files navigation


digits-api-tda is the service responsible for handling TDAmeritrade API data to the main API and the UI. Some endpoints are vanilla i.e. they route to TDA with no processing. Others are tightly coupled to a specific component-API React bridge in DigitsUI.


📝 Code Properties ✨ start with why contributions welcome HitCount License: CC BY-NC 4.0

The below stack is minimal because what this API does is bridge TDA responses to the main API where they can be handled
📁 Library ⚙ Purpose 📎 Version
NodeJS Base 16.18.0
express Session Middleware 4.18.2
You will want to know about each of these in depth by the above order.

🎬 Environment ✨

config.js should be created from config.example.js
  • consumer is the key which TDA API uses to make authenticated requests.
  • servicePort is this service's port. If you change it, you will need to change your config.js in digits-api-main
  • tdaHost is the TDA API which I have left in case it changes and for project uniformity.

npm i

📜 Provided Scripts ✨

Digits AI provides some useful scripts to help you quick start.
Scripts provided in package.json. It's safe to modify or add additional scripts, but here are the defaults:

💡 start

npm start

🏰 Service Mesh API ✨

digits-api-tda is responsible for managing TDA data to and from DigitsUI, through digits-api-main.
  • 🔌 Interfacing [ http ]
    • All API routing is done through http requests. It's possible sockets play a role one day.
  • 🩺 Monitoring [ http ]
    • This API intrinsically reports to digits-api-main
  • 🧮 Preprocessing [ node ]
    • A lot of the data here is not vanilla routing for TDA, but has heavy preprocessing and remapping before serving to the DigitsUI.

💎 Goals ✨

immediate
  • Initialize beautiful README.md
  • Describe service API role
  • Add husky pre-commit
  • Create mesh diagram
  • Explain preprocessor philosophy
  • Add historical and realtime quote endpoints
long-term
  • Docker images
  • Kubernetes deployment

🙋 Contribution

Proper commit message format is required for automated changelog generation. Examples:
[<emoji>] [revert: ?]<type>[(scope)?]: <message>

💥 feat(compiler): add 'comments' option
🐛 fix(compiler): fix some bug
📝 docs(compiler): add some docs
🌷 UI(compiler): better styles
🏰 chore(compiler): Made some changes to the scaffolding
🌐 locale(compiler): Made a small contribution to internationalization

Other commit types: refactor, perf, workflow, build, CI, typos, tests, types, wip, release, dep

About

digits-api-tda is the service responsible for handling TDAmeritrade API data to the main API and the UI.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published