ISteamTVService – Steam Web API Documentation

UNDOCUMENTEDPOST

AddChatBan

Set the ban for a specific broadcaster. The issuer is the logged in steam account

https://api.steampowered.com/ISteamTVService/AddChatBan/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No
chatter_steamid		fixed64	No
duration		uint32	No
permanent		bool	No
undo		bool	No

UNDOCUMENTEDPOST

AddChatModerator

Add or remove a moderator for this broadcast channel

https://api.steampowered.com/ISteamTVService/AddChatModerator/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No
moderator_steamid		fixed64	No
undo		bool	No

UNDOCUMENTEDPOST

AddWordBan

Add or remove a banned keyword in this broadcast channel chat

https://api.steampowered.com/ISteamTVService/AddWordBan/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No
word		string	No
undo		bool	No

UNDOCUMENTEDPOST

AppCheer

The user is cheering for a specific broadcast for a specific app.

https://api.steampowered.com/ISteamTVService/AppCheer/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
app_id		uint32	No	App ID this cheer is for.
cheer_target_id		fixed64	No	The thing being cheered on. ID is app dependent (could be steam id, match id, lobby id, server id, etc).
cheers[0]		CSteamTV_AppCheer_SingleCheerType[]	No	The set of cheers this request represents (could be multiple of different types).
↳ cheer_type		uint32	No
↳ cheer_amount		uint32	No

UNDOCUMENTEDPOST

CreateBroadcastChannel

Create a channel on SteamTV

https://api.steampowered.com/ISteamTVService/CreateBroadcastChannel/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
unique_name		string	No	Unique short broadcast channel name, part of Steam.TV URL

UNDOCUMENTEDPOST

FollowBroadcastChannel

Follow a broadcast channel

https://api.steampowered.com/ISteamTVService/FollowBroadcastChannel/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No	Broadcast channel ID
undo		bool	No	Indicates this is an unfollow request

UNDOCUMENTED

GetBroadcastChannelBroadcasters

Get list of broadcaster info for this channel

https://api.steampowered.com/ISteamTVService/GetBroadcastChannelBroadcasters/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No	Broadcast channel ID

UNDOCUMENTED

GetBroadcastChannelClips

Get broadcast channel clips

https://api.steampowered.com/ISteamTVService/GetBroadcastChannelClips/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No

UNDOCUMENTED

GetBroadcastChannelID

Get a broadcast channel ID for a channel by name or owner SteamID

https://api.steampowered.com/ISteamTVService/GetBroadcastChannelID/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
unique_name		string	No	Channel short name)

UNDOCUMENTED

GetBroadcastChannelImages

Get broadcast channel images

https://api.steampowered.com/ISteamTVService/GetBroadcastChannelImages/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No	Broadcast channel ID
image_types		EBroadcastImageType	No	list of EBroadcastImage
image_types[0]		int32[]	No	list of EBroadcastImage

UNDOCUMENTED

GetBroadcastChannelInteraction

Get user's interaction status with a broadcast channel

https://api.steampowered.com/ISteamTVService/GetBroadcastChannelInteraction/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No	Broadcast channel ID

UNDOCUMENTED

GetBroadcastChannelLinks

Get broadcast channel link regions

https://api.steampowered.com/ISteamTVService/GetBroadcastChannelLinks/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No	Broadcast channel ID

UNDOCUMENTED

GetBroadcastChannelProfile

Get broadcast channel profile data

https://api.steampowered.com/ISteamTVService/GetBroadcastChannelProfile/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No	Broadcast channel ID

UNDOCUMENTED

GetBroadcastChannelStatus

Get broadcast channel live status

https://api.steampowered.com/ISteamTVService/GetBroadcastChannelStatus/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No	Broadcast channel ID

UNDOCUMENTED

GetChannels

Get the list of featured broadcast channels

https://api.steampowered.com/ISteamTVService/GetChannels/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
algorithm		EGetChannelsAlgorithm	No	The algorithm to use when picking channels to return
count		uint32	No	The maximum number of results to return
appid		uint32	No	Filter results to only this appid

UNDOCUMENTED

GetChatBans

Get list of bans for a specific broadcaster.

https://api.steampowered.com/ISteamTVService/GetChatBans/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No

UNDOCUMENTED

GetChatModerators

Returns the list of moderators for this broadcast channel

https://api.steampowered.com/ISteamTVService/GetChatModerators/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No

UNDOCUMENTED

GetFollowedChannels

Get list of followed channels by a viewer

https://api.steampowered.com/ISteamTVService/GetFollowedChannels/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key

UNDOCUMENTED

GetGames

Get list of games with active broadcasters

https://api.steampowered.com/ISteamTVService/GetGames/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	No	The ID for the game
algorithm		EGetGamesAlgorithm	No	The algorithm to use when picking games to return
count		uint32	No	The maximum number of results to return

UNDOCUMENTED

GetHomePageContents

Returns homepage contents for user

https://api.steampowered.com/ISteamTVService/GetHomePageContents/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key

UNDOCUMENTED

GetMyBroadcastChannels

Gets the broadcast channels that the current user owns

https://api.steampowered.com/ISteamTVService/GetMyBroadcastChannels/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key

UNDOCUMENTED

GetSteamTVUserSettings

Returns a user's SteamTV settings

https://api.steampowered.com/ISteamTVService/GetSteamTVUserSettings/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key

UNDOCUMENTED

GetSubscribedChannels

Get list of channels a user is subscribed to

https://api.steampowered.com/ISteamTVService/GetSubscribedChannels/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key

UNDOCUMENTED

GetWordBans

Returns the list of banned keywords for this broadcast channel

https://api.steampowered.com/ISteamTVService/GetWordBans/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No

UNDOCUMENTEDPOST

JoinChat

Joins the chat channel for a broadcast

https://api.steampowered.com/ISteamTVService/JoinChat/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No

UNDOCUMENTEDPOST

ReportBroadcastChannel

Report a broadcast channel

https://api.steampowered.com/ISteamTVService/ReportBroadcastChannel/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No	Broadcast channel ID
reason		string	No	The reason for the report

UNDOCUMENTED

Search

Searches for broadcast channels based on input keywords

https://api.steampowered.com/ISteamTVService/Search/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
term		string	No

UNDOCUMENTEDPOST

SetBroadcastChannelImage

Set broadcast channel image hash

https://api.steampowered.com/ISteamTVService/SetBroadcastChannelImage/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No	Broadcast channel ID
image_type		EBroadcastImageType	No	EBroadcastImage
image_index		uint32	No	Index of the image (for supporting multiple uploads of the same type
image_width		uint32	No	width in pixels
image_height		uint32	No	height in pixels
file_size		uint32	No	in bytes
file_extension		string	No	eg .jpg
file_hash		string	No	image SHA
undo		bool	No	indicates this is a delete request

UNDOCUMENTEDPOST

SetBroadcastChannelLinkRegions

Set broadcast channel link regions

https://api.steampowered.com/ISteamTVService/SetBroadcastChannelLinkRegions/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No	Broadcast channel ID
links[0]		CSteamTV_SetBroadcastChannelLinkRegions_Request.Links[]	No
↳ link_index		uint32	No
↳ url		string	No
↳ link_description		string	No
↳ left		uint32	No
↳ top		uint32	No
↳ width		uint32	No
↳ height		uint32	No

UNDOCUMENTEDPOST

SetBroadcastChannelProfile

Set broadcast channel profile data

https://api.steampowered.com/ISteamTVService/SetBroadcastChannelProfile/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No	Broadcast channel ID
name		string	No	long channel name
language		string	No	primary channel language (Steam shortname)
headline		string	No	short channel desciption
summary		string	No	long channel desciption
avatar_hash		string	No	community avatar hash
schedule		string	No	broadcast channel schedule
rules		string	No	broadcast channel rules
panels		string	No	JSON data representing the channel panel layout

UNDOCUMENTEDPOST

SetSteamTVUserSettings

Sets a user's SteamTV settings

https://api.steampowered.com/ISteamTVService/SetSteamTVUserSettings/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
stream_live_email		bool	No	Send email when followed stream starts
stream_live_notification		bool	No	Send Steam notification when followed stream starts

UNDOCUMENTEDPOST

SubscribeBroadcastChannel

Subscribe to a broadcast channel

https://api.steampowered.com/ISteamTVService/SubscribeBroadcastChannel/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_channel_id		fixed64	No	Broadcast channel ID