get_owned_star_count()¶

Client.get_owned_star_count()¶

Get the number of Telegram Stars count owned by the current account or the specified bot.

Usable by Users Bots

Parameters:¶

user_id (``int`` | ``str``, *optional*) – Unique identifier (int) or username (str) of the bot for which the star count should be returned instead of the current user. The bot should have can_be_edited property set to True. Pass None to return the count of the current user.

Returns:¶

:obj:`~pyrogram.types.StarAmount` (On success, the current stars balance is returned.)

Example

# Get stars balance
app.get_stars_balance()

# Get stars balance of a bot owned by the current user
app.get_stars_balance(user_id="pyrogrambot")