Welcome to aiogram’s documentation!

aiogram is a pretty simple and fully asynchronous framework for Telegram Bot API written in Python 3.7 with asyncio and aiohttp. It helps you to make your bots faster and simpler.

Official aiogram resources

• News: @aiogram_live

• Community: @aiogram

• Russian community: @aiogram_ru

• Pip: aiogram

• Docs: ReadTheDocs

• Source: Github repo

• Issues/Bug tracker: Github issues tracker

• Test bot: @aiogram_bot

Features

• Asynchronous

• Awesome

• Makes things faster

• Has FSM

• Can reply into webhook. (In other words make requests in response to updates)

Contribute

• Issue Tracker

• Source Code

Contents

• Installation Guide
  • Using PIP
  • Using Pipenv
  • Using Pacman
  • From sources
  • Recommendations
• Quick start
  • Simple template
  • Summary
• Migration FAQ (1.4 -> 2.0)
  • Changelog
  • Instructions
    • Contextvars
    • Filters
      • Custom filters
      • Filters factory
      • Customize commands prefix
      • Passing data from filters as keyword arguments to the handlers
      • Other
    • States group
    • FSM storage’s proxy
    • File uploading mechanism
    • Pipe for uploading files from URL
    • I18n Middleware
      • First usage
      • Updating translations
    • Error handlers
    • Content types
• Telegram
  • Bot object
    • Low level API
    • Telegram Bot
    • API Helpers
  • Telegram data types
    • Bases
      • Base TelegramObject
        • MetaTelegramObject
        • TelegramObject
      • Fields
        • BaseField
        • Field
        • ListField
        • ListOfLists
        • DateTimeField
        • TextField
      • Mixins
        • Downloadable
    • Types
      • StickerSet
      • EncryptedCredentials
      • CallbackQuery
      • SuccessfulPayment
      • MessageEntity
        • MessageEntityType
      • ShippingQuery
      • PassportData
      • InlineKeyboardMarkup
        • InlineKeyboardButton
      • User
      • Video
      • EncryptedPassportElement
      • Game
      • File
      • LabeledPrice
      • CallbackGame
      • ReplyKeyboardMarkup
        • KeyboardButton
        • ReplyKeyboardRemove
      • Chat
        • ChatType
        • ChatActions
      • Document
      • Audio
      • ForceReply
      • PassportElementError
        • PassportElementErrorDataField
        • PassportElementErrorFile
        • PassportElementErrorFiles
        • PassportElementErrorFrontSide
        • PassportElementErrorReverseSide
        • PassportElementErrorSelfie
      • ShippingAddress
      • ResponseParameters
      • OrderInfo
      • GameHighScore
      • Sticker
      • InlineQuery
      • Location
      • Animation
      • InputMedia
        • InputMediaAnimation
        • InputMediaDocument
        • InputMediaAudio
        • InputMediaPhoto
        • InputMediaVideo
        • MediaGroup
      • InlineQueryResult
        • InlineQueryResultArticle
        • InlineQueryResultPhoto
        • InlineQueryResultGif
        • InlineQueryResultMpeg4Gif
        • InlineQueryResultVideo
        • InlineQueryResultAudio
        • InlineQueryResultVoice
        • InlineQueryResultDocument
        • InlineQueryResultLocation
        • InlineQueryResultVenue
        • InlineQueryResultContact
        • InlineQueryResultGame
        • InlineQueryResultCachedPhoto
        • InlineQueryResultCachedGif
        • InlineQueryResultCachedMpeg4Gif
        • InlineQueryResultCachedSticker
        • InlineQueryResultCachedDocument
        • InlineQueryResultCachedVideo
        • InlineQueryResultCachedVoice
        • InlineQueryResultCachedAudio
      • InputFile
      • PreCheckoutQuery
      • Voice
      • InputMessageContent
        • InputContactMessageContent
        • InputLocationMessageContent
        • InputTextMessageContent
        • InputVenueMessageContent
      • Update
        • AllowedUpdates
      • PhotoSize
      • Venue
      • ChosenInlineResult
      • VideoNote
      • WebhookInfo
      • PassportFile
      • ChatMember
        • ChatMemberStatus
      • ShippingOption
      • ChatPhoto
      • Contact
      • Message
        • ContentType
        • ContentTypes
        • ParseMode
      • MaskPosition
      • UserProfilePhotos
      • Invoice
      • AuthWidgetData
• Dispatcher
  • Filters
    • Basics
    • Filters factory
    • Builtin filters
      • Command
      • CommandStart
      • CommandHelp
      • CommandSettings
      • CommandPrivacy
      • Text
      • HashTag
      • Regexp
      • RegexpCommandsFilter
      • ContentTypeFilter
      • IsSenderContact
      • StateFilter
      • ExceptionsFilter
      • IDFilter
      • AdminFilter
      • IsReplyFilter
      • ForwardedMessageFilter
      • ChatTypeFilter
      • MediaGroupFilter
    • Making own filters (Custom filters)
      • AbstractFilter
      • Filter
      • BoundFilter
  • Finite state machine
    • Storage
      • Available storage’s
        • Memory storage
        • Redis storage
        • Mongo storage
        • Rethink DB storage
        • Making own storage’s
    • States
    • State utils
      • State
      • States group
  • Middleware
    • Bases
    • Making own middleware’s
    • Available middleware’s
  • Webhook
    • Bases
    • Security
    • Making requests when getting updates
  • Basics
  • Available handlers
    • Handler class
  • Features
  • Dispatcher class
• Utils
  • Auth Widget
  • Executor
  • Exceptions
  • Markdown
  • Helper
  • Deprecated
  • Payload
  • Parts
  • JSON
  • Emoji
  • Deep linking
• Examples
  • Echo bot
  • Inline bot
  • Advanced executor example
  • Proxy and emojize
  • Finite state machine example
  • Throttling example
  • I18n example
  • Regexp commands filter example
  • Check user language
  • Middleware and antiflood
  • Webhook example
  • Webhook example old
  • Payments
  • Broadcast example
  • Media group
  • Local server
• Contribution
• Links

Indices and tables

• Index

• Module Index

• Search Page