API Documentation

overview

The Telegram Index API allows you to access metadata for Telegram groups, channels, and bots at very low prices. This documentation covers the available endpoints, parameters, and usage examples.

Search Endpoint

Find groups, channels, and bots based on various criteria

Metadata Endpoint

Fetch detailed information about specific Telegram entities

search endpoint

        /search?query=bitcoin&cat=Technology%20&%20Programming&page=1&sort=asc&min_members=0&max_members=1000&type=all
      

parameters

Parameter	Type	Description
query	string	Defines the search keyword or term. Primary input for retrieving relevant results.
cat	string	Filters results based on predefined categories. If omitted, results from all categories will be included.
page	integer	Determines the page number for paginated results. First page is 1.
min_members / max_members	integer	Filters results based on member count. Range: 0 to 100,000,000.
type	string	Filters by type: channel, group, bot. If omitted, all types included.
sort	string	Sorting order: asc (ascending), desc (descending), rlvn (relevance).

available categories

Technology & Development

Technology & Programming
Ethical Hacking & Cybersecurity
Blockchain & Web3
AI & Machine Learning

Finance & Business

Cryptocurrency & Trading
Business & Finance
Investing & Stock Market
Startup & Entrepreneurship

Entertainment & Media

Gaming & Esports
Movies & TV Shows
Anime & Manga
Music & Audio

Lifestyle & Interests

Food & Cooking
Travel & Tourism
Health & Wellness
DIY & Hobbies

example queries

Basic Search

/search?query=python

Returns all results related to "python" across all categories.

Filter by Category

/search?query=crypto&cat=Cryptocurrency%20&%20Trading

Returns only crypto results in the Cryptocurrency & Trading category.

Filter by Type

/search?query=fitness&type=group

Returns only groups related to "fitness".

Filter by Member Count

/search?query=startup&min_members=1000&max_members=50000

Returns results where member count is between 1,000 and 50,000.

sample response

{
        "success": true,
        "total_results": 42,
        "page": 1,
        "results": [
        {
        "id": "python_community",
        "title": "Python Programming Community",
        "link": "python_community",
        "type": "group",
        "members": 25430,
        "category": "Technology & Programming",
        "description": "Community for Python developers...",
        "picture_url": "https://telegramindex.org/pictures/python_community.jpg"
        }
        ]
        }

metadata endpoint

Use this endpoint to fetch detailed information about specific Telegram entities.

/fetch?link=https://t.me/telegram

Parameter	Type	Description
link	string	The Telegram invite link of group/channel or bot to retrieve metadata.

notes and best practices

Parameters are case-insensitive but must be URL-encoded when necessary (spaces = %20)
If multiple filters are applied, results will match all conditions (AND logic)
Sorting by relevance (rlvn) is recommended for general searches
For best performance, avoid requesting large page numbers in a single request