API Reference

This reference lists the public objects users normally import.

Package exportsPackage exportsPackage exports

Import	Purpose
AiohttpAdapter	aiohttp web framework adapter.
FastAPIAdapter	FastAPI adapter, available when FastAPI is installed.
SingleBotEngine	Engine for one configured Bot.
TokenEngine	Engine for token-based multi-bot webhook routes.
WebhookConfig	Telegram setWebhook options.
BotConfig	Bot defaults and shared session configuration for TokenEngine.

Route helpersRoute helpersRoute helpers

Import	Purpose
Route	Builds public webhook URLs and matches incoming requests.
BotIdParam	Path parameter mapped to Target.bot_id.
BotTokenParam	Path parameter mapped to Target.bot_token.
Const	Explicit constant query value.
Ref	Query value copied from a parsed route parameter.

Security helpersSecurity helpersSecurity helpers

Import	Purpose
Security	Runs secret-token and custom request checks.
StaticSecretToken	Static Telegram secret-token provider and verifier.
IPCheck	Allows requests from configured IP addresses and networks.
SecurityCheck	Protocol for custom checks.
SecretToken	Base class for custom secret-token providers.