StarGift#

class pyrogram.raw.types.StarGift#

Represents a star gift, see here for more info.

Constructor of StarGift.

Details:

  • Layer: 225

  • ID: 313A9547

Parameters:

  • id (int 64-bit) – Identifier of the gift

  • sticker (Document) – Sticker that represents the gift.

  • stars (int 64-bit) – Price of the gift in Telegram Stars.

  • convert_stars (int 64-bit) – The receiver of this gift may convert it to this many Telegram Stars, instead of displaying it on their profile page.convert_stars will be equal to stars only if the gift was bought using recently bought Telegram Stars, otherwise it will be less than stars.

  • limited (bool, optional) – Whether this is a limited-supply gift.

  • sold_out (bool, optional) – Whether this gift sold out and cannot be bought anymore.

  • birthday (bool, optional) – Whether this is a birthday-themed gift

  • require_premium (bool, optional) – This gift can only be bought by users with a Premium subscription.

  • limited_per_user (bool, optional) – If set, the maximum number of gifts of this type that can be owned by a single user is limited and specified in per_user_total, and the remaining slots for the current user in per_user_remains.

  • peer_color_available (bool, optional) – If set, collectible gifts of this type may be used to generate a message color palette and pattern ».

  • auction (bool, optional) – If set, this is a collectible gift that can only be bought through a collectible gift auction ».

  • availability_remains (int 32-bit, optional) – For limited-supply gifts: the remaining number of gifts that may be bought.

  • availability_total (int 32-bit, optional) – For limited-supply gifts: the total number of gifts that was available in the initial supply.

  • availability_resale (int 64-bit, optional) – The total number of (upgraded to collectibles) gifts of this type currently on resale

  • first_sale_date (int 32-bit, optional) – For sold out gifts only: when was the gift first bought.

  • last_sale_date (int 32-bit, optional) – For sold out gifts only: when was the gift last bought.

  • upgrade_stars (int 64-bit, optional) – The number of Telegram Stars the user can pay to convert the gift into a collectible gift ».

  • resell_min_stars (int 64-bit, optional) – The minimum price in Stars for gifts of this type currently on resale.

  • title (str, optional) – Title of the gift

  • released_by (Peer, optional) – This gift was released by the specified peer.

  • per_user_total (int 32-bit, optional) – Maximum number of gifts of this type that can be owned by any user.

  • per_user_remains (int 32-bit, optional) – Remaining number of gifts of this type that can be owned by the current user.

  • locked_until_date (int 32-bit, optional) – If set, the specified gift possibly cannot be sent until the specified date, see here » for the full flow.

  • auction_slug (str, optional) – Always set for gifts that can be bought on auctions », contains the auction deep link slug ».

  • gifts_per_round (int 32-bit, optional) – Always set for gifts that can be bought on auctions », contains the number of gifts of this kind that are distributed on every round.

  • auction_start_date (int 32-bit, optional) – Always set for gifts that can be bought on auctions », contains the UNIX timestamp indicating when will the auction start (or when the auction started, if it points to the past).

  • upgrade_variants (int 32-bit, optional) – Total number of possible collectible variants » for this gift type.

  • background (StarGiftBackground, optional) – Default background palette for this gift type, used when rendering gift cards and previews before a specific collectible backdrop is chosen.