getUserGifts¶

Returns: OwnedGifts

class aiogram.methods.get_user_gifts.GetUserGifts(*, user_id: int, exclude_unlimited: bool | None = None, exclude_limited_upgradable: bool | None = None, exclude_limited_non_upgradable: bool | None = None, exclude_from_blockchain: bool | None = None, exclude_unique: bool | None = None, sort_by_price: bool | None = None, offset: str | None = None, limit: int | None = None, **extra_data: Any)[source]¶

Returns the gifts owned and hosted by a user. Returns aiogram.types.owned_gifts.OwnedGifts on success.

Source: https://core.telegram.org/bots/api#getusergifts

user_id: int¶: Unique identifier of the user

exclude_unlimited: bool | None¶: Pass True to exclude gifts that can be purchased an unlimited number of times

exclude_limited_upgradable: bool | None¶: Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique

exclude_limited_non_upgradable: bool | None¶: Pass True to exclude gifts that can be purchased a limited number of times and can’t be upgraded to unique

exclude_from_blockchain: bool | None¶: Pass True to exclude gifts that were assigned from the TON blockchain and can’t be resold or transferred in Telegram

exclude_unique: bool | None¶: Pass True to exclude unique gifts

sort_by_price: bool | None¶: Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.

offset: str | None¶: Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results

limit: int | None¶: The maximum number of gifts to be returned; 1-100. Defaults to 100

Usage¶

As bot method¶

result: OwnedGifts = await bot.get_user_gifts(...)

Method as object¶

Imports:

from aiogram.methods.get_user_gifts import GetUserGifts
alias: from aiogram.methods import GetUserGifts

With specific bot¶

result: OwnedGifts = await bot(GetUserGifts(...))