Welcome to Pyrogram#

Telegram MTProto API Framework for Python
Homepage • Development • Releases • News

from pyrogram import Client, filters

app = Client("my_account")

@app.on_message(filters.private)
async def hello(client, message):
    await message.reply("Hello from Pyrogram!")

app.run()

Pyrogram is a modern, elegant and asynchronous MTProto API framework. It enables you to easily interact with the main Telegram API through a user account (custom client) or a bot identity (bot API alternative) using Python.

Support#

If you’d like to support Pyrogram, you can consider:

How the Documentation is Organized#

Contents are organized into sections composed of self-contained topics which can be all accessed from the sidebar, or by following them in order using the Next button at the end of each page. You can also switch to Dark or Light theme or leave on Auto (follows system preferences) by using the dedicated button in the top left corner.

Here below you can, instead, find a list of the most relevant pages for a quick access.

First Steps#

Quick Start: Overview to get you started quickly.
Invoking Methods: How to call Pyrogram’s methods.
Handling Updates: How to handle Telegram updates.
Error Handling: How to handle API errors correctly.

API Reference#

Pyrogram Client: Reference details about the Client class.
Available Methods: List of available high-level methods.
Available Types: List of available high-level types.
Enumerations: List of available enumerations.
Bound Methods: List of convenient bound methods.

Meta#

Pyrogram FAQ: Answers to common Pyrogram questions.
Support Pyrogram: Ways to show your appreciation.
Release Notes: Release notes for Pyrogram releases.