payments.GetSuggestedStarRefBots

class pyrogram.raw.functions.payments.GetSuggestedStarRefBots

Obtain a list of suggested mini apps with available affiliate programs

Details:
  • Layer: 227

  • ID: D6B48F7

Parameters:
  • peer (InputPeer) – The peer that will become the affiliate: star commissions will be transferred to this peer’s star balance.

  • offset (str) – Offset for pagination, taken from payments.suggestedStarRefBots.next_offset, initially empty.

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

  • order_by_revenue (bool, optional) – If set, orders results by the expected revenue

  • order_by_date (bool, optional) – If set, orders results by the creation date of the affiliate program

Returns:

payments.SuggestedStarRefBots

TL Schema

payments.getSuggestedStarRefBots#d6b48f7
flags:#
order_by_revenue:flags.0?true
order_by_date:flags.1?true
peer:InputPeer
offset:string
limit:int

= payments.SuggestedStarRefBots

Parameter Tree

GetSuggestedStarRefBots
├── order_by_revenue → true (optional)
├── order_by_date → true (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(
    GetSuggestedStarRefBots(
        order_by_revenue=None,
        order_by_date=None,
        peer=await app.resolve_peer(chat_id),
        offset="text",
        limit=0,
    )
)