StarGift

class pyrogram.raw.types.StarGift

Represents a star gift, see here » for more info.

Constructor of StarGift.

Details:

• Layer: 227

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

• auction (bool, optional)

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

• gifts_per_round (int 32-bit, optional)

• auction_start_date (int 32-bit, optional)

• upgrade_variants (int 32-bit, optional)

• background (StarGiftBackground, optional)

TL Schema

starGift#313a9547
flags:#
limited:flags.0?true
sold_out:flags.1?true
birthday:flags.2?true
require_premium:flags.7?true
limited_per_user:flags.8?true
peer_color_available:flags.10?true
auction:flags.11?true
id:long
sticker:Document
stars:long
availability_remains:flags.0?int
availability_total:flags.0?int
availability_resale:flags.4?long
convert_stars:long
first_sale_date:flags.1?int
last_sale_date:flags.1?int
upgrade_stars:flags.3?long
resell_min_stars:flags.4?long
title:flags.5?string
released_by:flags.6?Peer
per_user_total:flags.8?int
per_user_remains:flags.8?int
locked_until_date:flags.9?int
auction_slug:flags.11?string
gifts_per_round:flags.11?int
auction_start_date:flags.11?int
upgrade_variants:flags.12?int
background:flags.13?StarGiftBackground

= StarGift

Parameter Tree

Example

StarGift(
    id=0,
    sticker=DocumentEmpty(id=0),
    stars=0,
    convert_stars=0,
)