StarGift

class pyrogram.types.StarGift

A star gift.

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

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

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

  • convert_stars (int) – Amount of Stars the receiver can convert this gift to.

  • 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.

  • can_upgrade (bool, optional) – Whether this gift can be upgraded to a collectible.

  • require_premium (bool, optional) – Whether this gift can only be bought by Premium users.

  • availability_remains (int, optional) – For limited-supply gifts: remaining number of gifts available.

  • availability_total (int, optional) – For limited-supply gifts: total number of gifts in initial supply.

  • first_sale_date (datetime, optional) – For sold out gifts: when the gift was first bought.

  • last_sale_date (datetime, optional) – For sold out gifts: when the gift was last bought.

  • upgrade_stars (int, optional) – Stars needed to upgrade this gift to a collectible.

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