Zero dependencies nodejs module to fetch info about a Telegram username or URL.
It can get information from invite links, channel/group/user/bots links, usernames and invite codes. Such as:
https://t.me/username
https://t.me/username/123
https://t.me/s/username
https://t.me/username_bot
https://t.me/+invite_code
https://t.me/joinchat/invite_code
tg:https://resolve?domain=username
tg:https://join?invite=invite_code
username
@username
+invite_code
It cannot get information from links to messages in private channels or groups, links with a phone number, any links with identifiers in the URL, and phone numbers. Such as:
https://t.me/+79261234567
https://t.me/c/1319741318/7290
tg:https://resolve?phone=79261234567
tg:https://privatepost?channel=1319741318&post=7290
+79261234567
- Convert input to Telegram Web URL;
- Fetch it;
- Parse it.
Important: It doesn't work with Telegram API.
Install it as a global package:
npm install -g tginfo
tginfo mr_ozioOr run it without installation using npx:
npx tginfo https://t.me/mr_ozioOutput be like:
$ tginfo durov
Durov's Channel
───────────────
Type Public Group
Verified true
Username @durov
Info “Thoughts from the Product Manager / CEO / Founder of Telegram.”
Subscribers 669,452
Telegram URL tg:https://resolve?domain=durov
Web URL https://t.me/durov
Image https://cdn1.telegram-cdn.org/file/uJ8Xy...7kp1w.jpg
Usage: tginfo <slug/url> [options...]
Options:
--attrs=ATTR1,ATTR2 display only specific attributes
--json display JSON instead of a human readable view
--help print this message
--version display version
Install it using command npm install tginfo.
import tginfo from 'tginfo'
await tginfo(input)
await tginfo(input, attributes)
await tginfo(input, attributes, throwOnError)A string with Telegram URL or slug.
An array of the attributes you need to have in output.
A boolean flag whose inclusion throws an exception if any error occurs.
An object with values:
{
type: 'user' | 'bot' | 'private_channel' | 'public_channel' | 'private_group' | 'public_group';
title: string;
webUrl: string;
tgUrl: string;
username?: string;
info?: string;
verified?: boolean;
previewUrl?: string;
subscribers?: number;
members?: number;
online?: number;
image?: string;
}If some error will happen then returning object will be:
{
error: string;
webUrl?: string;
}You don't need to add error to attributes, it will be there anywhay and existance of error field could be (and should be) used as error flag.
| user | bot | private_channel | public_channel | private_group | public_group | |
|---|---|---|---|---|---|---|
| type | 🟩 | 🟩 | 🟩 | 🟩 | 🟩 | 🟩 |
| webUrl | 🟩 | 🟩 | 🟩 | 🟩 | 🟩 | 🟩 |
| tgUrl | 🟩 | 🟩 | 🟩 | 🟩 | 🟩 | 🟩 |
| title | 🟩 | 🟩 | 🟩 | 🟩 | 🟩 | 🟩 |
| username | 🟩 | 🟩 | 🟥 | 🟩 | 🟥 | 🟩 |
| image | 🟧 | 🟧 | 🟧 | 🟧 | 🟧 | 🟧 |
| info | 🟧 | 🟧 | 🟧 | 🟧 | 🟧 | 🟧 |
| verified | 🟧 | 🟧 | 🟥 | 🟧 | 🟥 | 🟥 |
| previewUrl | 🟥 | 🟥 | 🟥 | 🟩 | 🟥 | 🟥 |
| subscribers | 🟥 | 🟥 | 🟥 | 🟩 | 🟩 | 🟥 |
| members | 🟥 | 🟥 | 🟥 | 🟥 | 🟥 | 🟩 |
| online | 🟥 | 🟥 | 🟥 | 🟥 | 🟥 | 🟧 |
- 🟩 Always available
- 🟧 Depends on profile
- 🟥 Not available
MIT © Nikolay Solovyov