Gift

class pyrogram.types.Gift

Describes a gift that can be sent to another user.

Parameters:

  • id (int) – Unique identifier of the gift.

  • sticker (Sticker) – The sticker representing the gift.

  • star_count (int) – Number of Telegram Stars that must be paid for the gift.

  • default_sell_star_count (int) – Number of Telegram Stars that can be claimed by the receiver instead of the gift by default. If the gift was paid with just bought Telegram Stars, then full value can be claimed.

  • remaining_count (int, optional) – Number of remaining times the gift can be purchased by all users; None if not limited or the gift was sold out.

  • total_count (int, optional) – Number of total times the gift can be purchased by all users; None if not limited.

  • first_send_date (datetime, optional) – Point in time (Unix timestamp) when the gift was send for the first time; for sold out gifts only.

  • last_send_date (datetime, optional) – Point in time (Unix timestamp) when the gift was send for the last time; for sold out gifts only.

  • is_limited (bool, optional) – True, if the number of gifts is limited.

  • is_sold_out (bool, optional) – True, if the star gift is sold out.

  • is_birthday (bool, optional) – True, if it is a birthday gift.

  • can_upgrade (bool, optional) – True, if the gift can be upgraded.

  • require_premium (bool, optional) – True, if the gift requires Telegram Premium to be sent.

  • is_limited_per_user (bool, optional) – True, if the gift is limited per user.

  • is_peer_color_available (bool, optional) – True, if peer color is available for this gift.

  • is_auction (bool, optional) – True, if the gift is an auction gift.

  • availability_resale (int, optional) – Number of Telegram Stars required to resale the gift.

  • upgrade_stars (int, optional) – Number of Telegram Stars required to upgrade the gift.

  • resell_min_stars (int, optional) – Minimum number of Telegram Stars required to resale the gift.

  • title (str, optional) – Gift title.

  • released_by (int, optional) – Identifier of the user who released the gift.

  • per_user_total (int, optional) – Total number of gifts allowed per user.

  • per_user_remains (int, optional) – Number of remaining gifts allowed per user.

  • locked_until_date (datetime, optional) – Point in time when the gift will be unlocked.

  • auction_slug (str, optional) – Auction slug.

  • gifts_per_round (int, optional) – Number of gifts per auction round.

  • auction_start_date (datetime, optional) – Point in time when the auction starts.

  • upgrade_variants (int, optional) – Number of upgrade variants.

  • is_unique (bool, optional) – True, if the gift is unique.

  • gift_id (int, optional) – Unique identifier of the gift.

  • slug (str, optional) – Gift slug.

  • num (int, optional) – Gift number.

  • owner_id (int, optional) – Identifier of the user who owns the gift.

  • owner_name (str, optional) – Name of the user who owns the gift.

  • owner_address (str, optional) – Address of the user who owns the gift.

  • gift_address (str, optional) – Gift address.

  • value_amount (int, optional) – Gift value amount.

  • value_currency (str, optional) – Gift value currency.

  • value_usd_amount (int, optional) – Gift value USD amount.

  • craft_chance_permille (int, optional) – Craft chance in permille.