payments.GetStarsStatus

class pyrogram.raw.functions.payments.GetStarsStatus

Get the current Telegram Stars balance of the current account (with peer=inputPeerSelf), or the stars balance of the bot specified in peer.

Details:

  • Layer: 227

  • ID: 4EA9B3BF

Parameters:

  • peer (InputPeer) – Peer of which to get the balance.

  • ton (bool, optional) – If set, returns the channel/ad revenue balance in nanotons.

Returns:

payments.StarsStatus

TL Schema

payments.getStarsStatus#4ea9b3bf
flags:#
ton:flags.0?true
peer:InputPeer

= payments.StarsStatus

Parameter Tree

GetStarsStatus
├── ton → true (optional)
└── peer → InputPeer
├── InputPeerEmpty
├── InputPeerSelf
├── InputPeerChat
│ └── chat_id → long
├── InputPeerUser
│ ├── user_id → long
│ └── access_hash → long
├── InputPeerChannel
│ ├── channel_id → long
│ └── access_hash → long
├── InputPeerUserFromMessage
│ ├── peer → InputPeer
│ │ ├── InputPeerEmpty
│ │ ├── InputPeerSelf
│ │ ├── InputPeerChat
│ │ ├── InputPeerUser
│ │ ├── InputPeerChannel
│ │ ├── InputPeerUserFromMessage
│ │ └── InputPeerChannelFromMessage
│ ├── msg_id → int
│ └── user_id → long
└── InputPeerChannelFromMessage
├── peer → InputPeer
│ ├── InputPeerEmpty
│ ├── InputPeerSelf
│ ├── InputPeerChat
│ ├── InputPeerUser
│ ├── InputPeerChannel
│ ├── InputPeerUserFromMessage
│ └── InputPeerChannelFromMessage
├── msg_id → int
└── channel_id → long

Example

await app.invoke(
    GetStarsStatus(
        ton=None,
        peer=await app.resolve_peer(chat_id),
    )
)