Home

GoyGram

GoyGram is an asynchronous Python library for Telegram bots and MTProto userbots. One application object exposes a shared event model, composable filters, dynamic Bot API calls, and raw MTProto calls.

Current documented release: 0.7.15. The package requires Python 3.11 or newer.

Choose a transport

• Bot API — pass bot_token; use Telegram Bot API methods and receive bot updates by long polling.
• MTProto — pass api_id and api_hash; authenticate a Telegram user account and receive MTProto updates.
• Both — configure both transports only when needed. Prefix a chat ID with bot: or mt: to select a transport for helpers that accept a chat ID.

Start here

• Installation
• Quick-Start-Bot-API
• Quick-Start-MTProto-Userbot
• Configuration-and-Transports
• Handlers-and-Updates
• Filters

Build features

• Keyboards-Formatting-and-State
• Polling-and-Membership
• Files-and-Media
• Scheduling-and-Background-Work

Reference

• GoyGram-Client-Reference
• Event-Objects
• Bot-API-Calls
• MTProto-Calls
• Sessions-and-Authentication
• Architecture-and-Runtime-Behavior
• Errors-Logging-and-Troubleshooting
• Migration-and-Compatibility
• FAQ