data-model.md

title	Data model and options
description	Typed dictionaries, enums, and option objects returned or accepted by the public API.

Source snapshot: b60df7aaa2b597e7647a3b851b8e552a80943015 · package version 1.1.0.

Typed dictionaries, enums, and option objects returned or accepted by the public API.

Every entry links to its immutable line-level source declaration.

ChatType

class ChatType(str, Enum)

Type of chat.

Public members

• SENDER = 'sender'
• PRIVATE = 'private'
• GROUP = 'group'
• SUPERGROUP = 'supergroup'
• CHANNEL = 'channel'

View the pinned source declaration

User

class User(TypedDict)

Telegram user object.

Public members

• id: int
• first_name: str
• last_name: Optional[str]
• username: Optional[str]
• language_code: Optional[str]
• is_bot: Optional[bool]
• is_premium: Optional[bool]
• added_to_attachment_menu: Optional[bool]
• allows_write_to_pm: Optional[bool]
• photo_url: Optional[str]

View the pinned source declaration

Chat

class Chat(TypedDict)

Telegram chat object.

Public members

• id: int
• type: ChatType
• title: Optional[str]
• username: Optional[str]
• photo_url: Optional[str]

View the pinned source declaration

InitData

class InitData(TypedDict)

Telegram Mini App initialization data.

Public members

• query_id: Optional[str]
• user: Optional[User]
• receiver: Optional[User]
• chat: Optional[Chat]
• chat_type: Optional[ChatType]
• chat_instance: Optional[str]
• start_param: Optional[str]
• can_send_after: Optional[int]
• auth_date: int
• hash: str
• signature: Optional[str]

View the pinned source declaration

ValidateOptions

class ValidateOptions(TypedDict)

Options for validation functions.

Public members

• expires_in: int

View the pinned source declaration

Validate3rdOptions

class Validate3rdOptions(TypedDict)

Options for third-party validation.

Public members

• expires_in: int
• test: bool

View the pinned source declaration