IBroadcastService – Steam Web API Documentation

This page is just a reference of all the known Steam APIs, I do not know how they work. Please do not email me with questions.

UNDOCUMENTEDGetBroadcastUploadStats

Gets broadcast upload stats for user

https://api.steampowered.com/IBroadcastService/GetBroadcastUploadStats/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
row_limit		uint32	No	How many at maximum to return.
start_time		uint32	No	Start time
upload_id		uint64	No	Optional relay upload ID - not compatible with session_id
steamid		fixed64	No	Optional the steamid whose stats you want, otherwise the user logged in - admin only
session_id		uint64	No	Optional broadcast session ID - not compatiable with upload_id

UNDOCUMENTEDGetBroadcastViewerStats

Gets viewer stats for given broadcast

https://api.steampowered.com/IBroadcastService/GetBroadcastViewerStats/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
upload_id		uint64	No	Get stats for this stream
steamid		fixed64	No	Optional: The steamid of the broadcast whose details you are requesting.

UNDOCUMENTEDGetBuildClipStatus

Start building a broadcast clip

https://api.steampowered.com/IBroadcastService/GetBuildClipStatus/v1/

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

UNDOCUMENTEDGetClipDetails

Get details for Broadcast Clips

https://api.steampowered.com/IBroadcastService/GetClipDetails/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_clip_id		uint64	No	List of clip IDs we want details for

UNDOCUMENTEDGetRTMPInfo

Gets RTMP broadcast info

https://api.steampowered.com/IBroadcastService/GetRTMPInfo/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
ip		uint32	No
steamid		fixed64	No	broadcaster steamID if not logged-in user

UNDOCUMENTEDPOSTMuteBroadcastChatUser

Mute a user in your broadcast chat

https://api.steampowered.com/IBroadcastService/MuteBroadcastChatUser/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
chat_id		fixed64	No
user_steamid		fixed64	No
muted		bool	No

UNDOCUMENTEDPOSTPostChatMessage

Post chat message to specified chat room

https://api.steampowered.com/IBroadcastService/PostChatMessage/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
chat_id		fixed64	No
message		string	No
instance_id		uint32	No
language		ELanguage	No	ELanguage of the user posting the message, default is english
country_code		string	No	The two letter country code

PUBLISHERPOSTPostGameDataFrame

Add a game meta data frame to broadcast

https://partner.steam-api.com/IBroadcastService/PostGameDataFrame/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	Yes
steamid		uint64	Yes
broadcast_id		uint64	Yes
frame_data		string	Yes

POSTPostGameDataFrameRTMP

Add a game meta data frame to broadcast from a client. Uses RTMP token for validation

https://api.steampowered.com/IBroadcastService/PostGameDataFrameRTMP/v1/

Name	Type	Required	Description
appid	uint32	Yes	AppID of the game being broadcasted
steamid	uint64	Yes	Broadcasters SteamID
rtmp_token	string	Yes	Valid RTMP token for the Broadcaster
frame_data	string	Yes	game data frame expressing current state of game (string, zipped, whatever)

UNDOCUMENTEDPOSTRemoveUserChatText

Tell all viewers to remove user chat text

https://api.steampowered.com/IBroadcastService/RemoveUserChatText/v1/

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

UNDOCUMENTEDPOSTSetClipDetails

Updates a broadcast clip

https://api.steampowered.com/IBroadcastService/SetClipDetails/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_clip_id		uint64	No	Clip ID
start_time		uint32	No	start time of the clip
end_time		uint32	No	end time of the clip
video_description		string	No

UNDOCUMENTEDPOSTSetRTMPInfo

Sets RTMP broadcast info

https://api.steampowered.com/IBroadcastService/SetRTMPInfo/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
broadcast_permission		int32	No
update_token		bool	No
broadcast_delay		int32	No
app_id		uint32	No
required_app_id		uint32	No
broadcast_chat_permission		EBroadcastChatPermission	No	Who is permitted to send a chat message during broadcast
broadcast_buffer		int32	No	Previous seconds we keep of the stream available
steamid		fixed64	No	broadcaster steamID if not logged-in user
chat_rate_limit		uint32	No	Seconds required between chat messages
enable_replay		bool	No	Enable replay of last upload
is_partner_chat_only		bool	No	When true, then only steamwork partner can create chat messages.
wordban_list		string	No

UNDOCUMENTEDPOSTStartBuildClip

Start building a broadcast clip

https://api.steampowered.com/IBroadcastService/StartBuildClip/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		fixed64	No
broadcast_session_id		fixed64	No
first_segment		int32	No
num_segments		int32	No
clip_description		string	No

UNDOCUMENTEDPOSTUpdateChatMessageFlair

Update chat message flair in the specified chat room

https://api.steampowered.com/IBroadcastService/UpdateChatMessageFlair/v1/

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