StarGiftAuctionState#

class pyrogram.raw.types.StarGiftAuctionState#

Represents an active or pending auction.

Constructor of StarGiftAuctionState.

Details:

  • Layer: 225

  • ID: 771A4E66

Parameters:

  • version (int 32-bit) – Only apply incoming starGiftAuctionState constructors if the received version is bigger than the locally cached version.

  • start_date (int 32-bit) – UNIX timestamp indicating when the auction will start (or when it started, if it’s in the past).

  • end_date (int 32-bit) – UNIX timestamp indicating when the auction will end

  • min_bid_amount (int 64-bit) – Minumum allowed bid amount in Telegram Stars: only applicable if the user hasn’t made a bid yet, otherwise must be overridden to the value of starGiftAuctionUserState.min_bid_amount (which will be set if and only if the user already made a bid to this auction).

  • bid_levels (List of AuctionBidLevel) – Contains a sparse list of bids starting from the top bids, a more detailed description is available in the docs.

  • top_bidders (List of int 64-bit) – User IDs of the top 3 bidders (the user constructors will be returned as min constructors in the containing object).

  • next_round_at (int 32-bit) – UNIX timestamp indicating when the current auction round will end, distributing starGift.gifts_per_round gifts to the top starGift.gifts_per_round bidders.

  • last_gift_num (int 32-bit) – The number of gifts that were distributed in the previous round (also used to compute the approximated index of the gift that the current user will receive, last_gift_num + approx_pos, see here » for more info).

  • gifts_left (int 32-bit) – The remaining number of gifts that are yet to be distributed.

  • current_round (int 32-bit) – The current round number (starting from 1).

  • total_rounds (int 32-bit) – The total number of rounds in this auction.

  • rounds (List of StarGiftAuctionRound) – Detailed round information.