telegram.channel

stable 2 credits

Public Telegram channel info from the web preview: title, description, subscribers, media counters.

GET /v1/telegram/channel

What you get#

One Telegram record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

Also known as: /telegram/profile on APIs that nest their paths. See Alternatives and equivalents.

What it costs#

2 credits for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`channel`	string	yes	(required)	Public channel username without @	max 32 chars; must match `[a-z][a-z0-9_]{3,31}`; trimmed, leading @ removed, lowercased

Request#

curl "https://api.onekey.dev/v1/telegram/channel?channel=durov" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Telegram response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "author": {
      "username": "durov",
      "displayName": "Pavel Durov",
      "followers": 10600000,
      "url": "https://t.me/durov",
      "avatarUrl": "https://cdn4.telesco.pe/file/UQ0wj_87_vOGsERgPVHR_vdAf9vuD6H5yO5uBw1Lfuke-cHI2BzLo_1--v4Cv-_roPWRyVKJ4om6X_Ru_W5frGBCgeVoWhfDnymoG7udRbGVTm7dlPrN8whw_zCyemse-RuCiTifZye339f9PuaotaNXzS3GRgaA6hDMw5Q1UWtcc1yP8FQ1bpjjIrWBe52qeC3DY_0pRPCjwyRz2gYF4SEZQu1hsfzeIqXyUB2KP9aJXJkZIFyL4P6TDyoI4JbHxRcIJHPhNtMSoV6XXKN5d1S-C04Rf0HD1VUd3FKmbWLKAJDFJwnsME28-6AoH2GAVbNwbzpETA_-DSPe6BkEkA.jpg",
      "verified": true
    },
    "content": {
      "text": "Founder of Telegram."
    },
    "ext": {
      "photos": 102,
      "videos": 46,
      "files": null,
      "links": 200
    }
  },
  "metadata": {
    "platform": "telegram",
    "endpoint": "channel",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 2,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`handle`	`author.username`	-
`title`	`author.displayName`	-
`subscribers`	`author.followers`	`toNumber`
`channelUrl`	`author.url`	`safeUrl`
`avatarUrl`	`author.avatarUrl`	`safeUrl`
`verified`	`author.verified`	`toBoolean`
`description`	`content.text`	-
`photos`	`ext.photos`	`toNumber`
`videos`	`ext.videos`	`toNumber`
`files`	`ext.files`	`toNumber`
`links`	`ext.links`	`toNumber`

Caching and freshness#

Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
Between 1 hour and 1 day the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
A "not found" is remembered for 5 minutes and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).