Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/OPENNOVA2026/telegram-connector/llms.txt

Use this file to discover all available pages before exploring further.

Telegram Connector is a self-hosted REST API that wraps Telethon with FastAPI, so you can integrate Telegram features into any application without handling the MTProto protocol directly. Sign in with your Telegram account, list and join channels, and retrieve messages by time range — all through simple HTTP calls.

Quickstart

Build the Docker image, configure credentials, and make your first API call in minutes.

API Reference

Explore every endpoint — authentication, channels, and messages — with request/response schemas.

Configuration

Learn about all environment variables, from Telegram API credentials to AWS S3 session storage.

Deployment

Deploy to production with Docker or run in development mode with live reload.

What You Can Do

Authenticate

Sign in with your Telegram phone number and receive a one-time code — no bot token needed.

Manage Channels

List all your Telegram channels, join new ones by username, or leave channels programmatically.

Fetch Messages

Retrieve messages from all subscribed channels filtered by a start and end time window.

How It Works

1

Obtain Telegram API credentials

Register your application at my.telegram.org to get an api_id and api_hash.
2

Run the service

Build and start the Docker container with your credentials. The service listens on port 5000.
3

Sign in to your Telegram account

Call POST /sign_in with your phone number. Telegram sends a code to your Telegram app — submit it to complete authentication.
4

Start making API calls

With an active session, call GET /channels to list your channels or GET /messages to fetch messages from a time range.
Telegram Connector uses the MTProto user API (via Telethon), not the Bot API. This means you authenticate as a regular Telegram user account, giving you access to all channels and chats you’re a member of.

Build docs developers (and LLMs) love