Payments

getMyStarBalance()

A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.

parameters

this method takes no parameters.

returns

StarAmount

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 { StarAmount } from "@yaebal/types";

await bot.api.call<StarAmount>("getMyStarBalance");