Once you successfully installed Pyrogram, you will still have to follow a few steps before you can actually use the library to make API calls. This section provides all the information you need in order to set up a project with Pyrogram.
The very first step requires you to obtain a valid Telegram API key (API id/hash pair). If you already have one you can skip this step, otherwise:
- Visit https://my.telegram.org/apps and log in with your Telegram Account.
- Fill out the form to register a new Telegram application.
- Done. The API key consists of two parts: App api_id and App api_hash.
This API key is personal and should be kept secret.
The API key obtained in the previous step defines a token for your application allowing you to access the Telegram database using the MTProto API — it is therefore required for all authorizations of both Users and Bots.
Having it handy, it’s time to configure your Pyrogram project. There are two ways to do so, and you can choose what fits better for you:
Create a new
config.inifile at the root of your working directory, copy-paste the following and replace the api_id and api_hash values with your own. This is the preferred method because allows you to keep your credentials out of your code without having to deal with how to load them:
[pyrogram] api_id = 12345 api_hash = 0123456789abcdef0123456789abcdef
Alternatively, you can pass your API key to Pyrogram by simply using the api_id and api_hash parameters of the Client class. This way you can have full control on how to store and load your credentials:
from pyrogram import Client app = Client( "my_account", api_id=12345, api_hash="0123456789abcdef0123456789abcdef" )
The examples below assume you have created a
config.ini file, thus they won’t show the api_id
and api_hash parameters usage.