payments.getStarsTransactions

Fetch Telegram Stars transactions.

The inbound and outbound flags are mutually exclusive: if none of the two are set, both incoming and outgoing transactions are fetched.

payments.starsStatus#8cf4ee60 flags:# balance:long history:Vector<StarsTransaction> next_offset:flags.0?string chats:Vector<Chat> users:Vector<User> = payments.StarsStatus;
---functions---
payments.getStarsTransactions#97938d5a flags:# inbound:flags.0?true outbound:flags.1?true ascending:flags.2?true peer:InputPeer offset:string limit:int = payments.StarsStatus;

Parameters

Name Type Description
flags # Flags, see TL conditional fields
inbound flags.0?true If set, fetches only incoming transactions.
outbound flags.1?true If set, fetches only outgoing transactions.
ascending flags.2?true Return transactions in ascending order by date (instead of descending order by date).
peer InputPeer Fetch the transaction history of the peer (inputPeerSelf or a bot we own).
offset string Offset for pagination, obtained from the returned next_offset, initially an empty string ยป.
limit int Maximum number of results to return, see pagination

Result

payments.StarsStatus

Possible errors

Code Type Description
400 CHAT_ADMIN_REQUIRED You must be an admin in this chat to do this.
400 PEER_ID_INVALID The provided peer id is invalid.

Bots can use this method

Related pages

inputPeerSelf

Defines the current user.

Pagination in the API

How to fetch results from large lists of objects.

Telegram Stars

Telegram Stars are virtual items that allow users to purchase digital goods and services from bots and mini apps inside the Telegram ecosystem, send gifts to content creators on the Telegram platform, and more.