Documentation - v0.27.0
    Preparing search index...
    • Iterate over Telegram Stars transactions for a given peer.

      You can either pass self to get your own transactions, or a chat/bot ID to get transactions of that peer.

      Wrapper over getStarsTransactions

      Parameters

      • client: ITelegramClient
      • peerId: InputPeerLike

        Peer ID

      • Optionalparams: {
            direction?: "incoming" | "outgoing";
            limit?: number;
            offset?: string;
            sort?: "asc" | "desc";
            subscriptionId?: string;
            ton?: boolean;
        } & { chunkSize?: number; limit?: number }

        Additional parameters

        • Optionaldirection?: "incoming" | "outgoing"

          If passed, only transactions of this direction will be returned

        • Optionallimit?: number

          Pagination limit

          100
          
        • Optionaloffset?: string

          Pagination offset

        • Optionalsort?: "asc" | "desc"

          Direction to sort transactions date by (default: desc)

        • OptionalsubscriptionId?: string

          If passed, will only return transactions related to this subscription ID

        • Optionalton?: boolean

          Whether to return transactions made in TON

        • OptionalchunkSize?: number

          Number of boosters to fetch per request Usually you don't need to change this

          100
          
        • Optionallimit?: number

          Total number of boosters to fetch

          Infinity, i.e. fetch all boosters
          

      Returns AsyncIterableIterator<StarsTransaction>