Payments

getStarTransactions()

Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.

parameters

parametertyperequireddescription
offsetnumberoptionalNumber of transactions to skip in the response
limitnumberoptionalThe maximum number of transactions to be retrieved. Values between 1-100 are accepted. Defaults to 100.

returns

StarTransactions

usage in yaebal

not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.

bot.ts
import type { GetStarTransactionsParams, StarTransactions } from "@yaebal/types";

await bot.api.call<StarTransactions>("getStarTransactions", {} satisfies GetStarTransactionsParams);