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

# Telegram bot

[@FamilioTradeBot](https://t.me/FamilioTradeBot) posts a family's buys, sells, payouts, airdrops, crew changes, joins and leaves into the Telegram group the head connected. It does not trade. It does not take deposits. Group admins decide what lands and how often.

## Connect a group

From the head panel: **Manage → social → connect telegram**.

1. The panel mints a short code (`FAM-……`, 8 characters, no 0/O/1/I, lasts 24 hours).
2. Tap **add @FamilioTradeBot to your group** (Telegram `?startgroup=` with that code) and pick the group, **or** add the bot by hand and send `/connect FAM-……` in the group.
3. The bot replies that it is connected. The next matching event posts there.

Codes only work **inside a group**. In a DM the bot tells you to add it to the group instead. One family maps to one group (`family_telegram` is keyed on the vault); connecting again overwrites the chat.

Disconnect: group admin `/disconnect`, or disconnect from the head panel. Posting stops; `/stats` in that chat no longer treats it as the family's room until you reconnect with a fresh code.

## `/create`

Anywhere (group or DM), `/create` answers with a button to the create wizard on the site. The wizard needs a signed-in wallet, so the actual deployment happens on the web; once the family trust is live, the head links the group from **Manage → social → connect telegram**.

## What gets posted

On-chain events the indexer already stored:

| Kind         | When                                                                                                                         |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------- |
| Buy / sell   | A `Swapped` event, with size, token, realised (sells), optional thesis text                                                  |
| Payout       | A `Distributed` event                                                                                                        |
| Airdrop      | Native ETH wrapped at the vault, or an ERC-20 `Transfer` into the vault in a transaction the vault itself did not emit       |
| Crew         | Co-pilot granted or removed; crew locked                                                                                     |
| Join / leave | A `Joined` event (who, how much, which bags the deposit mirror-bought into) or a `Left` event (took their slice, or evicted) |

Each post includes a link to the family page and the explorer transaction. Thesis text is included when the head saved a note against that hash.

Claims, lock toggles, fee changes and other feed milestones show on the **website** feed only.

## `/stats` (alias `/summary`)

Anyone in a **connected group** can send `/stats` (no argument) and get a snapshot: trust value and cash, member count, head fee, each top bag with its share, value and **market cap** (plus % vs the trust's entry), 7D/30D PnL, paid out, crew, last few feed lines, and the current posting settings.

`/stats <name>` works in a group or in a **DM** for a **public** family — by display name (when it matches exactly one family), URL slug or address. A private family's numbers stay inside its own connected group — the bot will refuse a DM snapshot for a private family.

## Muting and throttling

All of these are **group-admin** only (Telegram creator or administrator). `/settings` is visible to anyone.

| Command            | Effect                                                                                                                                                                                            |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `/mute`            | Stop posting trades, payouts, crew changes and joins. `/stats` still works.                                                                                                                       |
| `/unmute`          | Post all four kinds again.                                                                                                                                                                        |
| `/trades on\|off`  | Buys and sells                                                                                                                                                                                    |
| `/payouts on\|off` | Payouts and airdrops                                                                                                                                                                              |
| `/crew on\|off`    | Co-pilot changes and crew lock                                                                                                                                                                    |
| `/joins on\|off`   | Members joining and leaving                                                                                                                                                                       |
| `/every <minutes>` | `0` = every event as it happens. `1`–`1440` = at most one digest every N minutes. Events in between are queued (up to 50; older ones collapse into "…and N more"). A digest shows up to 12 lines. |

Switching back to `/every 0` flushes whatever was queued. A quiet family still gets a digest when the window elapses, so the last trade of a burst is not stuck until the next one.

`/status` — which family this group is linked to. `/start` / `/help` — how to connect.

## DMs

In a private chat with the bot:

* `/start` explains how to add it to a group from the head panel.
* `/stats <name>` for a public family.
* `/create` for a button to the create wizard.
* Connect, mute, settings and disconnect are group-only.

The bot does not cold-DM anyone. Telegram will not deliver a message until the user has pressed Start; familio does not use that for marketing.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.familio.trade/around-the-family/telegram-bot.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
