Get a Telegram channel

Try in Playground

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.

GET/v1/telegram/channelx-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

handlestringrequiredquery

Required public handle, @handle or HTTPS t.me/handle URL.

max 128 chars

Exampleexample

include_inventoryenumquery

Optional true or false; include channel media inventory with the profile.

one of: true, false

Response fields

requestIdstring

Random operational correlation ID.

Source attempts, decoded bytes, elapsed time and whether an active source request was shared.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

accounting.coalescedbooleanoptional

Optional.

successboolean

Whether usable profile data was returned.

statusenum

success, partial, failed or challenged.

one of: success, partial

Public channel and group metadata with rendered descriptions and audience counts.

profile.handlestring

Canonical lowercase username.

profile.urlstring

Canonical t.me URL.

absolute HTTPS URL

profile.entity_typeenum

channel, group, user_or_bot or unknown, based on the landing page.

one of: channel, group, user_or_bot, unknown

profile.namestring

Public display name.

min 1 chars

profile.descriptionstringnullable

Public description with visible inline text and rendered line breaks. Null when absent.

profile.avatar_urlstringnullable

Public HTTPS avatar URL, or null when absent.

profile.is_verifiedboolean

Whether the page displays a verified badge.

profile.subscriber_countintegernullable

Numeric channel subscriber count derived from the displayed count.

profile.subscriber_count_textstringnullable

Original displayed subscriber count, retaining abbreviations.

profile.member_countintegernullable

Public group member count; null for channels.

profile.member_count_textstringnullable

Original displayed member count, retaining abbreviations.

profile.online_countintegernullable

Group online count when shown, otherwise null.

profile.photo_countintegernullableoptional

Displayed inventory count when include_inventory=true; null when absent.

profile.video_countintegernullableoptional

Displayed inventory count when include_inventory=true; null when absent.

profile.file_countintegernullableoptional

Displayed inventory count when include_inventory=true; null when absent.

profile.link_countintegernullableoptional

Displayed inventory count when include_inventory=true; null when absent.

sourceUrlstring

Canonical public profile URL.

absolute HTTPS URL

fetchedAtstring

UTC retrieval timestamp.

Field coverage and extraction warnings.

coverage.sourceenum

Always included.

one of: public_page, public_preview

coverage.completeboolean

Always included.

coverage.warningsenum[]

Always included.

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
400	`invalid_request`	Missing, duplicate, unsupported or invalid parameters.
401	`unauthorized`	Missing or invalid service key.
403	`restricted_page`	Public page explicitly reports restricted access.
404	`not_found`	Missing profile or generic contact fallback.
429	`upstream_rate_limited`	No automatic retry.
502	`upstream_challenged` `unsupported_page`	Challenge, unrecognized page or identity mismatch.
502	`upstream_error` `unsafe_redirect` `response_too_large` `payload_too_complex` `request_limit`	Bounded retrieval failed.
503	`busy`	All worker slots occupied.
504	`timeout`	Deadline exceeded.
200	`partial`	Unknown entity type or unavailable displayed counts.

Code example

curl "https://api.scrapeatlas.com/v1/telegram/channel?handle=example" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/telegram/channel?handle=example",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/telegram/channel?handle=example",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`Telegram request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/telegram/channel",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "handle": "example"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/telegram/channel?handle=example", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/telegram/channel?handle=example"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "success": true,
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "profile": {
    "handle": "example",
    "url": "https://t.me/example",
    "entity_type": "channel",
    "name": "Example News",
    "description": "Synthetic public channel.",
    "avatar_url": "https://cdn1.telesco.pe/file/synthetic.jpg",
    "is_verified": false,
    "subscriber_count": 12345,
    "subscriber_count_text": "12 345",
    "member_count": null,
    "member_count_text": null,
    "online_count": null
  },
  "sourceUrl": "https://t.me/example",
  "fetchedAt": "2026-09-11T00:00:00.000Z",
  "coverage": {
    "source": "public_page",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 11000,
    "durationMs": 450
  }
}

Missing, duplicate, unsupported or invalid parameters.

{
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0,
    "coalesced": true
  },
  "success": false,
  "status": "failed",
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  }
}