Developer documentation

Telegram API reference: method and type index

Search Telegram API, TDLib and Bot API methods and types on GetTGAPI, then open the matching official signatures and parameter references.

GetTGAPI editorial teamUpdated
Documentation notesReviewed

Source revision a94b83d67ab4 · TDLib contributors · BSL-1.0

Based on official sources and independently maintained by GetTGAPI. Documentation and glossary →

On this page
  1. Choose the interface you actually use
  2. Check versions before using a signature

Choose the interface you actually use

Bot API is an HTTPS interface, TDLib is a client library, and the Telegram API schema describes client-protocol operations. Similar names do not make their parameters, identifiers or authentication interchangeable.

This directory indexes methods and constructors from a pinned TDLib repository snapshot, plus Bot API method and object names checked for this release. It is a reference index, not thousands of independently translated articles. Follow an entry for its official parameter documentation.

Check versions before using a signature

TDLib and Telegram-schema entries point to pinned source declarations. Bot API links point to current official sections; consult its changelog for changes. These surfaces do not share one release schedule.

After finding a name, check optional fields, return type, permissions, errors and updates. Reconcile unknown results instead of simply repeating the request.

6481 references found

Expand a group or search by name. Open an entry for its official definition.

Bot API · Methods185
Bot API · Types400
TDLib · Methods1065
TDLib · Constructors2260
Telegram API · Methods856
Telegram API · Constructors1715
Source license and attribution · BSL-1.0

TDLib contributors · Full license file

Boost Software License - Version 1.0 - August 17th, 2003

Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:

The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.