Skip to content

Pure Python 3 MTProto API Telegram client library, for bots too!

License

Notifications You must be signed in to change notification settings

LonamiWebs/Telethon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

c409d8c · Mar 26, 2025
Nov 9, 2023
Mar 22, 2025
Mar 20, 2025
Feb 26, 2023
Mar 26, 2025
Nov 6, 2024
Dec 7, 2019
Jan 14, 2021
Nov 29, 2016
Jan 14, 2024
Feb 12, 2021
May 4, 2023
Dec 7, 2019
Jun 26, 2018
Nov 9, 2020
Oct 5, 2020
Feb 27, 2019
Dec 1, 2023
Sep 20, 2022

Repository files navigation

Telethon

⭐️ Thanks everyone who has starred the project, it means a lot!

logo Telethon is an asyncio Python 3 MTProto library to interact with Telegram's API as a user or through a bot account (bot API alternative).

Important

If you have code using Telethon before its 1.0 version, you must read Compatibility and Convenience to learn how to migrate. As with any third-party library for Telegram, be careful not to break Telegram's ToS or Telegram can ban the account.

What is this?

Telegram is a popular messaging application. This library is meant to make it easy for you to write Python programs that can interact with Telegram. Think of it as a wrapper that has already done the heavy job for you, so you can focus on developing an application.

Installing

pip3 install telethon

Creating a client

from telethon import TelegramClient, events, sync

# These example values won't work. You must get your own api_id and
# api_hash from https://my.telegram.org, under API Development.
api_id = 12345
api_hash = '0123456789abcdef0123456789abcdef'

client = TelegramClient('session_name', api_id, api_hash)
client.start()

Doing stuff

print(client.get_me().stringify())

client.send_message('username', 'Hello! Talking to you from Telethon')
client.send_file('username', '/home/myself/Pictures/holidays.jpg')

client.download_profile_photo('me')
messages = client.get_messages('username')
messages[0].download_media()

@client.on(events.NewMessage(pattern='(?i)hi|hello'))
async def handler(event):
    await event.respond('Hey!')

Next steps

Do you like how Telethon looks? Check out Read The Docs for a more in-depth explanation, with examples, troubleshooting issues, and more useful information.