/stocky

A little Discord bot that knows about stocks

Primary LanguageTypeScript

Stocky

CodeQL Create and publish a Docker image Canary Deployment Production Deployment

Image of Mr. Stocky himself

Stocky is a little Discord bot that knows about stocks.

Installation

Stocky is now available for the public! Simply click on the following link and authorize him to the server of your choosing.

https://discord.com/api/oauth2/authorize?client_id=905504527418003486&scope=applications.commands

Development

  1. Create your bot in the Discord Developer Portal.
  2. Generate an API key from FinnHub.
  3. Populate .env with the secrets from your Discord Bot and FinnHub. Use .env_example for help.
  4. Build the docker image: docker build . --file Dockerfile --tag stocky:latest
  5. Run the DeployCommands script: docker run -i --env-file=.env stocky:latest node target/DeployCommands.js
  6. Run Stocky in docker: docker run --env-file=.env stocky:latest

Usage

  • /quote SYMBOL: Get real-time quote data for US stocks.
  • /basic_financials SYMBOL: Get company basic financials such as margin, P/E ratio, 52-week high/low etc.

Don't see a command you want? I accept PRs!