Skip to main content

starGiftAuctionState

Represents an active or pending auction ».

type tg.StarGiftAuctionState struct { /* ... */ }

Implements StarGiftAuctionState.

Fields​

NameTypeRequiredDescription
VersionintyesOnly apply incoming starGiftAuctionState constructors if the received version is bigger than the locally cached version.
StartDateintyesUNIX timestamp indicating when the auction will start (or when it started, if it's in the past).
EndDateintyesUNIX timestamp indicating when the auction will end
MinBidAmountint64yesMinumum 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).
BidLevels[]AuctionBidLevelyesContains a sparse list of bids starting from the top bids, a more detailed description is available in the docs.
TopBidders[]int64yesUser IDs of the top 3 bidders (the user constructors will be returned as min constructors in the containing object).
NextRoundAtintyesUNIX timestamp indicating when the current auction round will end, distributing starGift.gifts_per_round gifts to the top starGift.gifts_per_round bidders.
LastGiftNumintyesThe 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).
GiftsLeftintyesThe remaining number of gifts that are yet to be distributed.
CurrentRoundintyesThe current round number (starting from 1).
TotalRoundsintyesThe total number of rounds in this auction.
Rounds[]StarGiftAuctionRoundClassyesDetailed round information.

References​