get_chat_gifts()¶

Client.get_chat_gifts()¶

Get all gifts owned by specified chat.

Usable by Users Bots

Parameters:¶

• chat_id (int | str) – Unique identifier (int) or username (str) of the target chat. For your personal cloud (Saved Messages) you can simply use “me” or “self”. For a contact that exists in your Telegram address book you can use his phone number (str).

• exclude_unsaved (bool, optional) – Exclude unsaved star gifts.

• exclude_saved (bool, optional) – Exclude saved star gifts.

• exclude_unlimited (bool, optional) – Exclude unlimited star gifts.

• exclude_limited (bool, optional) – Exclude limited star gifts.

• exclude_upgraded (bool, optional) – Exclude upgraded star gifts.

• sort_by_value (bool, optional) – Sort star gifts by value.

• offset (str, optional) – Offset of the results to be returned.

• limit (int, optional) – Maximum amount of star gifts to be returned.

Returns:¶

Generator – A generator yielding Gift objects.

Example

async for gift in app.get_chat_gifts(chat_id):
    print(gift)