---
title: "Get a Telegram channel"
method: GET
path: "/v1/telegram/channel"
tags: ["Telegram"]
---

# Get a Telegram channel

`GET /v1/telegram/channel`

## Request

- Base URL: `https://api.scrapeatlas.com`
- URL: `https://api.scrapeatlas.com/v1/telegram/channel`
- Auth: API key in header `x-api-key`

Read public Telegram channel and group metadata, descriptions, avatars and audience counts. Optionally include photo, video, file and link inventory. The channel and profile routes are equivalent. Each successful request costs 1 account credit, including partial results. Failed requests cost 0 credits.

## Query parameters

- `handle` string, required
- `include_inventory` 'true' | 'false'

## Response `200`

Inspect the response status and failure or coverage fields.

- union
  - object
    - `requestId` string, uuid, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
      - `coalesced` boolean
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `profile` object, required
      - `handle` string, required
      - `url` string, uri, required
      - `entity_type` 'channel' | 'group' | 'user_or_bot' | 'unknown', required
      - `name` string, required
      - `description` string, nullable, required
      - `avatar_url` string, uri, nullable, required
      - `is_verified` boolean, required
      - `subscriber_count` integer, nullable, required
      - `subscriber_count_text` string, nullable, required
      - `member_count` integer, nullable, required
      - `member_count_text` string, nullable, required
      - `online_count` integer, nullable, required
      - `photo_count` integer, nullable
      - `video_count` integer, nullable
      - `file_count` integer, nullable
      - `link_count` integer, nullable
    - `sourceUrl` string, uri, required
    - `fetchedAt` string, date-time, required
    - `coverage` object, required
      - `source` 'public_page' | 'public_preview', required
      - `complete` boolean, required
      - `warnings` string[], required
  - object
    - `requestId` string, uuid, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
      - `coalesced` boolean
    - `success` false, required
    - `status` 'failed' | 'challenged', required
    - `failure` object, required
      - `code` 'invalid_request' | 'unauthorized' | 'not_found' | 'upstream_challenged' | 'upstream_rate_limited' | 'upstream_error' | 'unsupported_page' | 'restricted_page' | 'response_too_large' | 'unsafe_redirect' | 'request_limit' | 'timeout' | 'busy' | 'payload_too_complex', required
      - `message` string, required

## Other responses

- `400`: Request could not complete; inspect error or failure.code.
- `401`: Request could not complete; inspect error or failure.code.
- `402`: Request could not complete; inspect error or failure.code.
- `403`: Request could not complete; inspect error or failure.code.
- `404`: Request could not complete; inspect error or failure.code.
- `408`: Request could not complete; inspect error or failure.code.
- `413`: Request could not complete; inspect error or failure.code.
- `429`: Request could not complete; inspect error or failure.code.
- `500`: Request could not complete; inspect error or failure.code.
- `502`: Request could not complete; inspect error or failure.code.
- `503`: Request could not complete; inspect error or failure.code.
- `504`: Request could not complete; inspect error or failure.code.

---

[API](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api.md) · [All operations](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/revisions/9ba049316894?raw)