# Telegram on Onekey

> 4 endpoints for Telegram (2 stable, 2 beta), 1 to 2 credits each. Category: Messaging & communities. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.
Access: 2 of 4 endpoints are marked "needs a pack" or "may need a pack": free-grant credits reach only the open fetch path; a verified email and a purchased pack unlock the rest.

Page: https://onekey.dev/platforms/telegram
Reference (Markdown): https://onekey.dev/docs/api/telegram.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 4 mapped Telegram endpoints return each:

- `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
- plus 5 platform-specific fields under `ext.`

## Endpoints

### telegram.channel

Public Telegram channel info from the web preview: title, description, subscribers, media counters.
- Price: 2 credits per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/telegram/channel?channel=durov` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `channel` (string, required): Public channel username without @
- Fields returned: `author.username`, `author.displayName`, `author.followers`, `author.url`, `author.avatarUrl`, `author.verified`, `content.text`, `ext.photos`, `ext.videos`, `ext.files`, `ext.links`
- Reference: https://onekey.dev/docs/api/telegram/channel.md

### telegram.post

Get Telegram post.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/telegram/post?url=https%3A%2F%2Ft.me%2Ftelegram%2F123` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `url` (string, required): Url (URL)
- Fields returned: `content.id`, `content.url`, `content.title`, `content.text`, `content.createdAt`, `engagement.likes`, `engagement.comments`, `engagement.shares`, `engagement.views`, `media.thumbnailUrl`, `author.username`
- Reference: https://onekey.dev/docs/api/telegram/post.md

### telegram.posts

Latest public posts of a Telegram channel from the web preview (t.me/s): text, time, views, media.
- Price: 1 credit per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/telegram/posts?channel=durov` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `channel` (string, required): Public channel username without @
- Fields returned: `content.id`, `content.url`, `content.text`, `content.createdAt`, `engagement.views`, `author.displayName`, `media.url`, `media.thumbnailUrl`, `ext.forwardedFrom`
- Reference: https://onekey.dev/docs/api/telegram/posts.md

### telegram.search

Search public Telegram channels by keyword.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/telegram/search?query=crypto%20news` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `query` (string, required): Keywords describing the channels to find. Keywords only; a site operator is refused (the search is already limited to t.me).
  - `region` (string, optional, default us): Two-letter country code whose results to prefer
- Fields returned: `content.url`, `content.title`, `content.text`, `author.url`, `author.displayName`
- Reference: https://onekey.dev/docs/api/telegram/search.md

## Sample request

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