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).

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.

Contributing

Telethon v1 is for the most part in maintenance mode. New layers are still updated to when released, bug fixes are welcome, and some small additions may still be added from time to time.

Please only submit issues and pull requests authored entirely by you or other fellow humans.