get_stars_balance()¶

Client.get_stars_balance()¶

Get the current Telegram Stars balance of the current account.

Usable by Users Bots

Parameters:¶

chat_id (``int`` | ``str``, *optional*) – Unique identifier (int) or username (str) of the target chat. For your personal cloud (Saved Messages) you can simply use “me” or “self”.

Returns:¶

``float`` (On success, the current stars balance is returned.)

Example

# Get stars balance of current account
await app.get_stars_balance()

# Get stars balance of a bot
await app.get_stars_balance(chat_id="pyrogrambot")