Skip to main content
Module

x/grammy/core/api.ts>Api#getGameHighScores

The Telegram Bot Framework.
Very Popular
Go to Latest
method Api.prototype.getGameHighScores
import { Api } from "https://deno.land/x/grammy@v1.11.1/core/api.ts";

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. Returns an Array of GameHighScore objects.

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 his neighbors are not among them. Please note that this behavior is subject to change.

Parameters

chat_id: number

Unique identifier for the target chat

message_id: number

Identifier of the sent message

user_id: number

Target user id

optional
signal: AbortSignal

Optional AbortSignal to cancel the request

Official reference: https://core.telegram.org/bots/api#getgamehighscores