StarGiftUnique#

class pyrogram.raw.types.StarGiftUnique#

Represents a collectible star gift, see here for more info. The sticker that represents the gift is contained in a starGiftAttributeModel object in attributes.

Constructor of StarGift.

Details:

  • Layer: 225

  • ID: 85F0A9CD

Parameters:

  • id (int 64-bit) – Unique identifier of this collectible gift.

  • gift_id (int 64-bit) – ID of the regular gift from which this gift was upgraded (all collectible gifts upgraded from the same gift will have the same gift_id, with different attributes).

  • title (str) – Collectible title.

  • slug (str) – Slug that can be used to create a collectible gift deep link », or elsewhere in the API where a collectible slug is accepted.

  • num (int 32-bit) – Unique identifier of this collectible gift among all (already upgraded) collectible gifts of the same type.

  • attributes (List of StarGiftAttribute) – Collectible attributes

  • availability_issued (int 32-bit) – Total number of gifts of the same type that were upgraded to a collectible gift.

  • availability_total (int 32-bit) – Total number of gifts of the same type that can be upgraded or were already upgraded to a collectible gift.

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

  • resale_ton_only (bool, optional) – Whether the gift can be bought only using Toncoins.

  • theme_available (bool, optional) – A chat theme associated to this gift is available, see here » for more info on how to use it.

  • burned (bool, optional) – This gift was already used as an ingredient for crafting another collectible gift ».

  • crafted (bool, optional) – This collectible gift was obtained by crafting », not by upgrading a regular gift.

  • owner_id (Peer, optional) – The owner of the gift.

  • owner_name (str, optional) – The name of the owner if neither owner_id nor owner_address are set.

  • owner_address (str, optional) – For NFTs on the TON blockchain, contains the address of the owner (append it to the ton_blockchain_explorer_url client configuration value » to obtain a link with information about the address).

  • gift_address (str, optional) – For NFTs on the TON blockchain, contains the address of the NFT (append it to the ton_blockchain_explorer_url client configuration value » to obtain a link with information about the address).

  • resell_amount (List of StarsAmount, optional) – Resale price of the gift.

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

  • value_amount (int 64-bit, optional) – Estimated price of the gift.

  • value_currency (str, optional) – Currency for the gift’s estimated price.

  • value_usd_amount (int 64-bit, optional) – Estimated price of the gift in USD cents.

  • theme_peer (Peer, optional) – The current chat where the associated chat theme is installed, if any (gift-based themes can only be installed in one chat at a time).

  • peer_color (PeerColor, optional) – Can contain a collectible message palette ».

  • host_id (Peer, optional) – If set, the gift is currently hosted on the specified user or channel profile even though ownership belongs to a TON wallet. The owner may transfer, resell or export the gift, while the host or owner may show it on the profile, use it as a theme/status and add it to a collection.

  • offer_min_stars (int 32-bit, optional) – If set, you can send a purchase offer for this gift »: the minimum offer price is specified in this flag.

  • craft_chance_permille (int 32-bit, optional) – Success probability, per 1000, contributed by this gift when it is used for crafting ».