mirror of
https://github.com/Mayuri-Chan/pyrofork.git
synced 2025-12-29 12:04:51 +00:00
62 lines
2 KiB
Python
62 lines
2 KiB
Python
# Pyrogram - Telegram MTProto API Client Library for Python
|
|
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
|
|
#
|
|
# This file is part of Pyrogram.
|
|
#
|
|
# Pyrogram is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Lesser General Public License as published
|
|
# by the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Pyrogram is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Lesser General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser General Public License
|
|
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
from typing import Optional, Union
|
|
|
|
import pyrogram
|
|
from pyrogram import raw
|
|
|
|
|
|
class GetStarsBalance:
|
|
async def get_stars_balance(
|
|
self: "pyrogram.Client",
|
|
chat_id: Optional[Union[int, str]] = None,
|
|
) -> int:
|
|
"""Get the current Telegram Stars balance of the current account.
|
|
|
|
.. include:: /_includes/usable-by/users.rst
|
|
|
|
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:
|
|
``int``: On success, the current stars balance is returned.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
# Get stars balance
|
|
app.get_stars_balance()
|
|
|
|
# Get stars balance of a bot
|
|
app.get_stars_balance(chat_id="pyroforkbot")
|
|
"""
|
|
if chat_id is None:
|
|
peer = raw.types.InputPeerSelf()
|
|
else:
|
|
peer = await self.resolve_peer(chat_id)
|
|
|
|
r = await self.invoke(
|
|
raw.functions.payments.GetStarsStatus(
|
|
peer=peer
|
|
)
|
|
)
|
|
|
|
return r.balance.amount
|