GramJS

⚠️ This project is archived and no longer maintained. Development continues in teleproto, an actively maintained fork. It's largely compatible with GramJS for most projects, migration means little more than swapping the package:
npm install teleproto
See the migration guide for details.

stats.GetBroadcastStats

Get channel statistics

Example

const { Api, TelegramClient } = require("telegram");
const { StringSession } = require("telegram/sessions");

const session = new StringSession(""); // You should put your string session here
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
  await client.connect(); // This assumes you have already authenticated with .start()

  const result = await client.invoke(
    new Api.stats.GetBroadcastStats({
      channel: "username",
      dark: true,
    })
  );
  console.log(result); // prints the result
})();
import { Api, TelegramClient } from "telegram";
import { StringSession } from "telegram/sessions";

const session = new StringSession(""); // You should put your string session here
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
  await client.connect(); // This assumes you have already authenticated with .start()

  const result: Api.stats.BroadcastStats = await client.invoke(
    new Api.stats.GetBroadcastStats({
      channel: "username",
      dark: true,
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
flags#Flags, see TL conditional fields
darkflags.0?trueWhether to enable dark theme for graph colors
channelInputChannelThe channel

Result

stats.BroadcastStats

Possible errors

CodeTypeDescription
400BROADCAST_REQUIREDThis method can only be called on a channel, please use stats.getMegagroupStats for supergroups.
400CHANNEL_INVALIDThe provided channel is invalid.
400CHANNEL_PRIVATEYou haven't joined this channel/supergroup.
400CHAT_ADMIN_REQUIREDYou must be an admin in this chat to do this.

Can bots use this method?

No

Channel statistics

Telegram offers detailed channel statistics for channels and supergroups.