Given a stock symbol, returns price information
This is not currently a public bot, you need
to make your own Discord App in the developer portal,
and then pass your own bot tokens into .env
along with a prefix (I use $)
Copy the env.default file to .env to get started!
You will need to create a Bot in the
Discord Developer Portal. At
a minimum, the bot must have a TOKEN and you must set the bot up with the
Message Content intent.
# You'll need pnpm installed, either via a local corepack directory or globally
$ pnpm install && pnpm run start
OR
$ ./bin/dockerizeIn any channel the bot is present in, type <PREFIX>
followed by the symbols you want information about:
You can also lookup the ticker of a company via a lookup. Type <PREFIX><PREFIX>
followed by the search term (like the company name):
You can receive similar recommendations related to a ticker. Type <PREFIX><PREFIX><PREFIX>
followed by the symbol you want related recommendations for:
For additional help and options, type the <PREFIX> and the bot will display all of its commands.
You can have the bot only watch and reply in a designated channels by providing the
BOT_TARGET_CHANNEL_IDS variable in the .env file, otherwise the bot will watch and reply from
all channels. The BOT_TARGET_CHANNEL_IDS is a comma-seperated list of channel IDs.
The bot will always watch and reply in individual DMs.
See the env.default file for reference.
You can configure the bot to periodically send HTTP requests to a "health check" endpoint of your choice.
You can configure the HTTP Method, URL, and provide a Bearer Token for authorization if needed.
In order for the healthcheck to be enabled you MUST provide a valid URL.
The method should be known by axios, if it is not provided, it will use the axios defaults.
If the bearer token is not provided, it will be ignored.
The variables for BOT_HEALTHCHECK_URLS, BOT_HEALTHCHECK_METHODS, and BOT_HEALTHCHECK_BEARER_TOKENS are
comma-seperated lists. The lists must ALL be the same length.
See the env.default file for reference.
Apache 2
Copyright 2024 pyamsoft
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.