---
title: "POST /getGameHighScores"
method: POST
path: "/getGameHighScores"
---

# POST /getGameHighScores

`POST /getGameHighScores`

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. On success, returns an *Array* of [GameHighScore](https://core.telegram.org/bots/api/#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.

## Request body

- object
  - `user_id` integer, required — Target user id
  - `chat_id` integer — Required if *inline\_message\_id* is not specified. Unique identifier for the target chat
  - `message_id` integer — 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

## Response `200`

- object
  - `ok` boolean, required
  - `result` GameHighScore[], required
    - `position` integer, required — Position in high score table for the game
    - `user` User, required — This object represents a Telegram user or bot.
      - `id` integer, required — Unique identifier for this user or bot
      - `is_bot` boolean, required — True, if this user is a bot
      - `first_name` string, required — User's or bot's first name
      - `last_name` string — *Optional*. User's or bot's last name
      - `username` string — *Optional*. User's or bot's username
      - `language_code` string — *Optional*. [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language
      - `can_join_groups` boolean — *Optional*. True, if the bot can be invited to groups. Returned only in [getMe](https://core.telegram.org/bots/api/#getme).
      - `can_read_all_group_messages` boolean — *Optional*. True, if [privacy mode](https://core.telegram.org/bots#privacy-mode) is disabled for the bot. Returned only in [getMe](https://core.telegram.org/bots/api/#getme).
      - `supports_inline_queries` boolean — *Optional*. True, if the bot supports inline queries. Returned only in [getMe](https://core.telegram.org/bots/api/#getme).
    - `score` integer, required — Score

## Other responses

- `default`

---

[API](https://skmtc.net/stoplight/apis/telegram-bot-api.md) · [All operations](https://skmtc.net/stoplight/apis/telegram-bot-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stoplight/telegram-bot-api/versions/be4bbb34b64a/schema)