Function getStarsTransactions

  • getStarsTransactions(
        client: ITelegramClient,
        peerId: InputPeerLike,
        params?: {
            direction?: "incoming" | "outgoing";
            limit?: number;
            offset?: string;
            sort?: "asc" | "desc";
            subscriptionId?: string;
            ton?: boolean;
        },
    ): Promise<StarsStatus>

  • Get 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.

    Parameters

    • client: ITelegramClient
    • peerId: InputPeerLike

      Peer ID

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

      Additional parameters

      • Optionaldirection?: "incoming" | "outgoing"

        If passed, only transactions of this direction will be returned

      • Optionallimit?: number

        Pagination limit

        Default

        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

    Returns Promise<StarsStatus>

Settings

Member Visibility