joe-sida / order-alert-bot

Get Telegram notifications if orders are filled. Currently compatible with FTX Exchange.

About • Installation

About

The Order Alert Bot listens to FTX orders via websockets using NestJS. For each order you will receive a notification in Telegram.

Installation

⚠️ Best to run the bot on a VPS. I can recommend Hetzner.

1. Install NodeJS
2. Clone this repository git clone https://github.com/raftheunis87/order-alert-bot.git
3. Install all requirements npm install
4. Rename .env.example to .env and replace the <> placeholders with the correct values:
   • APP_PORT is the port on which you want the application to run
   • TELEGRAM_BOT_TOKEN is the token you receive after creating a bot with the BotFather
   • TELEGRAM_CHAT_ID is the id of the telegram group or channel in which the bot will give the order alerts
   • FTX_ACCOUNTS is an array of objects in which you can add all your FTX subaccounts. Each object needs the following keys:
     • key: the apiKey from FTX (You can/should use a read-only api key)
     • secret: the secret from FTX (You can/should use a read-only api key)
     • subaccount: the name of the subaccount
5. Run the bot npm run build && npm run start:prod

How can I help?

All kinds of contributions are welcome 🙌! The most basic way to show your support is to ⭐️ star the project, or raise 🐞 issues. You can also buy me some ☕️ coffee to help keep me productive! You can also sent me some crypto to the following addresses:

• BTC: 3P4eit3YxdokJZNNEF9s6VosG9zAxhj4pS
• ETH: 0xa3Fe3CDa5cD73022F1935b342dc57FD8C6C34F56
• USDT (TRC20): THV4oP8LAt7cijNjzccfbFu8KxqdqWS8Ns

Thanks again for your support, it is much appreciated! 🙏