payments.StarGiftActiveAuctions

class pyrogram.raw.types.payments.StarGiftActiveAuctions

{schema}

Constructor of StarGiftActiveAuctions.

Details:

  • Layer: 223

  • ID: AEF6ABBC

Parameters:
Functions:

This object can be returned by 1 function.

payments.GetStarGiftActiveAuctions

{schema}

TL Schema

payments.starGiftActiveAuctions#aef6abbc
auctions:Vector<StarGiftActiveAuctionState>
users:Vector<User>
chats:Vector<Chat>

= payments.StarGiftActiveAuctions

Parameter Tree

StarGiftActiveAuctions
├── auctions → Vector < StarGiftActiveAuctionState >
│ └── StarGiftActiveAuctionState
│ ├── gift → StarGift
│ │ ├── StarGift
│ │ │ ├── limited → true (optional)
│ │ │ ├── sold_out → true (optional)
│ │ │ ├── birthday → true (optional)
│ │ │ ├── require_premium → true (optional)
│ │ │ ├── limited_per_user → true (optional)
│ │ │ ├── peer_color_available → true (optional)
│ │ │ ├── auction → true (optional)
│ │ │ ├── id → long
│ │ │ ├── sticker → Document
│ │ │ │ ├── DocumentEmpty
│ │ │ │ └── Document
│ │ │ ├── stars → long
│ │ │ ├── availability_remains → int (optional)
│ │ │ ├── availability_total → int (optional)
│ │ │ ├── availability_resale → long (optional)
│ │ │ ├── convert_stars → long
│ │ │ ├── first_sale_date → int (optional)
│ │ │ ├── last_sale_date → int (optional)
│ │ │ ├── upgrade_stars → long (optional)
│ │ │ ├── resell_min_stars → long (optional)
│ │ │ ├── title → string (optional)
│ │ │ ├── released_by → Peer (optional)
│ │ │ │ ├── PeerUser
│ │ │ │ ├── PeerChat
│ │ │ │ └── PeerChannel
│ │ │ ├── per_user_total → int (optional)
│ │ │ ├── per_user_remains → int (optional)
│ │ │ ├── locked_until_date → int (optional)
│ │ │ ├── auction_slug → string (optional)
│ │ │ ├── gifts_per_round → int (optional)
│ │ │ ├── auction_start_date → int (optional)
│ │ │ ├── upgrade_variants → int (optional)
│ │ │ └── background → StarGiftBackground (optional)
│ │ │ └── StarGiftBackground
│ │ └── StarGiftUnique
│ │ ├── require_premium → true (optional)
│ │ ├── resale_ton_only → true (optional)
│ │ ├── theme_available → true (optional)
│ │ ├── burned → true (optional)
│ │ ├── crafted → true (optional)
│ │ ├── id → long
│ │ ├── gift_id → long
│ │ ├── title → string
│ │ ├── slug → string
│ │ ├── num → int
│ │ ├── owner_id → Peer (optional)
│ │ │ ├── PeerUser
│ │ │ ├── PeerChat
│ │ │ └── PeerChannel
│ │ ├── owner_name → string (optional)
│ │ ├── owner_address → string (optional)
│ │ ├── attributes → Vector < StarGiftAttribute >
│ │ │ ├── StarGiftAttributeModel
│ │ │ ├── StarGiftAttributePattern
│ │ │ ├── StarGiftAttributeBackdrop
│ │ │ └── StarGiftAttributeOriginalDetails
│ │ ├── availability_issued → int
│ │ ├── availability_total → int
│ │ ├── gift_address → string (optional)
│ │ ├── resell_amount → Vector < StarsAmount > (optional)
│ │ │ ├── StarsAmount
│ │ │ └── StarsTonAmount
│ │ ├── released_by → Peer (optional)
│ │ │ ├── PeerUser
│ │ │ ├── PeerChat
│ │ │ └── PeerChannel
│ │ ├── value_amount → long (optional)
│ │ ├── value_currency → string (optional)
│ │ ├── value_usd_amount → long (optional)
│ │ ├── theme_peer → Peer (optional)
│ │ │ ├── PeerUser
│ │ │ ├── PeerChat
│ │ │ └── PeerChannel
│ │ ├── peer_color → PeerColor (optional)
│ │ │ ├── PeerColor
│ │ │ ├── PeerColorCollectible
│ │ │ └── InputPeerColorCollectible
│ │ ├── host_id → Peer (optional)
│ │ │ ├── PeerUser
│ │ │ ├── PeerChat
│ │ │ └── PeerChannel
│ │ ├── offer_min_stars → int (optional)
│ │ └── craft_chance_permille → int (optional)
│ ├── state → StarGiftAuctionState
│ │ ├── StarGiftAuctionStateNotModified
│ │ ├── StarGiftAuctionState
│ │ │ ├── version → int
│ │ │ ├── start_date → int
│ │ │ ├── end_date → int
│ │ │ ├── min_bid_amount → long
│ │ │ ├── bid_levels → Vector < AuctionBidLevel >
│ │ │ │ └── AuctionBidLevel
│ │ │ ├── top_bidders → Vector < long >
│ │ │ ├── next_round_at → int
│ │ │ ├── last_gift_num → int
│ │ │ ├── gifts_left → int
│ │ │ ├── current_round → int
│ │ │ ├── total_rounds → int
│ │ │ └── rounds → Vector < StarGiftAuctionRound >
│ │ │ ├── StarGiftAuctionRound
│ │ │ └── StarGiftAuctionRoundExtendable
│ │ └── StarGiftAuctionStateFinished
│ │ ├── start_date → int
│ │ ├── end_date → int
│ │ ├── average_price → long
│ │ ├── listed_count → int (optional)
│ │ ├── fragment_listed_count → int (optional)
│ │ └── fragment_listed_url → string (optional)
│ └── user_state → StarGiftAuctionUserState
│ └── StarGiftAuctionUserState
│ ├── returned → true (optional)
│ ├── bid_amount → long (optional)
│ ├── bid_date → int (optional)
│ ├── min_bid_amount → long (optional)
│ ├── bid_peer → Peer (optional)
│ │ ├── PeerUser
│ │ ├── PeerChat
│ │ └── PeerChannel
│ └── acquired_count → int
├── users → Vector < User >
│ ├── UserEmpty
│ │ └── id → long
│ └── User
│ ├── is_self → true (optional)
│ ├── contact → true (optional)
│ ├── mutual_contact → true (optional)
│ ├── deleted → true (optional)
│ ├── bot → true (optional)
│ ├── bot_chat_history → true (optional)
│ ├── bot_nochats → true (optional)
│ ├── verified → true (optional)
│ ├── restricted → true (optional)
│ ├── min → true (optional)
│ ├── bot_inline_geo → true (optional)
│ ├── support → true (optional)
│ ├── scam → true (optional)
│ ├── apply_min_photo → true (optional)
│ ├── fake → true (optional)
│ ├── bot_attach_menu → true (optional)
│ ├── premium → true (optional)
│ ├── attach_menu_enabled → true (optional)
│ ├── bot_can_edit → true (optional)
│ ├── close_friend → true (optional)
│ ├── stories_hidden → true (optional)
│ ├── stories_unavailable → true (optional)
│ ├── contact_require_premium → true (optional)
│ ├── bot_business → true (optional)
│ ├── bot_has_main_app → true (optional)
│ ├── bot_forum_view → true (optional)
│ ├── bot_forum_can_manage_topics → true (optional)
│ ├── id → long
│ ├── access_hash → long (optional)
│ ├── first_name → string (optional)
│ ├── last_name → string (optional)
│ ├── username → string (optional)
│ ├── phone → string (optional)
│ ├── photo → UserProfilePhoto (optional)
│ │ ├── UserProfilePhotoEmpty
│ │ └── UserProfilePhoto
│ │ ├── has_video → true (optional)
│ │ ├── personal → true (optional)
│ │ ├── photo_id → long
│ │ ├── stripped_thumb → bytes (optional)
│ │ └── dc_id → int
│ ├── status → UserStatus (optional)
│ │ ├── UserStatusEmpty
│ │ ├── UserStatusOnline
│ │ │ └── expires → int
│ │ ├── UserStatusOffline
│ │ │ └── was_online → int
│ │ ├── UserStatusRecently
│ │ │ └── by_me → true (optional)
│ │ ├── UserStatusLastWeek
│ │ │ └── by_me → true (optional)
│ │ └── UserStatusLastMonth
│ │ └── by_me → true (optional)
│ ├── bot_info_version → int (optional)
│ ├── restriction_reason → Vector < RestrictionReason > (optional)
│ │ └── RestrictionReason
│ │ ├── platform → string
│ │ ├── reason → string
│ │ └── text → string
│ ├── bot_inline_placeholder → string (optional)
│ ├── lang_code → string (optional)
│ ├── emoji_status → EmojiStatus (optional)
│ │ ├── EmojiStatusEmpty
│ │ ├── EmojiStatus
│ │ │ ├── document_id → long
│ │ │ └── until → int (optional)
│ │ ├── EmojiStatusCollectible
│ │ │ ├── collectible_id → long
│ │ │ ├── document_id → long
│ │ │ ├── title → string
│ │ │ ├── slug → string
│ │ │ ├── pattern_document_id → long
│ │ │ ├── center_color → int
│ │ │ ├── edge_color → int
│ │ │ ├── pattern_color → int
│ │ │ ├── text_color → int
│ │ │ └── until → int (optional)
│ │ └── InputEmojiStatusCollectible
│ │ ├── collectible_id → long
│ │ └── until → int (optional)
│ ├── usernames → Vector < Username > (optional)
│ │ └── Username
│ │ ├── editable → true (optional)
│ │ ├── active → true (optional)
│ │ └── username → string
│ ├── stories_max_id → RecentStory (optional)
│ │ └── RecentStory
│ │ ├── live → true (optional)
│ │ └── max_id → int (optional)
│ ├── color → PeerColor (optional)
│ │ ├── PeerColor
│ │ │ ├── color → int (optional)
│ │ │ └── background_emoji_id → long (optional)
│ │ ├── PeerColorCollectible
│ │ │ ├── collectible_id → long
│ │ │ ├── gift_emoji_id → long
│ │ │ ├── background_emoji_id → long
│ │ │ ├── accent_color → int
│ │ │ ├── colors → Vector < int >
│ │ │ ├── dark_accent_color → int (optional)
│ │ │ └── dark_colors → Vector < int > (optional)
│ │ └── InputPeerColorCollectible
│ │ └── collectible_id → long
│ ├── profile_color → PeerColor (optional)
│ │ ├── PeerColor
│ │ │ ├── color → int (optional)
│ │ │ └── background_emoji_id → long (optional)
│ │ ├── PeerColorCollectible
│ │ │ ├── collectible_id → long
│ │ │ ├── gift_emoji_id → long
│ │ │ ├── background_emoji_id → long
│ │ │ ├── accent_color → int
│ │ │ ├── colors → Vector < int >
│ │ │ ├── dark_accent_color → int (optional)
│ │ │ └── dark_colors → Vector < int > (optional)
│ │ └── InputPeerColorCollectible
│ │ └── collectible_id → long
│ ├── bot_active_users → int (optional)
│ ├── bot_verification_icon → long (optional)
│ └── send_paid_messages_stars → long (optional)
└── chats → Vector < Chat >
├── ChatEmpty
│ └── id → long
├── Chat
│ ├── creator → true (optional)
│ ├── left → true (optional)
│ ├── deactivated → true (optional)
│ ├── call_active → true (optional)
│ ├── call_not_empty → true (optional)
│ ├── noforwards → true (optional)
│ ├── id → long
│ ├── title → string
│ ├── photo → ChatPhoto
│ │ ├── ChatPhotoEmpty
│ │ └── ChatPhoto
│ │ ├── has_video → true (optional)
│ │ ├── photo_id → long
│ │ ├── stripped_thumb → bytes (optional)
│ │ └── dc_id → int
│ ├── participants_count → int
│ ├── date → int
│ ├── version → int
│ ├── migrated_to → InputChannel (optional)
│ │ ├── InputChannelEmpty
│ │ ├── InputChannel
│ │ └── InputChannelFromMessage
│ ├── admin_rights → ChatAdminRights (optional)
│ │ └── ChatAdminRights
│ │ ├── change_info → true (optional)
│ │ ├── post_messages → true (optional)
│ │ ├── edit_messages → true (optional)
│ │ ├── delete_messages → true (optional)
│ │ ├── ban_users → true (optional)
│ │ ├── invite_users → true (optional)
│ │ ├── pin_messages → true (optional)
│ │ ├── add_admins → true (optional)
│ │ ├── anonymous → true (optional)
│ │ ├── manage_call → true (optional)
│ │ ├── other → true (optional)
│ │ ├── manage_topics → true (optional)
│ │ ├── post_stories → true (optional)
│ │ ├── edit_stories → true (optional)
│ │ ├── delete_stories → true (optional)
│ │ ├── manage_direct_messages → true (optional)
│ │ └── manage_ranks → true (optional)
│ └── default_banned_rights → ChatBannedRights (optional)
│ └── ChatBannedRights
│ ├── view_messages → true (optional)
│ ├── send_messages → true (optional)
│ ├── send_media → true (optional)
│ ├── send_stickers → true (optional)
│ ├── send_gifs → true (optional)
│ ├── send_games → true (optional)
│ ├── send_inline → true (optional)
│ ├── embed_links → true (optional)
│ ├── send_polls → true (optional)
│ ├── change_info → true (optional)
│ ├── invite_users → true (optional)
│ ├── pin_messages → true (optional)
│ ├── manage_topics → true (optional)
│ ├── send_photos → true (optional)
│ ├── send_videos → true (optional)
│ ├── send_roundvideos → true (optional)
│ ├── send_audios → true (optional)
│ ├── send_voices → true (optional)
│ ├── send_docs → true (optional)
│ ├── send_plain → true (optional)
│ ├── edit_rank → true (optional)
│ └── until_date → int
├── ChatForbidden
│ ├── id → long
│ └── title → string
├── Channel
│ ├── creator → true (optional)
│ ├── left → true (optional)
│ ├── broadcast → true (optional)
│ ├── verified → true (optional)
│ ├── megagroup → true (optional)
│ ├── restricted → true (optional)
│ ├── signatures → true (optional)
│ ├── min → true (optional)
│ ├── scam → true (optional)
│ ├── has_link → true (optional)
│ ├── has_geo → true (optional)
│ ├── slowmode_enabled → true (optional)
│ ├── call_active → true (optional)
│ ├── call_not_empty → true (optional)
│ ├── fake → true (optional)
│ ├── gigagroup → true (optional)
│ ├── noforwards → true (optional)
│ ├── join_to_send → true (optional)
│ ├── join_request → true (optional)
│ ├── forum → true (optional)
│ ├── stories_hidden → true (optional)
│ ├── stories_hidden_min → true (optional)
│ ├── stories_unavailable → true (optional)
│ ├── signature_profiles → true (optional)
│ ├── autotranslation → true (optional)
│ ├── broadcast_messages_allowed → true (optional)
│ ├── monoforum → true (optional)
│ ├── forum_tabs → true (optional)
│ ├── id → long
│ ├── access_hash → long (optional)
│ ├── title → string
│ ├── username → string (optional)
│ ├── photo → ChatPhoto
│ │ ├── ChatPhotoEmpty
│ │ └── ChatPhoto
│ │ ├── has_video → true (optional)
│ │ ├── photo_id → long
│ │ ├── stripped_thumb → bytes (optional)
│ │ └── dc_id → int
│ ├── date → int
│ ├── restriction_reason → Vector < RestrictionReason > (optional)
│ │ └── RestrictionReason
│ │ ├── platform → string
│ │ ├── reason → string
│ │ └── text → string
│ ├── admin_rights → ChatAdminRights (optional)
│ │ └── ChatAdminRights
│ │ ├── change_info → true (optional)
│ │ ├── post_messages → true (optional)
│ │ ├── edit_messages → true (optional)
│ │ ├── delete_messages → true (optional)
│ │ ├── ban_users → true (optional)
│ │ ├── invite_users → true (optional)
│ │ ├── pin_messages → true (optional)
│ │ ├── add_admins → true (optional)
│ │ ├── anonymous → true (optional)
│ │ ├── manage_call → true (optional)
│ │ ├── other → true (optional)
│ │ ├── manage_topics → true (optional)
│ │ ├── post_stories → true (optional)
│ │ ├── edit_stories → true (optional)
│ │ ├── delete_stories → true (optional)
│ │ ├── manage_direct_messages → true (optional)
│ │ └── manage_ranks → true (optional)
│ ├── banned_rights → ChatBannedRights (optional)
│ │ └── ChatBannedRights
│ │ ├── view_messages → true (optional)
│ │ ├── send_messages → true (optional)
│ │ ├── send_media → true (optional)
│ │ ├── send_stickers → true (optional)
│ │ ├── send_gifs → true (optional)
│ │ ├── send_games → true (optional)
│ │ ├── send_inline → true (optional)
│ │ ├── embed_links → true (optional)
│ │ ├── send_polls → true (optional)
│ │ ├── change_info → true (optional)
│ │ ├── invite_users → true (optional)
│ │ ├── pin_messages → true (optional)
│ │ ├── manage_topics → true (optional)
│ │ ├── send_photos → true (optional)
│ │ ├── send_videos → true (optional)
│ │ ├── send_roundvideos → true (optional)
│ │ ├── send_audios → true (optional)
│ │ ├── send_voices → true (optional)
│ │ ├── send_docs → true (optional)
│ │ ├── send_plain → true (optional)
│ │ ├── edit_rank → true (optional)
│ │ └── until_date → int
│ ├── default_banned_rights → ChatBannedRights (optional)
│ │ └── ChatBannedRights
│ │ ├── view_messages → true (optional)
│ │ ├── send_messages → true (optional)
│ │ ├── send_media → true (optional)
│ │ ├── send_stickers → true (optional)
│ │ ├── send_gifs → true (optional)
│ │ ├── send_games → true (optional)
│ │ ├── send_inline → true (optional)
│ │ ├── embed_links → true (optional)
│ │ ├── send_polls → true (optional)
│ │ ├── change_info → true (optional)
│ │ ├── invite_users → true (optional)
│ │ ├── pin_messages → true (optional)
│ │ ├── manage_topics → true (optional)
│ │ ├── send_photos → true (optional)
│ │ ├── send_videos → true (optional)
│ │ ├── send_roundvideos → true (optional)
│ │ ├── send_audios → true (optional)
│ │ ├── send_voices → true (optional)
│ │ ├── send_docs → true (optional)
│ │ ├── send_plain → true (optional)
│ │ ├── edit_rank → true (optional)
│ │ └── until_date → int
│ ├── participants_count → int (optional)
│ ├── usernames → Vector < Username > (optional)
│ │ └── Username
│ │ ├── editable → true (optional)
│ │ ├── active → true (optional)
│ │ └── username → string
│ ├── stories_max_id → RecentStory (optional)
│ │ └── RecentStory
│ │ ├── live → true (optional)
│ │ └── max_id → int (optional)
│ ├── color → PeerColor (optional)
│ │ ├── PeerColor
│ │ │ ├── color → int (optional)
│ │ │ └── background_emoji_id → long (optional)
│ │ ├── PeerColorCollectible
│ │ │ ├── collectible_id → long
│ │ │ ├── gift_emoji_id → long
│ │ │ ├── background_emoji_id → long
│ │ │ ├── accent_color → int
│ │ │ ├── colors → Vector < int >
│ │ │ ├── dark_accent_color → int (optional)
│ │ │ └── dark_colors → Vector < int > (optional)
│ │ └── InputPeerColorCollectible
│ │ └── collectible_id → long
│ ├── profile_color → PeerColor (optional)
│ │ ├── PeerColor
│ │ │ ├── color → int (optional)
│ │ │ └── background_emoji_id → long (optional)
│ │ ├── PeerColorCollectible
│ │ │ ├── collectible_id → long
│ │ │ ├── gift_emoji_id → long
│ │ │ ├── background_emoji_id → long
│ │ │ ├── accent_color → int
│ │ │ ├── colors → Vector < int >
│ │ │ ├── dark_accent_color → int (optional)
│ │ │ └── dark_colors → Vector < int > (optional)
│ │ └── InputPeerColorCollectible
│ │ └── collectible_id → long
│ ├── emoji_status → EmojiStatus (optional)
│ │ ├── EmojiStatusEmpty
│ │ ├── EmojiStatus
│ │ │ ├── document_id → long
│ │ │ └── until → int (optional)
│ │ ├── EmojiStatusCollectible
│ │ │ ├── collectible_id → long
│ │ │ ├── document_id → long
│ │ │ ├── title → string
│ │ │ ├── slug → string
│ │ │ ├── pattern_document_id → long
│ │ │ ├── center_color → int
│ │ │ ├── edge_color → int
│ │ │ ├── pattern_color → int
│ │ │ ├── text_color → int
│ │ │ └── until → int (optional)
│ │ └── InputEmojiStatusCollectible
│ │ ├── collectible_id → long
│ │ └── until → int (optional)
│ ├── level → int (optional)
│ ├── subscription_until_date → int (optional)
│ ├── bot_verification_icon → long (optional)
│ ├── send_paid_messages_stars → long (optional)
│ └── linked_monoforum_id → long (optional)
└── ChannelForbidden
├── broadcast → true (optional)
├── megagroup → true (optional)
├── monoforum → true (optional)
├── id → long
├── access_hash → long
├── title → string
└── until_date → int (optional)

Example

StarGiftActiveAuctions(
    auctions=[
            StarGiftActiveAuctionState(
                gift=StarGift(
                    id=0,
                    sticker=DocumentEmpty(id=0),
                    stars=0,
                    convert_stars=0
                ),
                state=StarGiftAuctionStateNotModified(),
                user_state=StarGiftAuctionUserState(acquired_count=0)
            )
        ],
    users=[
            UserEmpty(id=0)
        ],
    chats=[
            ChatEmpty(id=0)
        ],
)