getGameHighScores
Returns GameHighScore[] ↗
Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and their neighbors are not among them. Please note that this behavior is subject to change. .
Required: user_id · Optional: 3 parameters
Try it
TypeScript example · @effect-ak/tg-bot-client
import { makeTgBotClient } from "@effect-ak/tg-bot-client"
const client = makeTgBotClient({ bot_token: "YOUR_BOT_TOKEN" })
const result = await client.execute("get_game_high_scores", { user_id: 0})Parameters
user_id number Required
Target user id.
chat_id number
Required if inline_message_id is not specified. Unique identifier for the target chat.
message_id number
Required if inline_message_id is not specified. Identifier of the sent message.
inline_message_id string
Required if chat_id and message_id are not specified. Identifier of the inline message.
Related methods
getAvailableGifts · getBusinessAccountGifts · getBusinessAccountStarBalance · getBusinessConnection · getChat · getChatAdministrators · getChatGifts · getChatMember · getChatMemberCount · getChatMenuButton · getCustomEmojiStickers · getFile · getForumTopicIconStickers · getMe · getMyCommands · getMyDefaultAdministratorRights · getMyDescription · getMyName · getMyShortDescription · getMyStarBalance · getStarTransactions · getStickerSet · getUpdates · getUserChatBoosts · getUserGifts · getUserProfileAudios · getUserProfilePhotos · getWebhookInfo