Need help with python-telegram-bot?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

16.5K Stars 3.5K Forks Other 2.3K Commits 34 Opened issues


We have made you a wrapper you can't refuse

Services available


Need anything else?

Contributors list

.. Make user to apply any changes to this file to README_RAW.rst as well!

.. image:: :align: center :target: :alt: python-telegram-bot Logo

We have made you a wrapper you can't refuse

We have a vibrant community of developers helping each other in our

Telegram group 
_. Join us!

Stay tuned for library updates and new releases on our

Telegram Channel 

.. image:: :target: :alt: PyPi Package Version

.. image:: :target: :alt: Supported Python versions

.. image:: :target: :alt: Supported Bot API versions

.. image:: :target: :alt: PyPi Package Monthly Download

.. image:: :target: :alt: Documentation Status

.. image:: :target: :alt: LGPLv3 License

.. image:: :target: :alt: Github Actions workflow

.. image:: :target: :alt: Code coverage

.. image:: :target: :alt: Median time to resolve an issue

.. image:: :target: :alt: Code quality: Codacy

.. image:: :target: :alt: Code quality: DeepSource

.. image:: :target:

.. image:: :target: :alt: Telegram Group


Table of contents

  • Introduction
  • Telegram API support
  • Installing
  • Getting started


Learning by example




  • Getting help
  • Contributing
  • License



This library provides a pure Python interface for the

Telegram Bot API 
. It's compatible with Python versions 3.6.8+. PTB might also work on
, though there have been a lot of issues before. Hence, PyPy is not officially supported.

In addition to the pure API implementation, this library features a number of high-level classes to make the development of bots easy and straightforward. These classes are contained in the


A pure API implementation without

is available as the standalone package
See here for details. 


Installing both

in conjunction will result in undesired side-effects, so only install one of both.


Telegram API support

All types and methods of the Telegram Bot API 5.3 are supported.



You can install or upgrade python-telegram-bot with:

.. code:: shell

$ pip install python-telegram-bot --upgrade

Or you can install from source with:

.. code:: shell

$ git clone --recursive
$ cd python-telegram-bot
$ python install

In case you have a previously cloned local repository already, you should initialize the added urllib3 submodule before installing with:

.. code:: shell

$ git submodule update --init --recursive

Optional Dependencies

PTB can be installed with optional dependencies:

  • pip install python-telegram-bot[passport]
    installs the
    _ library. Use this, if you want to use Telegram Passport related functionality.
  • pip install python-telegram-bot[ujson]
    installs the
    _ library. It will then be used for JSON de- & encoding, which can bring speed up compared to the standard
    _ library.
  • pip install python-telegram-bot[socks]
    installs the
    _ library. Use this, if you want to work behind a Socks5 server.


Getting started

Our Wiki contains a lot of resources to get you started with

  • Introduction to the API 
  • Tutorial:
    Your first Bot 

Other references:

  • Telegram API documentation 
  • python-telegram-bot documentation 

Learning by example

We believe that the best way to learn this package is by example. Here are some examples for you to review. Even if it is not your approach for learning, please take a look at
, it is the de facto base for most of the bots out there. Best of all, the code for these examples are released to the public domain, so you can start by grabbing the code and building on top of it.


this page 
_ to discover the official examples or look at the examples on the
_ to see other bots the community has built.


This library uses the

module. To set up logging to standard output, put:

.. code:: python

import logging
                    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')

at the beginning of your script.

You can also use logs in your application by calling

and setting the log level you want:

.. code:: python

logger = logging.getLogger()

If you want DEBUG logs instead:

.. code:: python




's documentation lives at 


Getting help

You can get help in several ways:

  1. We have a vibrant community of developers helping each other in our

    Telegram group 
    _. Join us!
  2. Report bugs, request new features or ask questions by

    creating an issue 
    _ or
    a discussion 
  3. Our

    Wiki pages 
    _ offer a growing amount of resources.
  4. You can even ask for help on Stack Overflow using the

    python-telegram-bot tag 



Contributions of all sizes are welcome. Please review our

contribution guidelines 
_ to get started. You can also help by
reporting bugs 



Occasionally we are asked if we accept donations to support the development. While we appreciate the thought, maintaining PTB is our hobby and we have almost no running costs for it. We therefore have nothing set up to accept donations. If you still want to donate, we kindly ask you to donate to another open source project/initiative of your choice instead.



You may copy, distribute and modify the software provided that modifications are described and licensed for free under

_. Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.