Telegram public channel API
Name, description, avatar, verification, member count and media counters of a public channel or group, read from Telegram's public web preview (no Teleg...
GET /v1/telegram/channel
GET /v1/telegram/channel
Name, description, avatar, verification, member count and media counters of a public channel or group, read from Telegram's public web preview (no Telegram account). Private and invite-only chats are not supported.
- Cost: 1 credit
- Cache: Results are kept up to 30 days; send
max_age_daysto reuse them for free. - Timeout: A request still running after about 25 seconds answers
202with a job to poll (Batch and jobs).
Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
handle | string | one of | Channel username, without @. Also accepted as username. |
url | URL | one of | Channel URL (t.me/<name>). Accepted hosts: t.me, telegram.me. |
Send at least one of handle, url. If you send several, the first listed is used and the rest are ignored.
Every request also accepts:
trim:truefor a smaller response withoutnullfields andextra.raw:trueto also get the platform's original object asraw.max_age_days: accept a cached result up to this many days old, for 0 credits (Caching).
Example request#
Set your key in the environment first (see Authentication).
1curl -G "https://api.socialscrape.dev/v1/telegram/channel" \2 -H "x-api-key: $SOCIALSCRAPE_API_KEY" \3 --data-urlencode "handle=durov"1import os2import requests34params = {5 "handle": "durov",6}7res = requests.get(8 "https://api.socialscrape.dev/v1/telegram/channel",9 headers={"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]},10 params=params,11)12body = res.json()1314if body["ok"]:15 print(body["data"])16else:17 print(body["error"]["code"], body["error"]["message"])1const url = new URL("https://api.socialscrape.dev/v1/telegram/channel");2url.search = new URLSearchParams({3 "handle": "durov"4}).toString();5const res = await fetch(url, {6 headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY! },7});8const body = await res.json();910if (body.ok) {11 console.log(body.data);12} else {13 console.error(body.error.code, body.error.message);14}1{2 "nodes": [3 {4 "name": "SocialScrape Telegram public channel",5 "type": "n8n-nodes-base.httpRequest",6 "typeVersion": 4.2,7 "position": [8 0,9 010 ],11 "parameters": {12 "method": "GET",13 "url": "https://api.socialscrape.dev/v1/telegram/channel",14 "sendQuery": true,15 "queryParameters": {16 "parameters": [17 {18 "name": "handle",19 "value": "durov"20 }21 ]22 },23 "sendHeaders": true,24 "headerParameters": {25 "parameters": [26 {27 "name": "x-api-key",28 "value": "={{ $env.SOCIALSCRAPE_API_KEY }}"29 }30 ]31 }32 }33 }34 ],35 "connections": {}36}Example response#
This is a sample from a recorded response, lists and long text are shortened. Status 200.
1{2 "ok": true,3 "credits_charged": 1,4 "credits_remaining": 4999,5 "cached": false,6 "cached_at": null,7 "request_id": "req_08e7e0a500aac8057ac41e6f",8 "data": {9 "object": "community",10 "platform": "telegram",11 "id": null,12 "url": "https://t.me/durov",13 "kind": "channel",14 "name": "durov",15 "title": "Pavel Durov",16 "description": "Founder of Telegram.",17 "avatar_url": "https://cdn4.telesco.pe/file/E1fT1nGQ1lDmNdTpfhudwrMtUB-bHaQjPg9dJWmN5KP932jw4thhnQURK4_DTwLtKMB7u9r6HqRQSNTZSDpohG0KFjyvUfvqBOMBoBgotUycPBIRIdO6jbVgVFfa2R8DlhaMN_qmA-2ItIIYREsJPt_YGGFq4FAWNchY0p7d09c15aL4NiQh5viq8ID4ddleu6IXRPJ8iSw8tRzkWMN...",18 "banner_url": null,19 "member_count": 10201685,20 "online_count": null,21 "is_nsfw": null,22 "is_private": null,23 "verified": true,24 "created_at": null,25 "extra": {26 "link_count": 200,27 "member_count_text": "10.2M",28 "photo_count": 102,29 "video_count": 4730 }31 },32 "cursor": null,33 "has_more": null34}Response#
A Community object in data.
See Data models for every field. The envelope around data is described in Responses.
Errors#
Failures are free: credits_charged is 0. Branch on error.code, never on the message.
| Code | HTTP | Retry | Meaning |
|---|---|---|---|
invalid_params | 400 | no | A parameter is missing, unknown or has the wrong type. |
unsupported_url | 400 | no | The URL is not one this endpoint accepts (wrong platform or form). |
not_found | 404 | no | The platform says this profile, post or item does not exist. |
Every request can also fail with the account and platform errors listed on the Errors page.
Example error:
1{2 "ok": false,3 "error": {4 "code": "not_found",5 "message": "The platform says this profile, post or item does not exist.",6 "retryable": false7 },8 "credits_charged": 0,9 "request_id": "req_9a020f18de7996e272c57fef"10}Related endpoints#
- Telegram public channel posts (
GET /v1/telegram/channel/posts) - Telegram public post (
GET /v1/telegram/post)