getBusinessAccountStarBalance()

Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success.

parameters

parameter	type	required	description
`business_connection_id`	string	required	Unique identifier of the business connection

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

await bot.api.call<StarAmount>("getBusinessAccountStarBalance", {
  business_connection_id: "...",
} satisfies GetBusinessAccountStarBalanceParams);

official Bot API docs: https://core.telegram.org/bots/api/#getbusinessaccountstarbalance