> For the complete documentation index, see [llms.txt](https://docs.bsd.money/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bsd.money/telegram-bot.md).

# Telegram Bot

The BSD telegram bot gives users mobile tools for reviewing and staying up to date on their BSD protocol positions. Users can view information for specific vaults, see meta protocol stats, and subscribe to vault health alerts that are pushed to their telegram app.

## Setup

Search for @BasedMoney\_bot in telegram. Begin a chat.

Click start to see the initial interaction prompt

If this prompt needs to be replayed, send `/start` to the bot at any time

Register your wallet with `/addWallet <your-stacks-address>`

Example: `/addwallet SP1ABC...`

## Core Features

### Vault Monitoring

Get a full report of all vaults that you have created

View information on specific vaults

Monitor vault health

### Alerts

Subscribe to health alerts for individual vaults to receive telegram notifications when vault health deteriorates

Set a custom alert threshold to be alerted in addition to the standard collateral ratio minimum

Receive alerts when a vault is scheduled for liquidation

### Protocol Information

See protocol statistics (e.g. total collateral, total BSD supply)

Check current sBTC price from oracle

## Commands

### Wallet Management

`/addwallet <address>` - register your Stacks wallet

`/wallet` - view your registered wallet

### Vault Information

`/report` - view a summary of the vaults owned by the registered wallet

`/vault <vault-id>` - view information about a specific vault

### Alert Subscriptions

`/subscribe <vault-id> <optional threshold>` - subscribe to alerts for a specific vault

Example: `/subscribe 0` - subscribe to push notifications when the collateral ratio of vault 0 drops below the default liquidation threshold (110%)

Example: `/subscribe 0 150` - subscribe to push notifications when the collateral ratio of vault 0 drops below your custom threshold (150%) AND the default threshold (110%)

`/unsubscribe <vault-id | all>` - remove alert subscriptions for specific vaults or all subscriptions

`/mysubscriptions` - view active vault alert subscriptions

### Protocol Information

`/stats` - view protocol wide statistics

`/price` - get the current sBTC price

### Help

`/start` - replay the welcome message and command overview

`/help` - detailed help information