Ads | Streamer.bot Docs

`TwitchGetPrerollFreeTime`

public int TwitchGetPrerollFreeTime()

`TwitchRunCommercial`

public bool TwitchRunCommercial(int duration)

`GetCheermotes`

public List<Cheermote> GetCheermotes()

`SetChannelGame`

public GameInfo SetChannelGame(string game)

`SetChannelGameById`

public bool SetChannelGameById(string gameId)

`SetChannelTitle`

public bool SetChannelTitle(string title)

`TwitchAddChannelTag`

public bool TwitchAddChannelTag(string tag)

`TwitchClearChannelTags`

public bool TwitchClearChannelTags()

`TwitchRemoveChannelTag`

public bool TwitchRemoveChannelTag(string tag)

`TwitchSetChannelTags`

public bool TwitchSetChannelTags(List<string> tags)

`DisableReward`

public void DisableReward(string rewardId)

`EnableReward`

public void EnableReward(string rewardId)

`PauseReward`

public void PauseReward(string rewardId)

`TwitchGetChannelPointsUsedByUserId`

Get the amount of channel points used by a user. Tracks only the redeems that Streamer.bot has seen.

public long TwitchGetChannelPointsUsedByUserId(string userId)

`TwitchGetRewardCounter`

Get the counter of a Twitch reward, by id

public TwitchRewardCounter TwitchGetRewardCounter(string rewardId, bool persisted = true)

`TwitchGetRewards`

Returns a list of Twitch Reward

public List<TwitchReward> TwitchGetRewards()

`TwitchGetRewardUserCounter`

Returns reward count of the given reward for a specified Twitch user

0.2.4

public TwitchRewardCounter TwitchGetRewardUserCounter(string userLogin, string rewardId, bool persisted = true)

`TwitchGetRewardUserCounterById`

Returns reward count of the given reward for a specified Twitch user, by id

0.2.4

public TwitchRewardCounter TwitchGetRewardUserCounterById(string userId, string rewardId, bool persisted = true)

`TwitchRedemptionCancel`

Will refund the Twitch reward and removing it from the reward queue

public bool TwitchRedemptionCancel(string rewardId, string redemptionId)

`TwitchRedemptionFulfill`

Mark Twitch reward as resolved, which makes the redeem non refundable and removes it from reward queue

public bool TwitchRedemptionFulfill(string rewardId, string redemptionId)

`TwitchResetRewardCounter`

Reset counter for the specified reward, by id

public void TwitchResetRewardCounter(string rewardId)

`TwitchResetRewardUserCounters`

Reset reward user counters for the specified reward, by id

public void TwitchResetRewardUserCounters(string rewardId)

`TwitchResetUserRewardCounter`

Reset user reward counters for the specified reward id and user Id

public void TwitchResetUserRewardCounter(string rewardId, string userId)

`TwitchResetUserRewardCounters`

Reset all user reward counters for the specified user, by id

public void TwitchResetUserRewardCounters(string userId, bool persisted)

`TwitchRewardGroupDisable`

public void TwitchRewardGroupDisable(string groupName)

`TwitchRewardGroupEnable`

public void TwitchRewardGroupEnable(string groupName)

`TwitchRewardGroupPause`

public void TwitchRewardGroupPause(string groupName)

`TwitchRewardGroupToggleEnable`

public void TwitchRewardGroupToggleEnable(string groupName)

`TwitchRewardGroupTogglePause`

public void TwitchRewardGroupTogglePause(string groupName)

`TwitchRewardGroupUnPause`

public void TwitchRewardGroupUnPause(string groupName)

`UnPauseReward`

public void UnPauseReward(string rewardId)

`UpdateReward`

public bool UpdateReward(string rewardId, string title, string prompt, Int32? cost, string backroundColor)

`UpdateRewardBackgroundColor`

public bool UpdateRewardBackgroundColor(string rewardId, string backgroundColor)

`UpdateRewardCooldown`

public void UpdateRewardCooldown(string rewardId, long cooldown, bool additive = false)

`UpdateRewardCost`

public void UpdateRewardCost(string rewardId, int cost, bool additive = false)

`UpdateRewardMaxPerStream`

Updates the total maximum amount of redemptions per stream for the specified reward

0.2.4

public void UpdateRewardMaxPerStream(string rewardId, long redeems, bool additive = false)

`UpdateRewardMaxPerUserPerStream`

Updates the total maximum amount of redemptions per stream, per user, for the specified reward

0.2.4

public void UpdateRewardMaxPerUserPerStream(string rewardId, long redeems, bool additive = false)

`UpdateRewardPrompt`

public bool UpdateRewardPrompt(string rewardId, string prompt)

`UpdateRewardTitle`

public bool UpdateRewardTitle(string rewardId, string title)

`SendAction`

Sends an Action from either the Twitch Broadcaster or Twitch Bot Account (denoted by Italics in Twitch chat)

0.2.5

public void SendAction(string action, bool useBot = true, bool fallback = true)

`SendMessage`

Sends a Twitch chat message using either Twitch Broadcaster or Twitch Bot account

public void SendMessage(string message, bool useBot = true, bool fallback = true)

`SendWhisper`

public bool SendWhisper(string userName, string message, bool bot = true)

`TwitchAnnounce`

public void TwitchAnnounce(string message, bool bot = false, string color, bool fallback = false)

`TwitchClearChatMessages`

public bool TwitchClearChatMessages(bool bot = true)

`TwitchDeleteChatMessage`

public bool TwitchDeleteChatMessage(string messageId, bool bot = true)

`TwitchReplyToMessage`

Send a reply to a specific Twitch chat message

public void TwitchReplyToMessage(string message, string replyId, bool useBot = true, bool fallback = true)

`TwitchGetBitsDonatedByUserId`

public long TwitchGetBitsDonatedByUserId(string userId)

`CreateClip`

Create a 30 second Twitch Clip

public ClipData CreateClip()

Due to Twitch API restrictions, the generated clip will always be:

30 seconds long
Titled to match your current stream title

To make your own changes to the clip duration or title, you can manually edit the clip later.

`CreateStreamMarker`

Create a Stream Marker on Twitch

public StreamMarker CreateStreamMarker(string description)

`GetAllClips`

Fetch all clips for the connected Twitch Broadcaster. The list is in descending order by view count.

public List<ClipData> GetAllClips(Boolean? isFeatured)

Clip data is always sorted by view count (descending) due to Twitch API limitations

A maximum of 1,000 clips can be returned

`GetClips`

Fetch a number of clips for the connected Twitch Broadcaster

public List<ClipData> GetClips(int count, Boolean? isFeatured)

`GetClipsForGame`

Fetch clips for a specific game on Twitch

public List<ClipData> GetClipsForGame(int gameId, TimeSpan duration, int count, Boolean? isFeatured)

public List<ClipData> GetClipsForGame(int gameId, TimeSpan duration, Boolean? isFeatured)

public List<ClipData> GetClipsForGame(int gameId, DateTime start, DateTime end, int count, Boolean? isFeatured)

public List<ClipData> GetClipsForGame(int gameId, DateTime start, DateTime end, Boolean? isFeatured)

public List<ClipData> GetClipsForGame(int gameId, int count, Boolean? isFeatured)

public List<ClipData> GetClipsForGame(int gameId, Boolean? isFeatured)

`GetClipsForUser`

Fetch clips for a Twitch user, by username

public List<ClipData> GetClipsForUser(string username, TimeSpan duration, int count, Boolean? isFeatured)

public List<ClipData> GetClipsForUser(string username, TimeSpan duration, Boolean? isFeatured)

public List<ClipData> GetClipsForUser(string username, DateTime start, DateTime end, int count, Boolean? isFeatured)

public List<ClipData> GetClipsForUser(string username, DateTime start, DateTime end, Boolean? isFeatured)

public List<ClipData> GetClipsForUser(string userName, int count, Boolean? isFeatured)

public List<ClipData> GetClipsForUser(string username, Boolean? isFeatured)

Deprecated

public List<ClipData> GetClipsForUser(int userId, TimeSpan duration, int count)

Deprecated

public List<ClipData> GetClipsForUser(int userId, TimeSpan duration)

Deprecated

public List<ClipData> GetClipsForUser(int userId, DateTime start, DateTime end, int count)

Deprecated

public List<ClipData> GetClipsForUser(int userId, DateTime start, DateTime end)

Deprecated

public List<ClipData> GetClipsForUser(int userId, int count)

Deprecated

public List<ClipData> GetClipsForUser(int userId)

`GetClipsForUserById`

Fetch clips for a Twitch user, by user ID

0.2.3

public List<ClipData> GetClipsForUserById(string userId, TimeSpan duration, int count, Boolean? isFeatured)

0.2.3

public List<ClipData> GetClipsForUserById(string userId, TimeSpan duration, Boolean? isFeatured)

0.2.3

public List<ClipData> GetClipsForUserById(string userId, DateTime start, DateTime end, int count, Boolean? isFeatured)

0.2.3

public List<ClipData> GetClipsForUserById(string userId, DateTime start, DateTime end, Boolean? isFeatured)

0.2.3

public List<ClipData> GetClipsForUserById(string userId, int count, Boolean? isFeatured)

0.2.3

public List<ClipData> GetClipsForUserById(string userId, Boolean? isFeatured)

`GetTwitchUsersVar<T>`

Get a list of all Twitch users with a given variable, along with their values

public List<UserVariableValue<T>> GetTwitchUsersVar<T>(string varName, bool persisted = true)

`GetTwitchUserVar<T>`

Get the value of a user global variable for a specific Twitch user, by username

public T GetTwitchUserVar<T>(string userName, string varName, bool persisted = true)

`GetTwitchUserVarById<T>`

Get the value of a user global variable for a specific Twitch user, by ID

public T GetTwitchUserVarById<T>(string userId, string varName, bool persisted = true)

`IncrementAllTwitchUsersVar`

Increments the value of a specific user global variable for all Twitch users

0.2.4

public void IncrementAllTwitchUsersVar(string varName, object value, bool persisted = true)

`IncrementOrCreateTwitchUsersVarById`

Increments the value of a specific user global variable for a specified Twitch user, by ID. If the variable doesn't exist, it creates a new one

0.2.4

public void IncrementOrCreateTwitchUsersVarById(List<string> userIds, string varName, object value, bool persisted = true)

`IncrementTwitchUsersVarById`

Increments the value of a specific user global variable for a specified Twitch user, by ID

0.2.4

public void IncrementTwitchUsersVarById(List<string> userIds, string varName, object value, bool persisted = true)

`SetTwitchUsersVarById`

public void SetTwitchUsersVarById(List<string> userIds, string varName, object value, bool persisted = true)

`SetTwitchUserVar`

public void SetTwitchUserVar(string userName, string varName, object value, bool persisted = true)

`SetTwitchUserVarById`

public void SetTwitchUserVarById(string userId, string varName, object value, bool persisted = true)

`UnsetTwitchUser`

public void UnsetTwitchUser(string userName, bool persisted = true)

`UnsetTwitchUserById`

public void UnsetTwitchUserById(string userId, bool persisted = true)

`UnsetTwitchUserVar`

public void UnsetTwitchUserVar(string userName, string varName, bool persisted = true)

`UnsetTwitchUserVarById`

public void UnsetTwitchUserVarById(string userId, string varName, bool persisted = true)

`TwitchAssignGuestStarSlot`

public bool TwitchAssignGuestStarSlot(string userLogin, int slot)

`TwitchCreateGuestStarSession`

public GuestSession TwitchCreateGuestStarSession()

`TwitchDeleteGuestStarInvite`

public bool TwitchDeleteGuestStarInvite(string userLogin)

`TwitchDeleteGuestStarSlot`

public bool TwitchDeleteGuestStarSlot(string userLogin, int slot)

`TwitchEndGuestStarSession`

public GuestSession TwitchEndGuestStarSession()

`TwitchGetChannelGuestStarSettings`

public GuestStarSettings TwitchGetChannelGuestStarSettings()

`TwitchGetGuestStarInvites`

public List<GuestStarInvite> TwitchGetGuestStarInvites()

`TwitchGetGuestStarSession`

public GuestSession TwitchGetGuestStarSession()

`TwitchSendGuestStarInvite`

public bool TwitchSendGuestStarInvite(string userLogin)

`TwitchUpdateChannelGuestStarSettings`

public bool TwitchUpdateChannelGuestStarSettings(Boolean? isModeratorSendLiveEnabled, Int32? slotCount, Boolean? isBrowserSourceAudioEnabled, string groupLayout, Boolean? regeneratgeBrowserSource)

`TwitchUpdateGuestStarSlot`

public bool TwitchUpdateGuestStarSlot(int sourceSlot, int destinationSlot)

`TwitchUpdateGuestStarSlotSettings`

public bool TwitchUpdateGuestStarSlotSettings(int slotId, Boolean? isAudioEnabled, Boolean? isVideoEnabled, Boolean? isLive, Int32? volume)

`TwitchAddBlockedTerm`

Adds selected term to the Twitch blocked list

0.2.4

public bool TwitchAddBlockedTerm(string term)

`TwitchAddModerator`

public bool TwitchAddModerator(string userName)

`TwitchAddVip`

public bool TwitchAddVip(string userName)

`TwitchApproveAutoHeldMessage`

Approve a message held by Auto Mod

0.2.4

public bool TwitchApproveAutoHeldMessage(string messageId)

`TwitchBanUser`

public bool TwitchBanUser(string userName, string reason, bool bot = false)

`TwitchBlockUser`

public bool TwitchBlockUser(string userLogin, TwitchBlockContext context = None, TwitchBlockReason reason = None)

`TwitchBlockUserById`

public bool TwitchBlockUserById(string userId, TwitchBlockContext context = None, TwitchBlockReason reason = None)

`TwitchDenyAutoHeldMessage`

Deny a message held by Auto Mod

0.2.4

public bool TwitchDenyAutoHeldMessage(string messageId)

`TwitchEmoteOnly`

public void TwitchEmoteOnly(bool enabled = true)

`TwitchFollowMode`

public void TwitchFollowMode(bool enabled = true, int duration = 0)

`TwitchGetBlockedTerms`

Returns a list of terms currently blocked on the Broadcaster's Twitch Channel

0.2.5

public List<string> TwitchGetBlockedTerms()

`TwitchRemoveBlockedTerm`

Removes selected term from the Twitch blocked list

0.2.4

public bool TwitchRemoveBlockedTerm(string term)

`TwitchRemoveModerator`

public bool TwitchRemoveModerator(string userName)

`TwitchRemoveVip`

public bool TwitchRemoveVip(string userName)

`TwitchSendShoutoutById`

public bool TwitchSendShoutoutById(string userId)

`TwitchSendShoutoutByLogin`

public bool TwitchSendShoutoutByLogin(string userLogin)

`TwitchShieldModeOff`

public bool TwitchShieldModeOff()

`TwitchShieldModeOn`

public bool TwitchShieldModeOn()

`TwitchSlowMode`

public void TwitchSlowMode(bool enabled = true, int duration = 0)

`TwitchSubscriberOnly`

public void TwitchSubscriberOnly(bool enabled = true)

`TwitchTimeoutUser`

public bool TwitchTimeoutUser(string username, int duration, string reason, bool bot = false)

`TwitchUnbanUser`

public bool TwitchUnbanUser(string userName, bool bot = false)

`TwitchUnblockUser`

public bool TwitchUnblockUser(string userLogin)

`TwitchUnblockUserById`

public bool TwitchUnblockUserById(string userId)

`TwitchWarnUser`

Warns specified Twitch user for the given reason

0.2.4

public bool TwitchWarnUser(string userName, string reason)

`TwitchPollArchive`

public void TwitchPollArchive(string pollId)

`TwitchPollCreate`

public bool TwitchPollCreate(string title, List<string> choices, int duration, int channelPointsPerVote = 0)

`TwitchPollTerminate`

public void TwitchPollTerminate(string pollId)

`TwitchPredictionCancel`

public void TwitchPredictionCancel(string predictionId)

`TwitchPredictionCreate`

public string TwitchPredictionCreate(string title, List<string> options, int duration)

public string TwitchPredictionCreate(string title, string firstOption, string secondOption, int duration)

`TwitchPredictionLock`

public void TwitchPredictionLock(string predictionId)

`TwitchPredictionResolve`

public void TwitchPredictionResolve(string predictionId, string winningId)

`TwitchCancelRaid`

public bool TwitchCancelRaid()

`TwitchStartRaidById`

public bool TwitchStartRaidById(string userId)

`TwitchStartRaidByName`

public bool TwitchStartRaidByName(string userName)

`GetTeamInfo`

public List<TeamInfo> GetTeamInfo(string username)

public List<TeamInfo> GetTeamInfo(int userId)

`GetTeamInfoById`

public List<TeamInfo> GetTeamInfoById(string userId)

`GetTeamInfoByLogin`

public List<TeamInfo> GetTeamInfoByLogin(string userLogin)

`TwitchGetBot`

Get info for the connected Twitch bot account

0.2.3

public TwitchUserInfo TwitchGetBot()

`TwitchGetBroadcaster`

Get Twitch user information of connected broadcaster

public TwitchUserInfo TwitchGetBroadcaster()

`TwitchGetExtendedUserInfoById`

Get Twitch extended user information of specified user id

public TwitchUserInfoEx TwitchGetExtendedUserInfoById(string userId)

`TwitchGetExtendedUserInfoByLogin`

public TwitchUserInfoEx TwitchGetExtendedUserInfoByLogin(string userLogin)

`TwitchGetUserInfoById`

public TwitchUserInfo TwitchGetUserInfoById(string userId)

`TwitchGetUserInfoByLogin`

public TwitchUserInfo TwitchGetUserInfoByLogin(string userLogin)

`TwitchIsUserSubscribed`

public bool TwitchIsUserSubscribed(string userId, out String& tier)