Models¶
Data classes returned by the API.
User¶
kickpy.models.user.User(user_id, name, email, profile_picture)
dataclass
¶
Represents a Kick.com user.
Channel¶
kickpy.models.channel.Channel(active_subscribers_count, canceled_subscribers_count, broadcaster_user_id, slug, channel_description, banner_picture, stream, stream_title, category)
dataclass
¶
Represents a Kick.com channel.
Stream¶
kickpy.models.stream.Stream(url, key, is_live, is_mature, language, start_time, thumbnail, viewer_count, custom_tags=None)
dataclass
¶
Represents a Kick.com stream.
Category¶
kickpy.models.categories.Category(id, name, thumbnail, tags=None)
dataclass
¶
Represents a Kick.com category.
LiveStream¶
kickpy.models.livestreams.LiveStream(broadcaster_user_id, category, channel_id, custom_tags, has_mature_content, language, slug, started_at, stream_title, thumbnail, viewer_count, profile_picture=None)
dataclass
¶
Represents a Kick.com livestream.
LivestreamStats¶
kickpy.models.livestream_stats.LivestreamStats(total_count)
dataclass
¶
Represents livestream statistics.
AccessToken¶
kickpy.models.access_token.AccessToken(access_token, expires_at, token_type, refresh_token=None, scope=None, token_kind='app')
dataclass
¶
ChatResponse¶
kickpy.models.chat.ChatResponse(is_sent, message_id)
dataclass
¶
Represents the response from sending a chat message.
EventsSubscription¶
kickpy.models.events_subscriptions.EventsSubscription(app_id, broadcaster_user_id, created_at, event, id, method, updated_at, version)
dataclass
¶
Represents a Kick.com event subscriptions.
EventsSubscriptionCreated¶
kickpy.models.events_subscriptions.EventsSubscriptionCreated(name, subscription_id, version)
dataclass
¶
Represents a Kick.com event subscriptions created.
Channel Rewards¶
kickpy.models.rewards.ChannelReward(id, title, cost, description, background_color, is_enabled, is_paused, is_user_input_required, should_redemptions_skip_request_queue)
dataclass
¶
Represents a channel points reward.
kickpy.models.rewards.ChannelRewardRedemption(id, redeemed_at, redeemer, status, user_input)
dataclass
¶
Represents a channel reward redemption.
kickpy.models.rewards.RedemptionsByReward(reward, redemptions=list())
dataclass
¶
Represents redemptions grouped by reward.
kickpy.models.rewards.MinimalChannelReward(id, title, cost=None, description=None, can_manage=None, is_deleted=None)
dataclass
¶
Represents a minimal channel reward in redemption responses.
kickpy.models.rewards.RedemptionUser(user_id)
dataclass
¶
Represents a user who redeemed a reward.
kickpy.models.rewards.FailedRedemption(id, reason)
dataclass
¶
Represents a failed redemption in accept/reject responses.
KICKs Leaderboard¶
kickpy.models.kicks.KicksLeaderboard(lifetime=list(), month=list(), week=list())
dataclass
¶
Represents the KICKs leaderboard with lifetime, month, and week rankings.
kickpy.models.kicks.KicksLeaderboardEntry(gifted_amount, rank, user_id, username)
dataclass
¶
Represents a single entry in the KICKs leaderboard.