What you get#
Onekey exposes Telegram as 4 endpoints behind one API key: 2 endpoints return one record (data is an object) and 2 endpoints return a list (data is an array). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for Telegram also works for the rest of the messaging & communities category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
channel | Public Telegram channel info from the web preview: title, description, subscribers, media counters. | channel* | 2 | stable |
post | Get Telegram post. | url* | 2 | beta needs a pack |
posts | Latest public posts of a Telegram channel from the web preview (t.me/s): text, time, views, media. | channel* | 1 | stable |
search | Search public Telegram channels by keyword. | query*, region | 2 | beta needs a pack |
A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.
Make a request#
This calls telegram.channel (2 credits, stable). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.
curl "https://api.onekey.dev/v1/telegram/channel?channel=durov" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from Telegram, with the same names as on every other platform. The count is how many of its 4 mapped endpoints return the field; a field the source lacks is null, never missing. 5 platform-specific fields (ext.<name>) come on top, documented on each endpoint page.
| Field | Type | Endpoints |
|---|---|---|
content.text | string | 4 |
author.displayName | string | 3 |
content.url | URL | 3 |
author.url | URL | 2 |
author.username | string | 2 |
content.createdAt | ISO 8601 date | 2 |
content.id | string | 2 |
content.title | string | 2 |
engagement.views | integer | 2 |
media.thumbnailUrl | URL | 2 |
author.avatarUrl | URL | 1 |
author.followers | integer | 1 |
author.verified | boolean | 1 |
engagement.comments | integer | 1 |
engagement.likes | integer | 1 |
engagement.shares | integer | 1 |
media.url | URL | 1 |
The full schema is in Unified schema.
Pricing#
Telegram calls cost 1 to 2 credits, flat per endpoint. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.