# Telegram Channel (`telegram.channel`)

Public Telegram channel profile: title, description, avatar, verified badge, subscriber count and media counters.

Docs: https://primaryapi.com/docs/api-reference/telegram/channel

- Endpoint: `POST https://api.primaryapi.com/v1/run/telegram.channel`
- Category: Social · Platform: `telegram` · Kind: lookup · Status: live
- Price: 1 credit per call; up to 3 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=telegram.channel`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `handle` | string | yes |  | max 200 chars | Public Telegram channel username, with or without the @ (e.g. "telegram"), or its t.me link. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `handle` | string |  |
| `url` | string | https://t.me/{handle} |
| `title` | string \| null |  |
| `description` | string \| null |  |
| `avatarUrl` | string \| null |  |
| `verified` | boolean \| null |  |
| `subscribers` | integer \| null | Subscribers (members for public groups). |
| `photoCount` | integer \| null |  |
| `videoCount` | integer \| null |  |
| `fileCount` | integer \| null |  |
| `linkCount` | integer \| null |  |
| `previewEnabled` | boolean \| null | false when the channel has no public web preview (t.me/s/…) |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/telegram.channel" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"handle":"telegram"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "handle": "telegram",
      "url": "https://t.me/telegram",
      "title": "Telegram News",
      "description": "The official Telegram on Telegram. Much recursion. Very Telegram. Wow.",
      "avatarUrl": "https://cdn1.telesco.pe/file/TLClicLFnNSxNTqUlCBjZT1o…NBFQ.jpg",
      "verified": true,
      "subscribers": 9215986,
      "photoCount": 16,
      "videoCount": 228,
      "fileCount": null,
      "linkCount": 378,
      "previewEnabled": true
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}
```

## Pricing and reliability

- Usual price: 1 credit per call
- Price ceiling: up to 3 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=telegram.channel`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

Private channels, invite links, personal accounts and channels without a public preview are not covered.

## Legal

Public channel metadata; channel titles and descriptions can identify people. Callers need a lawful basis under GDPR/CCPA.

