The Telegram Bot Framework.

docs. reference. chat. news.

grammY makes it easy to create Telegram bots. Both for beginners and at scale.

You want grammY because it is easy to use. It is very powerful and always up to date. It has the best documentation in town. It is extremely efficient and scales up effortlessly. It has a thriving ecosystem of plugins, a friendly community chat, seamless integrations with web frameworks and databases, and so much more.

Are you ready? 🤖🚀

Bots are written in TypeScript (or JavaScript) and run on Node.js or Deno.

Quickstart

If you are new to Telegram bots, read the official Introduction for Developers written by the Telegram team.

Visit @BotFather and create a new bot. You will obtain a bot token.

Create a new directory and run

npm install grammy

inside it. Then create a file bot.js with this content:

const { Bot } = require("grammy");

// Create a bot object
const bot = new Bot(""); // <-- place your bot token in this string

// Register listeners to handle messages
bot.on("message:text", (ctx) => ctx.reply("Echo: " + ctx.message.text));

// Start the bot (using long polling)
bot.start();

Now you can run the bot via

node bot.js

and it will echo all received text messages.

Congrats! You just wrote a Telegram bot :)

Going Further

grammY has an excellent documentation, and an API Reference. It even integrates with your code editor, e.g. VSCode. You can hover over any element of grammY to get a detailed description of what that thing does or means.

If you are still stuck, just join the Telegram chat and ask for help. People are nice there and we appreciate your question, no matter what it is :)

Here are some more resources to support you:

Resources

grammY Website

—main project website and documentation. Gets you started and explains all concepts.

grammY API Reference

—reference of everything that grammY exports. Useful to look up descriptions about any element of grammY.

grammY Example Bots

—repository full of example bots. Includes a setup to easily run any of them.

Awesome grammY

—list of awesome projects built with grammY. Helpful if you want to see some real-world usage.

grammY Telegram Chat

—Telegram chat where you can ask any question about grammY or bots in general. We are also open for feedback, ideas, and contributions!

The Russian community chat can be found here.

grammY News Channel

—Telegram channel where updates to grammY and the ecosystem are posted. We are also on Twitter.

Telegram Bot API Reference

—documentation of the API that Telegram offers, and that grammY connects to under the hood.

Deno Support

All grammY packages published by @grammyjs run natively on Deno. We are compiling every codebase to still run on Node.js.

However, given that most bot developers are still using Node.js, all documentation is written Node.js-first. We may migrate it if Deno overtakes Node.js. If you are already on Deno today, import grammY from https://deno.land/x/grammy/mod.ts.

You may also be interested in why we support Deno.

Browser Support

The grammY core package in this repository is available as an ESM module under the @grammyjs/web npm package.

You can just install it with npm or yarn and use it in place of the grammy package.

If you need a CDN, you can use jsDelivr or UNPKG like with the following URLs:

jsDelivr: https://cdn.jsdelivr.net/npm/@grammyjs/web@<grammy-version> UNPKG: https://unpkg.com/@grammyjs/[email protected]@<grammy-version>

Contribution Guide »

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!