@barfinex/telegram
v1.0.8
Published
NestJS module for seamless Telegram Bot API integration, with typed interfaces, providers, and services. Part of the Barfinex ecosystem.
Maintainers
Readme
@barfinex/telegram
Telegram integration for the Barfinex ecosystem — send notifications, alerts, and bot messages from Detector, Advisor, or any Barfinex service to Telegram chats or channels.
Get signals, position open/close events, and warnings in your messenger without watching logs or opening the app. One bot token and chat ID, and your automation can keep you informed in real time.
What it does
- Telegram bot — send messages to a user chat or a channel/group via the Telegram Bot API.
- NestJS module —
TelegramModuleandTelegramServicefor dependency injection and env-based config. - Alerts from Detector/Advisor — commonly used with
DETECTOR_TELEGRAM_ENABLED,TELEGRAM_BOT_TOKEN, andTELEGRAM_CHAT_ID(orDETECTOR_TELEGRAM_CHAT_ID) so detector events are pushed to Telegram.
Installation
npm install @barfinex/telegramor
yarn add @barfinex/telegramWhat's included
| Export | Purpose |
|--------|--------|
| TelegramModule | NestJS module for Telegram bot and notifications. |
| TelegramService | Send messages, handle bot commands. |
| Interfaces | Types for Telegram options and messages. |
Documentation
- Telegram — Telegram notifications — BotFather setup, chat_id, env vars, detector integration.
- Detector (sends alerts) — Installation detector.
- Barfinex — First Steps, Architecture, Typical problems and solutions.
Contributing
Improvements and use-case feedback welcome. Community: Telegram · GitHub.
License
Licensed under the Apache License 2.0 with additional terms. Attribution to Barfin Network Limited and a link to https://barfinex.com are required. See LICENSE and the Barfinex site for details.
