← Yaroslav Koval

Open-source project

telegram-me

Public Telegram channels as JSON: REST and GraphQL API over t.me with a Rust parser, a ranked multi-channel feed and one-command Docker deployment

View on GitHubWebsite

$ git clone https://github.com/koval01/telegram-me.git

README

TelegramMe

REST API for public Telegram channels. It turns t.me/s/<channel> into typed
JSON — channel profiles, posts with text entities, media, polls, reactions,
replies, forwards and buttons, pagination, previews and a ranked multi-channel
feed. No Telegram account or bot token needed.

Docs: English, Español, Русский ·
API reference: REST, GraphQL

Every instance also serves its own copy of the docs at /docs, the Swagger UI
at /api and GraphQL at /graphql.

No public instance

There is no public demo and there will not be one: run TelegramMe on your own
server or locally. The demo that ran at tme.koval-dev.org was switched off
for good, because applications used it as a free backend instead of running
their own instance, and a shared instance that sends anyone's traffic to t.me
can end up serving abuse. Self-hosting takes one command (below), and the
image serves the same API the demo did; to move off the demo, change the base
URL. Details: No public instance.

Run on your server

docker run -d --name telegram-me -p 8000:3000 --restart unless-stopped \
  ghcr.io/koval01/telegram-me:latest

With a shared cache and presets (recommended):

git clone https://github.com/koval01/telegram-me && cd telegram-me
docker compose up -d --wait            # API on :8000 + Valkey

Then try it: curl http://localhost:8000/v1/body/durov. To build it into
your app, run it next to the app on a private network, without a public port.

Configuration, multi-server deployment and reverse proxy setup:
deployment guide.

Run locally for development

git clone https://github.com/koval01/telegram-me && cd telegram-me
uv sync
uv run telegram-me serve --reload      # http://localhost:3000
make check                             # lint, types, tests

Requires uv. See the
development guide.

License

[Apache-2.0](LICENSE). telegram-me is not affiliated with Telegram. It reads
public t.me pages; the content it returns belongs to its authors, and whoever

[... continued on GitHub]

More projects

By Yaroslav Koval · Telegram · LinkedInHome