Welcome to wzgram’s documentation!

wzgram is an elegant, modern and asynchronous Telegram MTProto API framework for Python. It is a fork of Pyrogram with support for the latest Telegram features including Gifts, Stories, Topics, Business Accounts, and more.

from pyrogram import Client, filters

app = Client("my_account")

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

app.run()

Introduction

• Install Guide
  • Install wzgram
  • Bleeding Edge
  • Verifying
• Quick Start
  • Get wzgram Real Fast
  • Enjoy the API

Getting Started

• Project Setup
  • API Key
  • Configuration
• Authorization
  • User Authorization
  • Bot Authorization
• Invoking Methods
  • Basic Usage
  • Context Manager
  • Using asyncio.run()
• Handling Updates
  • Defining Updates
  • Registering a Handler
• Error Handling
  • RPCError
  • Error Categories
  • Single Errors
  • Unknown Errors
  • Errors with Values
• Examples

API Reference

• Available Methods
  • Utilities
  • Account
  • Messages
  • Chats
  • Users
  • Invite Links
  • Contacts
  • Folders
  • Password
  • Bots
  • Business
  • Payments
  • Stories
  • Phone
  • Premium
  • Decorators
  • Authorization
  • Advanced
• Available Types
  • Users & Chats
  • Messages & Media
  • Bot keyboards & Commands
  • Inline Mode
  • Input Content
  • Authorization
• Enums
• Bound Methods
  • Message
  • Chat
  • User
  • CallbackQuery
  • InlineQuery
  • ChatJoinRequest
  • Story
  • Gift
  • Poll
  • PreCheckoutQuery
  • ShippingQuery
  • Folder

Topics

• Advanced Usage
  • Telegram Raw API
  • Invoking Functions
  • Chat IDs
• Client Settings
  • Set Custom Values
  • Set Custom Languages
• Comparison with Other Pyrogram Forks
• FAQ
  • What is wzgram?
  • How is it different from Pyrogram?
  • What Python versions are supported?
  • How do I install wzgram?
  • Can I use wzgram with uv?
  • Do I need an API ID and hash?
  • How do I start a Client?
  • Can I use wzgram synchronously?
  • How do I handle progress for uploads and downloads?
  • What are bound methods?
  • Does wzgram support parallel downloads?
  • Does wzgram support Stories?
  • Does wzgram support Gifts and Stars?
  • Does wzgram support Business Accounts?
  • Does wzgram support Rich Text (styled messages)?
  • How do I enable debug logging?
  • Where can I get help?
• Creating Filters
  • Custom Filters
  • Basic Filters
  • Filters with Arguments
  • Method Calls Inside Filters
• Debugging
  • Caveman Debugging
  • Accessing Attributes
  • Checking an Object’s Type
• Message identifiers
• More on Updates
  • Handler Groups
  • Update propagation
• MTProto vs. Bot API
  • What is the MTProto API?
  • What is the Bot API?
  • Advantages of the MTProto API
• Proxy Settings
  • Usage
• Scheduling Tasks
  • Using apscheduler
• Object Serialization
  • For Humans - str(obj)
  • For Machines - repr(obj)
• Smart Plugins
  • Introduction
  • Using Smart Plugins
  • Specifying the Plugins to include
  • Load/Unload Plugins at Runtime
• Speedups
  • WarpCrypto
  • uvloop
• Storage Engines
  • Persisting Sessions
  • Different Storage Engines
  • Session Strings
  • Custom Storages
• Synchronous Usage
  • Synchronous Invocations
  • Synchronous handlers
  • uvloop usage
• Test Servers
  • Test Mode in Official Apps
  • Test Numbers
• Text Formatting
  • Basic Styles
  • HTML Style
  • Markdown Style
  • Different Styles
  • Nested and Overlapping Entities
• Using Filters
  • Single Filters
  • Combining Filters
  • Advanced Filters
• Voice Calls
  • Libraries
  • Older implementations