payments.GetStarsTransactions

class pyrogram.raw.functions.payments.GetStarsTransactions

Fetch Telegram Stars transactions.

Details:
  • Layer: 227

  • ID: 69DA4557

Parameters:
  • peer (InputPeer) – Fetch the transaction history of the peer (inputPeerSelf or a bot we own).

  • offset (str) – Offset for pagination, obtained from the returned next_offset, initially an empty string ».

  • limit (int 32-bit) – Maximum number of results to return, see pagination

  • inbound (bool, optional) – If set, fetches only incoming transactions.

  • outbound (bool, optional) – If set, fetches only outgoing transactions.

  • ascending (bool, optional) – Return transactions in ascending order by date (instead of descending order by date).

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

  • subscription_id (str, optional) – If set, fetches only transactions for the specified Telegram Star subscription ».

Returns:

payments.StarsStatus

TL Schema

payments.getStarsTransactions#69da4557
flags:#
inbound:flags.0?true
outbound:flags.1?true
ascending:flags.2?true
ton:flags.4?true
subscription_id:flags.3?string
peer:InputPeer
offset:string
limit:int

= payments.StarsStatus

Parameter Tree

GetStarsTransactions
├── inbound → true (optional)
├── outbound → true (optional)
├── ascending → true (optional)
├── ton → true (optional)
├── subscription_id → string (optional)
├── peer → InputPeer
│ ├── InputPeerEmpty
│ ├── InputPeerSelf
│ ├── InputPeerChat
│ │ └── chat_id → long
│ ├── InputPeerUser
│ │ ├── user_id → long
│ │ └── access_hash → long
│ ├── InputPeerChannel
│ │ ├── channel_id → long
│ │ └── access_hash → long
│ │ ├── peer → InputPeer
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── msg_id → int
│ │ └── user_id → long
│ ├── peer → InputPeer
│ │ ├── InputPeerEmpty
│ │ ├── InputPeerSelf
│ │ ├── InputPeerChat
│ │ ├── InputPeerUser
│ │ ├── InputPeerChannel
│ │ ├── InputPeerUserFromMessage
│ │ └── InputPeerChannelFromMessage
│ ├── msg_id → int
│ └── channel_id → long
├── offset → string
└── limit → int

Example

await app.invoke(
    GetStarsTransactions(
        inbound=None,
        outbound=None,
        ascending=None,
        ton=None,
        subscription_id="text",
        peer=await app.resolve_peer(chat_id),
        offset="text",
        limit=0,
    )
)