Loading

Steam API

325 of the known Steam web API endpoints.

For the Game DB API, see here. Thanks to SteamTracking for the private ones.
Your API key only gets stored in your browser.

IAccountRecoveryService

ReportAccountRecoveryData V1 Undocumented
POST
Value Name Type Required Description
install_config string
loginuser_list string
machineid string
shasentryfile string
RetrieveAccountRecoveryData V1 Undocumented
POST
Value Name Type Required Description
requesthandle string

IBroadcastService

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

ICSGOPlayers_730

GET
Value Name Type Required Description
knowncode string Previously known match sharing code obtained from the SteamID
steamid uint64 The SteamID of the user
steamidkey string Authentication obtained from the SteamID
GetPlayerProfileCoin V1 Undocumented
GET
Value Name Type Required Description
coin string The coin
steamid uint64 The steam ID

ICSGOServers_730

GET
Value Name Type Required Description
gamemode string What game mode is requested, possible values: competitive, casual
interval string What recent interval is requested, possible values: day, week, month
mapgroup string What maps are requested, possible values: operation

ICSGOTournaments_730

GET
Value Name Type Required Description
event uint32 The event ID
steamid uint64 The SteamID of the user inventory
steamidkey string Authentication obtained from the SteamID
GET
Value Name Type Required Description
event uint32 The event ID
steamid uint64 The SteamID of the user inventory
steamidkey string Authentication obtained from the SteamID
GET
Value Name Type Required Description
event uint32 The event ID
GET
Value Name Type Required Description
event uint32 The event ID
steamid uint64 The SteamID of the user inventory
steamidkey string Authentication obtained from the SteamID
POST
Value Name Type Required Description
event uint32 The event ID
itemid0 uint64 ItemID to lock in for the pick
itemid1 uint64 ItemID to lock in for the pick
itemid2 uint64 ItemID to lock in for the pick
itemid3 uint64 ItemID to lock in for the pick
itemid4 uint64 ItemID to lock in for the pick
pickid0 uint32 PickID to select for the slot
pickid1 uint32 PickID to select for the slot
pickid2 uint32 PickID to select for the slot
pickid3 uint32 PickID to select for the slot
pickid4 uint32 PickID to select for the slot
sectionid uint32 Event section id
steamid uint64 The SteamID of the user inventory
steamidkey string Authentication obtained from the SteamID
POST
Value Name Type Required Description
event uint32 The event ID
groupid uint32 Event group id
index uint32 Index in group
itemid uint64 ItemID to lock in for the pick
pickid uint32 Pick ID to select
sectionid uint32 Event section id
steamid uint64 The SteamID of the user inventory
steamidkey string Authentication obtained from the SteamID

IChatRoomService

AppAddUsersToGroup V1 Undocumented
POST
Value Name Type Required Description
appid uint32
chat_group_id uint64
steamids uint64
suppress_log_messages bool
AppPostSystemMessageToGroup V1 Undocumented
POST
Value Name Type Required Description
appid uint32
chat_group_id uint64
loc_token string
message string
params {message}
AppRemoveUsersFromGroup V1 Undocumented
POST
Value Name Type Required Description
appid uint32
chat_group_id uint64
kick_expiration int32
steamid_kick_actor uint64
steamid_targets uint64
suppress_log_messages bool
CreateAppChatRoomGroup V1 Undocumented
POST
Value Name Type Required Description
appid uint32
name string
room_type uint32
steamid_owner uint64

ICheatReportingService

EndSecureMultiplayerSession V1 Undocumented
POST
Value Name Type Required Description
appid uint32 The appid the user is playing.
session_id uint64 session id
steamid uint64 steamid of the user.
GetCheatingReports V1 Undocumented
GET
Value Name Type Required Description
appid uint32 The appid.
includebans bool (Optional) Include ban requests.
includereports bool (Optional) Include reports.
reportidmin uint64 Minimum reportID to include
steamid uint64 (Optional) Query just for this steamid.
timebegin uint32 The end of the time range.
timeend uint32 The beginning of the time range .
RemovePlayerGameBan V1 Undocumented
POST
Value Name Type Required Description
appid uint32 The appid.
steamid uint64 steamid of the user who is reported as cheating.
POST
Value Name Type Required Description
appid uint32 The appid.
cheat_data_dump string data collection in json format
cheat_param_1 uint64 cheat param 1
cheat_param_2 uint64 cheat param 2
cheat_process_id uint32 process ID of the cheat process that ran
cheatname string descriptive name for the cheat.
game_process_id uint32 process ID of the running game.
pathandfilename string path and file name of the cheat executable.
steamid uint64 steamid of the user running and reporting the cheat.
time_now uint64 local system time now.
time_started uint64 local system time when cheat process started. ( 0 if not yet run )
time_stopped uint64 local system time when cheat process stopped. ( 0 if still running )
webcheaturl string web url where the cheat was found and downloaded.
ReportPlayerCheating V1 Undocumented
POST
Value Name Type Required Description
appdata uint64 (Optional) App specific data about the cheating.
appid uint32 The appid.
cheating_type uint64 (Optional) app specific data about the type of cheating
detection bool (Optional) extra information about the source of the cheating - was it a detection.
gamemode uint32 (Optional) extra information about state of game - was it a specific type of game play (0 = generic)
heuristic bool (Optional) extra information about the source of the cheating - was it a heuristic.
matchid uint64 (Optional) matchid to identify the game instance
noreportid bool (Optional) dont return report id
playerreport bool (Optional) extra information about the source of the cheating - was it a player report.
severity uint32 (Optional) level of severity of bad action being reported
steamid uint64 steamid of the user who is reported as cheating.
steamidreporter uint64 (Optional) steamid of the user or game server who is reporting the cheating.
suspicionstarttime uint32 (Optional) extra information indicating how far back the game thinks is interesting for this user
RequestPlayerGameBan V1 Undocumented
POST
Value Name Type Required Description
appid uint32 The appid.
cheatdescription string Text describing cheating infraction.
delayban bool Delay the ban according to default ban delay rules.
duration uint32 Ban duration requested in seconds.
flags uint32 Additional information about the ban request.
invisible_ban bool The ban will be recorded but not be visible or deny access to secure servers.
reportid uint64 The reportid originally used to report cheating.
steamid uint64 steamid of the user who is reported as cheating.
RequestVacStatusForUser V1 Undocumented
POST
Value Name Type Required Description
appid uint32 The appid the user is playing.
session_id uint64 session id
steamid uint64 steamid of the user.
POST
Value Name Type Required Description
appid uint32 The appid the user is playing.
steamid uint64 steamid of the user.

IContentFilteringService

FilterStrings V1 Undocumented
GET
Value Name Type Required Description
appid int32 AppID that is asking to having filtering performed.
language string In which language should filtering be performed. If empty, no profanity filtering will be performed.
legal_filtering_country string If set to an ISO 3166-1 Alpha-2 country code that requires legal filtering, that legal filtering will be performed.
raw_strings string The list of strings to be filtered.

IContentServerConfigService

GET
Value Name Type Required Description
cache_id uint32 Unique ID number
cache_key string Valid current cache API key
POST
Value Name Type Required Description
allowed_ip_blocks string comma-separated list of allowed IP address blocks in CIDR format - blank to clear unfilter
cache_id uint32 Unique ID number
cache_key string Valid current cache API key
change_notes string Notes
POST
Value Name Type Required Description
cache_hit_percent uint32 Percent cache hits
cache_id uint32 Unique ID number
cache_key string Valid current cache API key
cpu_percent uint32 Percent CPU load
mbps_recv uint32 Incoming network traffic in Mbps
mbps_sent uint32 Outgoing network traffic in Mbps
num_connected_ips uint32 Number of unique connected IP addresses
upstream_egress_utilization uint32 What is the percent utilization of the busiest datacenter egress link?

IContentServerDirectoryService

GET
Value Name Type Required Description
appid uint32
depotid uint32
source_manifestid uint64
target_manifestid uint64
GET
Value Name Type Required Description
cell_id uint32 client Cell ID
ip_override string client IP address
launcher_type int32 launcher type
max_servers uint32 max servers in response list

IDOTA2Fantasy_205790

GET
Value Name Type Required Description
EndTime uint32 An optional filter for maximum timestamp
FantasyLeagueID uint32 The fantasy league ID
MatchID uint64 An optional filter for a specific match
PlayerAccountID uint32 An optional filter for a specific player
SeriesID uint32 An optional filter for a specific series
StartTime uint32 An optional filter for minimum timestamp
GET
Value Name Type Required Description
accountid uint32 The account ID to look up

IDOTA2Fantasy_570

GetFantasyPlayerStats V1 Undocumented
GET
Value Name Type Required Description
EndTime uint32 An optional filter for maximum timestamp
FantasyLeagueID uint32 The fantasy league ID
MatchID uint64 An optional filter for a specific match
PlayerAccountID uint32 An optional filter for a specific player
SeriesID uint32 An optional filter for a specific series
StartTime uint32 An optional filter for minimum timestamp
GetPlayerOfficialInfo V1 Undocumented
GET
Value Name Type Required Description
accountid uint32 The account ID to look up

IDOTA2MatchStats_205790

GET
Value Name Type Required Description
server_steam_id uint64

IDOTA2MatchStats_570

GET
Value Name Type Required Description
server_steam_id uint64

IDOTA2Match_205790

GET
Value Name Type Required Description
league_id uint32 Only show matches of the specified league id
match_id uint64 Only show matches of the specified match id
GET
Value Name Type Required Description
match_id uint64 Match id
GET
Value Name Type Required Description
account_id string An account ID to get matches from. This will fail if the user has their match history hidden
game_mode uint32 Which game mode to return matches for
hero_id uint32 The ID of the hero that must be in the matches being queried
league_id string The league ID to return games from
matches_requested string The number of requested matches to return
min_players string Minimum number of human players that must be in a match for it to be returned
skill uint32 The average skill range of the match, these can be [1-3] with lower numbers being lower skill. Ignored if an account ID is specified
start_at_match_id uint64 The minimum match ID to start from
GET
Value Name Type Required Description
matches_requested uint32
start_at_match_seq_num uint64
GET
Value Name Type Required Description
start_at_team_id uint64
teams_requested uint32
GET
Value Name Type Required Description
partner int32 Which partner's games to use.
GET
Value Name Type Required Description
partner int32 Which partner's games to use.
GET
Value Name Type Required Description
home_division int32 Prefer matches from this division.
partner int32 Which partner's games to use.
GET
Value Name Type Required Description
account_id string
hero_id string
league_id string
match_id uint64
phase_id uint32
time_frame string
GET
Value Name Type Required Description
account_id string
hero_id string
league_id string
match_id uint64
phase_id uint32
time_frame string

IDOTA2Match_570

GET
Value Name Type Required Description
league_id uint32 Only show matches of the specified league id
match_id uint64 Only show matches of the specified match id
GET
Value Name Type Required Description
include_persona_names bool Include persona names as part of the response
match_id uint64 Match id
GET
Value Name Type Required Description
account_id string An account ID to get matches from. This will fail if the user has their match history hidden
game_mode uint32 Which game mode to return matches for
hero_id uint32 The ID of the hero that must be in the matches being queried
league_id string The league ID to return games from
matches_requested string The number of requested matches to return
min_players string Minimum number of human players that must be in a match for it to be returned
skill uint32 The average skill range of the match, these can be [1-3] with lower numbers being lower skill. Ignored if an account ID is specified
start_at_match_id uint64 The minimum match ID to start from
GET
Value Name Type Required Description
matches_requested uint32
start_at_match_seq_num uint64
GET
Value Name Type Required Description
start_at_team_id uint64
teams_requested uint32
GET
Value Name Type Required Description
partner int32 Which partner's games to use.
GET
Value Name Type Required Description
partner int32 Which partner's games to use.
GET
Value Name Type Required Description
home_division int32 Prefer matches from this division.
partner int32 Which partner's games to use.
GET
Value Name Type Required Description
account_id string
hero_id string
league_id string
match_id uint64
time_frame string
GET
Value Name Type Required Description
account_id string
hero_id string
league_id string
match_id uint64
phase_id uint32
time_frame string

IDOTA2StreamSystem_205790

GET
Value Name Type Required Description
broadcaster_steam_id uint64 64-bit Steam ID of the broadcaster
league_id uint32 LeagueID to use if we aren't in a lobby

IDOTA2StreamSystem_570

GET
Value Name Type Required Description
broadcaster_steam_id uint64 64-bit Steam ID of the broadcaster
league_id uint32 LeagueID to use if we aren't in a lobby

IDOTA2Support_570

GetPersonalData V1 Undocumented
GET
Value Name Type Required Description
account_id uint32 Account ID of user.
page int32 Page requested
table uint32 Table index

IDOTA2Teams_205790

GetTeamInfo V1 Undocumented
GET
Value Name Type Required Description
league_id uint32 League ID for which you're requesting all regisered teams info
team_id uint32 Team ID that you're requesting info about

IDOTA2Teams_570

GetTeamInfo V1 Undocumented
GET
Value Name Type Required Description
league_id uint32 League ID for which you're requesting all regisered teams info
team_id uint32 Team ID that you're requesting info about

IDOTA2Ticket_205790

GET
Value Name Type Required Description
BadgeID string The Badge ID
ValidBadgeType1 uint32 Valid Badge Type 1
ValidBadgeType2 uint32 Valid Badge Type 2
ValidBadgeType3 uint32 Valid Badge Type 3
GET
Value Name Type Required Description
BadgeID string The badge ID
POST
Value Name Type Required Description
BadgeType uint32 Badge Type
steamid uint64 The 64-bit Steam ID
GET
Value Name Type Required Description
ValidBadgeType1 uint32 Valid Badge Type 1
ValidBadgeType2 uint32 Valid Badge Type 2
ValidBadgeType3 uint32 Valid Badge Type 3
steamid uint64 The 64-bit Steam ID

IDOTA2Ticket_570

GET
Value Name Type Required Description
BadgeID string The Badge ID
ValidBadgeType1 uint32 Valid Badge Type 1
ValidBadgeType2 uint32 Valid Badge Type 2
ValidBadgeType3 uint32 Valid Badge Type 3
GET
Value Name Type Required Description
BadgeID string The badge ID
POST
Value Name Type Required Description
BadgeType uint32 Badge Type
steamid uint64 The 64-bit Steam ID
GET
Value Name Type Required Description
ValidBadgeType1 uint32 Valid Badge Type 1
ValidBadgeType2 uint32 Valid Badge Type 2
ValidBadgeType3 uint32 Valid Badge Type 3
steamid uint64 The 64-bit Steam ID

IEconDOTA2_205790

GET
Value Name Type Required Description
accountid uint32 The account ID to look up.
eventid uint32 The League ID of the compendium you're looking for.
language string The language to provide hero names in.
GET
Value Name Type Required Description
language string The language to provide item names in.
GET
Value Name Type Required Description
itemizedonly bool Return a list of itemized heroes only.
language string The language to provide hero names in.
GET
Value Name Type Required Description
iconname string The item icon name to get the CDN path of
icontype uint32 The type of image you want. 0 = normal, 1 = large, 2 = ingame
GET
Value Name Type Required Description
language string The language to provide rarity names in.
GET
Value Name Type Required Description
leagueid uint32 The ID of the league to get the prize pool of

IEconDOTA2_570

GET
Value Name Type Required Description
accountid uint32 The account ID to look up.
eventid uint32 The League ID of the compendium you're looking for.
language string The language to provide hero names in.
GET
Value Name Type Required Description
language string The language to provide item names in.
GET
Value Name Type Required Description
itemizedonly bool Return a list of itemized heroes only.
language string The language to provide hero names in.
GET
Value Name Type Required Description
itemdef uint32 The item definition to get creator information for.
GET
Value Name Type Required Description
language string The language to provide rarity names in.
GET
Value Name Type Required Description
leagueid uint32 The ID of the league to get the prize pool of

IEconItems_1046930

GET
Value Name Type Required Description
steamid uint64 The Steam ID to fetch items for

IEconItems_205790

GET
Value Name Type Required Description
class_id uint32 Return items equipped for this class id
steamid uint64 The Steam ID to fetch items for
GET
Value Name Type Required Description
steamid uint64 The Steam ID to fetch items for
GET
Value Name Type Required Description
language string The language to results in.

IEconItems_218620

GetPlayerItems V1 Undocumented
GET
Value Name Type Required Description
steamid uint64 The Steam ID to fetch items for

IEconItems_221540

GET
Value Name Type Required Description
steamid uint64 The Steam ID to fetch items for

IEconItems_238460

GET
Value Name Type Required Description
steamid uint64 The Steam ID to fetch items for

IEconItems_440

GET
Value Name Type Required Description
steamid uint64 The Steam ID to fetch items for
GET
Value Name Type Required Description
language string The language to return the names in. Defaults to returning string keys.
GET
Value Name Type Required Description
language string The language to return the names in. Defaults to returning string keys.
start int32 The first item id to return. Defaults to 0. Response will indicate next value to query if applicable.
GET
Value Name Type Required Description
language string The language to return the names in. Defaults to returning string keys.
GET
Value Name Type Required Description
language string The language to results in.

IEconItems_570

GET
Value Name Type Required Description
class_id uint32 Return items equipped for this class id
steamid uint64 The Steam ID to fetch items for
GET
Value Name Type Required Description
steamid uint64 The Steam ID to fetch items for
GET
Value Name Type Required Description
language string The language to results in.

IEconItems_583950

GET
Value Name Type Required Description
class_id uint32 Return items equipped for this class id
steamid uint64 The Steam ID to fetch items for

IEconItems_620

GET
Value Name Type Required Description
steamid uint64 The Steam ID to fetch items for
GET
Value Name Type Required Description
language string The language to return the names in. Defaults to returning string keys.

IEconItems_730

GET
Value Name Type Required Description
steamid uint64 The Steam ID to fetch items for
GET
Value Name Type Required Description
language string The language to return the names in. Defaults to returning string keys.
GET
Value Name Type Required Description
language string The language to results in.

IEconItems_841

GetPlayerItems V1 Undocumented
GET
Value Name Type Required Description
steamid uint64 The Steam ID to fetch items for
GetSchema V1 Undocumented
GET
Value Name Type Required Description
language string The language to return the names in. Defaults to returning string keys.

IEconMarketService

CancelAppListingsForUser V1 Undocumented
POST
Value Name Type Required Description
appid uint32 The app making the request
steamid uint64 The SteamID of the user whose listings should be canceled
synchronous bool Whether or not to wait until all listings have been canceled before returning the response
vac bool This was in response to a VAC ban?
GetAssetID V1 Undocumented
GET
Value Name Type Required Description
appid uint32 The app that's asking. Must match the app of the listing and must belong to the publisher group that owns the API key making the request
listingid uint64 The identifier of the listing to get information for
GetMarketEligibility V1 Undocumented
GET
Value Name Type Required Description
steamid uint64 The SteamID of the user to check
GetPopular V1 Undocumented
GET
Value Name Type Required Description
ecurrency uint32 If present, prices returned will be represented in this currency
filter_appid uint32 If present, the app ID to limit results to
language string The language to use in item descriptions
rows uint32 Number of rows per page
start uint32 The result number to start at
LearnItem V1 Undocumented
POST
Value Name Type Required Description
appid uint32 The app the item belongs to
class_name string Asset class property names
class_value string Asset class property value

IEconService

POST
Value Name Type Required Description
tradeofferid uint64
POST
Value Name Type Required Description
tradeofferid uint64
FlushAssetAppearanceCache V1 Undocumented
POST
Value Name Type Required Description
appid uint32
FlushContextCache V1 Undocumented
POST
Value Name Type Required Description
appid uint32
FlushInventoryCache V1 Undocumented
POST
Value Name Type Required Description
appid uint32 App to clear cache for.
contextid uint64 Context to clear cache for.
steamid uint64 User to clear cache for.
GET
Value Name Type Required Description
get_descriptions bool If set, the item display data for the items included in the returned trades will also be returned
include_failed bool
include_total bool If set, the total number of trades the account has participated in will be included in the response
language string The language to use when loading item display data
max_trades uint32 The number of trades to return information for
navigating_back bool The user wants the previous page of results, so return the previous max_trades trades before the start time and ID
start_after_time uint32 The time of the last trade shown on the previous page of results, or the time of the first trade if navigating back
start_after_tradeid uint64 The tradeid shown on the previous page of results, or the ID of the first trade if navigating back
GET
Value Name Type Required Description
steamid_target uint64 User you are trading with
trade_offer_access_token string A special token that allows for trade offers from non-friends.
GET
Value Name Type Required Description
get_descriptions bool If set, the item display data for the items included in the returned trade offers will also be returned. If one or more descriptions can't be retrieved, then your request will fail.
language string
tradeofferid uint64
GET
Value Name Type Required Description
active_only bool Indicates we should only return offers which are still active, or offers that have changed in state since the time_historical_cutoff
get_descriptions bool If set, the item display data for the items included in the returned trade offers will also be returned. If one or more descriptions can't be retrieved, then your request will fail.
get_received_offers bool Request the list of received offers.
get_sent_offers bool Request the list of sent offers.
historical_only bool Indicates we should only return offers which are not active.
language string The language to use when loading item display data.
time_historical_cutoff uint32 When active_only is set, offers updated since this time will also be returned
GET
Value Name Type Required Description
time_last_visit uint32 The time the user last visited. If not passed, will use the time the user last visited the trade offer page.
GET
Value Name Type Required Description
get_descriptions bool If set, the item display data for the items included in the returned trades will also be returned
language string The language to use when loading item display data
tradeid uint64

IGameInventory

GetHistoryCommandDetails V1 Undocumented
GET
Value Name Type Required Description
appid uint32 appid of game
arguments string The arguments that were provided with the command in the first place
command string The command to run on that asset
contextid uint64 The context to fetch history for
steamid uint64 The steam ID of the account to operate on
GetUserHistory V1 Undocumented
GET
Value Name Type Required Description
appid uint32 appid of game
contextid uint64 The context to fetch history for
endtime uint32 End time of the history range to collect
starttime uint32 Start time of the history range to collect
steamid uint64 The Steam ID to fetch history for
HistoryExecuteCommands V1 Undocumented
POST
Value Name Type Required Description
actorid uint32 A unique 32 bit ID for the support person executing the command
appid uint32 appid of game
contextid uint64 The context to fetch history for
steamid uint64 The asset ID to operate on
SupportGetAssetHistory V1 Undocumented
GET
Value Name Type Required Description
appid uint32 appid of game
assetid uint64 The asset ID to operate on
contextid uint64 The context to fetch history for

IGameNotificationsService

CreateSession V1 Undocumented
POST
Value Name Type Required Description
appid uint32 The appid to create the session for.
context uint64 Game-specified context value the game can used to associate the session with some object on their backend.
steamid uint64 (Optional) steamid to make the request on behalf of -- if specified, the user must be in the session and all users being added to the session must be friends with the user.
title {message} The title of the session to be displayed within each user's list of sessions.
users {message} The initial state of all users in the session.
DeleteSession V1 Undocumented
POST
Value Name Type Required Description
appid uint32 The appid of the session to delete.
sessionid uint64 The sessionid to delete.
steamid uint64 (Optional) steamid to make the request on behalf of -- if specified, the user must be in the session.
DeleteSessionBatch V1 Undocumented
POST
Value Name Type Required Description
appid uint32 The appid of the session to delete.
sessionid uint64 The sessionid to delete.
EnumerateSessionsForApp V1 Undocumented
GET
Value Name Type Required Description
appid uint32 The sessionid to request details for. Optional. If not specified, all the user's sessions will be returned.
include_all_user_messages bool (Optional) Boolean determining whether the message for all users should be included. Defaults to false.
include_auth_user_message bool (Optional) Boolean determining whether the message for the authenticated user should be included. Defaults to false.
language string (Optional) Language to localize the text in.
steamid uint64 The user whose sessions are to be enumerated.
GetSessionDetailsForApp V1 Undocumented
GET
Value Name Type Required Description
appid uint32 The appid for the sessions.
language string Language to localize the text in.
sessions {message}
RequestNotifications V1 Undocumented
POST
Value Name Type Required Description
appid uint32 The appid to request notifications for.
steamid uint64 The steamid to request notifications for.
UpdateSession V1 Undocumented
POST
Value Name Type Required Description
appid uint32 The appid of the session to update.
sessionid uint64 The sessionid to update.
steamid uint64 (Optional) steamid to make the request on behalf of -- if specified, the user must be in the session and all users being added to the session must be friends with the user.
title {message} (Optional) The new title of the session. If not specified, the title will not be changed.
users {message} (Optional) A list of users whose state will be updated to reflect the given state. If the users are not already in the session, they will be added to it.
POST
Value Name Type Required Description
appid uint32 The appid to create the session for.
context uint64 Game-specified context value the game can used to associate the session with some object on their backend.
steamid uint64 (Optional) steamid to make the request on behalf of -- if specified, the user must be in the session and all users being added to the session must be friends with the user.
title {message} The title of the session to be displayed within each user's list of sessions.
users {message} The initial state of all users in the session.
POST
Value Name Type Required Description
appid uint32 The appid of the session to delete.
sessionid uint64 The sessionid to delete.
steamid uint64 (Optional) steamid to make the request on behalf of -- if specified, the user must be in the session.
POST
Value Name Type Required Description
appid uint32 The appid of the session to update.
sessionid uint64 The sessionid to update.
steamid uint64 (Optional) steamid to make the request on behalf of -- if specified, the user must be in the session and all users being added to the session must be friends with the user.
title {message} (Optional) The new title of the session. If not specified, the title will not be changed.
users {message} (Optional) A list of users whose state will be updated to reflect the given state. If the users are not already in the session, they will be added to it.

IGameServersService

POST
Value Name Type Required Description
appid uint32 The app to use the account for
memo string The memo to set on the new account
POST
Value Name Type Required Description
steamid uint64 The SteamID of the game server account to delete
GET
Value Name Type Required Description
GET
Value Name Type Required Description
steamid uint64 The SteamID of the game server to get info on
GET
Value Name Type Required Description
server_steamids uint64
GET
Value Name Type Required Description
server_ips string
GET
Value Name Type Required Description
login_token string Login token to query
POST
Value Name Type Required Description
steamid uint64 The SteamID of the game server to reset the login token of
SetBanStatus V1 Undocumented
POST
Value Name Type Required Description
appid uint32
ban_seconds uint32
banned bool
steamid uint64
SetMemo V1
POST
Value Name Type Required Description
memo string The memo to set on the new account
steamid uint64 The SteamID of the game server to set the memo on

IInventoryService

AddItem V1 Undocumented
POST
Value Name Type Required Description
appid uint32
is_purchase bool If set, treat requestid as a txnid and create this item as a result of user microtransaction purchase.
itemdefid uint64
itempropsjson string
notify bool Should notify the user that the item was added to their Steam Inventory.
requestid uint64
steamid uint64
trade_restriction bool If true, apply the default trade and market restriction times to this item.
AddPromoItem V1 Undocumented
POST
Value Name Type Required Description
appid uint32
is_purchase bool If set, treat requestid as a txnid and create this item as a result of user microtransaction purchase.
itemdefid uint64
itempropsjson string
notify bool Should notify the user that the item was added to their Steam Inventory.
requestid uint64
steamid uint64
trade_restriction bool If true, apply the default trade and market restriction times to this item.
POST
Value Name Type Required Description
appid uint32
destitemid uint64
fromitemid uint64
quantity uint32
Consolidate V1 Undocumented
POST
Value Name Type Required Description
appid uint32
force bool
itemdefid uint64
steamid uint64
ConsolidateAll V1 Undocumented
POST
Value Name Type Required Description
appid uint32
force bool
steamid uint64
ExchangeItem V1 Undocumented
POST
Value Name Type Required Description
appid uint32
materialsitemid uint64
materialsquantity uint32
outputitemdefid uint64
steamid uint64
GetAddItemHistory V1 Undocumented
GET
Value Name Type Required Description
appid uint32
max_results uint32
start_highwater uint64
start_timestamp uint32
GetInventory V1 Undocumented
GET
Value Name Type Required Description
appid uint32
steamid uint64
GetItemDefs V1 Undocumented
GET
Value Name Type Required Description
appid uint32
cache_max_age_seconds uint32 Allow stale data to be returned for the specified number of seconds.
itemdefids uint64
modifiedsince string
workshopids uint64
GET
Value Name Type Required Description
ecurrency int32
GetQuantity V1 Undocumented
GET
Value Name Type Required Description
appid uint32
force bool
itemdefid uint64
steamid uint64
ModifyItems V1 Undocumented
POST
Value Name Type Required Description
appid uint32
steamid uint64
timestamp uint32
updates {message}
POST
Value Name Type Required Description
appid uint32
itemid uint64
quantity uint32

ILobbyMatchmakingService

CreateLobby V1 Undocumented
POST
Value Name Type Required Description
appid uint32
lobby_metadata {message}
lobby_name string
lobby_type int32
max_members int32
steamid_invited_members uint64
RemoveUserFromLobby V1 Undocumented
POST
Value Name Type Required Description
appid uint32
steamid_lobby uint64
steamid_to_remove uint64

IOnlinePlayService

GetCoPlayStatus V1 Undocumented
POST
Value Name Type Required Description
appid uint32 App ID of request
steamid uint64 Steam ID 1 of request
steamid2 uint64 Steam ID 2 of request
time_range_begin uint32 unix time range begin to check
time_range_end uint32 unix time range end to check

IPlayerService

GET
Value Name Type Required Description
steamid uint64 The player we're asking about
GET
Value Name Type Required Description
badgeid int32 The badge we're asking about
steamid uint64 The player we're asking about
GET
Value Name Type Required Description
appids_filter uint32 if set, restricts result set to the passed in apps
include_appinfo bool true if we want additional details (name, icon) about each game
include_played_free_games bool Free games are excluded by default. If this is set, free games the user has played will be returned.
steamid uint64 The player we're asking about
GET
Value Name Type Required Description
count uint32 The number of games to return (0/unset: all)
steamid uint64 The player we're asking about
GET
Value Name Type Required Description
steamid uint64 The player we're asking about
GET
Value Name Type Required Description
appid_playing uint32 The game player is currently playing
steamid uint64 The player we're asking about
POST
Value Name Type Required Description
play_sessions {message}
steamid uint64
ticket string

IPortal2Leaderboards_620

GET
Value Name Type Required Description
leaderboardName string The leaderboard name to fetch data for.

IPortal2Leaderboards_841

GetBucketizedData V1 Undocumented
GET
Value Name Type Required Description
leaderboardName string The leaderboard name to fetch data for.

IProductInfoService

SetRichPresenceLocalization V1 Undocumented
POST
Value Name Type Required Description
appid uint32
languages {message}
steamid uint64

IPublishedFileService

GET
Value Name Type Required Description
appid uint32
desired_revision {enum} Return the data for the specified revision.
includeadditionalpreviews bool If true, return preview information in the returned details.
includechildren bool If true, return children in the returned details.
includeforsaledata bool If true, return pricing data, if applicable.
includekvtags bool If true, return key value tags in the returned details.
includemetadata bool If true, populate the metadata field.
includetags bool If true, return tag information in the returned details.
includevotes bool If true, return vote data in the returned details.
language int32 Specifies the localized text to return. Defaults to English.
publishedfileids uint64 Set of published file Ids to retrieve details for.
return_playtime_stats uint32 Return playtime stats for the specified number of days before today.
short_description bool If true, return a short description instead of the full description.
strip_description_bbcode bool Strips BBCode from descriptions.
GET
Value Name Type Required Description
appid uint32 App Id of the app that the files were published to.
cache_max_age_seconds uint32 Allow stale data to be returned for the specified number of seconds.
creator_appid uint32 App Id of the app that published the files, only matched if specified.
desired_revision {enum} Return the data for the specified revision.
excludedtags string (Optional) Tags that must NOT be present on a published file to satisfy the query.
filetype uint32 (Optional) File type to match files to.
ids_only bool (Optional) If true, only return the published file ids of files that satisfy this query.
language int32 Specifies the localized text to return. Defaults to English.
match_cloud_filename string Match this cloud filename if specified.
numperpage uint32 (Optional) The number of results, per page to return.
page uint32 (Optional) Starting page for results.
privacy uint32 (optional) Filter by privacy settings.
required_kv_tags {message} Required key-value tags to match on.
requiredtags string (Optional) Tags that must be present on a published file to satisfy the query.
return_children bool Return child item ids in the file details
return_for_sale_data bool Return pricing information, if applicable
return_kv_tags bool Return key-value tags in the file details
return_metadata bool Populate the metadata field
return_playtime_stats uint32 Return playtime stats for the specified number of days before today.
return_previews bool Return preview image and video details in the file details
return_short_description bool Populate the short_description field instead of file_description
return_tags bool Return tags in the file details
return_vote_data bool Return vote data
sortmethod string (Optional) Sorting method to use on returned values.
steamid uint64 Steam ID of the user whose files are being requested.
strip_description_bbcode bool Strips BBCode from descriptions.
taggroups {message} (Optional) At least one of the tags must be present on a published file to satisfy the query.
totalonly bool (Optional) If true, only return the total number of files that satisfy this query.
type string (Optional) Type of files to be returned.
GET
Value Name Type Required Description
appid uint32 App that consumes the files
cache_max_age_seconds uint32 Allow stale data to be returned for the specified number of seconds.
child_publishedfileid uint64 Find all items that reference the given item.
creator_appid uint32 App that created the files
cursor string Cursor to paginate through the results (set to '*' for the first request). Prefer this over using the page parameter, as it will allow you to do deep pagination. When used, the page parameter will be ignored.
days uint32 If query_type is k_PublishedFileQueryType_RankedByTrend, then this is the number of days to get votes for [1,7].
desired_revision {enum} Return the data for the specified revision.
excludedtags string (Optional) Tags that must NOT be present on a published file to satisfy the query.
filetype uint32 EPublishedFileInfoMatchingFileType
ids_only bool (Optional) If true, only return the published file ids of files that satisfy this query.
include_recent_votes_only bool If query_type is k_PublishedFileQueryType_RankedByTrend, then limit result set just to items that have votes within the day range given
language int32 Language to search in and also what gets returned. Defaults to English.
match_all_tags bool If true, then items must have all the tags specified, otherwise they must have at least one of the tags.
numperpage uint32 (Optional) The number of results, per page to return.
omitted_flags string Flags that must not be set on any returned items
page uint32 Current page
query_type uint32 enumeration EPublishedFileQueryType in clientenums.h
required_flags string Required flags that must be set on any returned items
required_kv_tags {message} Required key-value tags to match on.
requiredtags string Tags to match on. See match_all_tags parameter below
return_children bool Return child item ids in the file details
return_details bool By default, if none of the other 'return_*' fields are set, only some voting details are returned. Set this to true to return the default set of details.
return_for_sale_data bool Return pricing information, if applicable
return_kv_tags bool Return key-value tags in the file details
return_metadata bool Populate the metadata
return_playtime_stats uint32 Return playtime stats for the specified number of days before today.
return_previews bool Return preview image and video details in the file details
return_short_description bool Populate the short_description field instead of file_description
return_tags bool Return tags in the file details
return_vote_data bool Return vote data
search_text string Text to match in the item's title or description
strip_description_bbcode bool Strips BBCode from descriptions.
taggroups {message} (Optional) At least one of the tags must be present on a published file to satisfy the query.
totalonly bool (Optional) If true, only return the total number of files that satisfy this query.
RefreshVotingQueue V1 Undocumented
POST
Value Name Type Required Description
appid uint32
desired_queue_size uint32 Desired number of items in the voting queue. May be clamped by the server
desired_revision {enum} Filter to items that have data for the specified revision.
excluded_tags string Exclude any files that have any of these tags.
match_all_tags bool If true, then files must have all the tags specified. If false, then must have at least one of the tags specified.
matching_file_type uint32 EPublishedFileInfoMatchingFileType
tags string Include files that have all the tags or any of the tags if match_all_tags is set to false.
SetDeveloperMetadata V1 Undocumented
POST
Value Name Type Required Description
appid uint32
metadata string
publishedfileid uint64
UpdateBanStatus V1 Undocumented
POST
Value Name Type Required Description
appid uint32
banned bool
publishedfileid uint64
reason string
UpdateIncompatibleStatus V1 Undocumented
POST
Value Name Type Required Description
appid uint32
incompatible bool
publishedfileid uint64
UpdateKeyValueTags V1 Undocumented
POST
Value Name Type Required Description
appid uint32
int_tags_to_remove_by_key string
publishedfileid uint64
string_tags_to_remove_by_key string
tags_to_add {message}
tags_to_remove {message}
UpdateTags V1 Undocumented
POST
Value Name Type Required Description
add_tags string
appid uint32
publishedfileid uint64
remove_tags string

IQuestService

POST
Value Name Type Required Description
appid uint32
attributes {message}
broadcast_channel_id uint64
match_item_class uint32
match_item_type uint32
note string
prefix_item_name string
steamid uint64

ISteamApps

GetAppBetas V1 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of game
GetAppBuilds V1 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of game
count uint32 # of builds to retrieve (default 10)
depot_details bool True if we want the info on the depots in each build. False if we don't need that info. Defaults to true.
GetAppDepotVersions V1 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of depot
GetCheatingReports V1 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of game
includebans bool include reports that were bans
includereports bool include reports that were not bans
reportidmin uint64 minimum report id
timebegin uint32 Time range begin
timeend uint32 Time range end
GetPlayersBanned V1 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of game
GET
Value Name Type Required Description
appid uint32 AppID of game
partner string Partner type
GetServerList V1 Undocumented
GET
Value Name Type Required Description
filter string Query filter string
limit uint32 Limit number of servers in the response
GET
Value Name Type Required Description
addr string IP or IP:queryport to list
SetAppBuildLive V1 Undocumented
POST
Value Name Type Required Description
appid uint32 AppID of game
betakey string beta key, required. Use public for default branch
buildid uint32 BuildID
description string optional description for this build
GET
Value Name Type Required Description
appid uint32 AppID of game
version uint32 The installed version of the game

ISteamBroadcast

GET
Value Name Type Required Description
sessionid uint64 Broadcast Session ID
steamid uint64 Steam ID of the broadcaster
stream int32 video stream representation watching
token uint64 Viewer token

ISteamCDN

POST
Value Name Type Required Description
allowedasns string comma-separated list of allowed client network AS numbers - blank for not used
allowedipblocks string comma-separated list of allowed IP address blocks in CIDR format - blank for not used
allowedipcountries string comma-separated list of allowed client IP country codes in ISO 3166-1 format - blank for not used
cdnname string Steam name of CDN property
POST
Value Name Type Required Description
cache_hit_percent uint32 Percent cache hits
cdnname string Steam name of CDN property
cpu_percent uint32 Percent CPU load
mbps_recv uint32 Incoming network traffic in Mbps
mbps_sent uint32 Outgoing network traffic in Mbps

ISteamCloudGaming

GetSupportedApps V1 Undocumented
GET
Value Name Type Required Description
detailed bool Request extra details if supported
platform string Cloud gaming platform name

ISteamCommunity

ReportAbuse V1 Undocumented
POST
Value Name Type Required Description
abuseType uint32 Abuse type code (see EAbuseReportType enum)
appid uint32 AppID to check for ownership
contentType uint32 Content type code (see ECommunityContentType enum)
description string Narrative from user
gid uint64 GID of related record (depends on content type)
steamidActor uint64 SteamID of user doing the reporting
steamidTarget uint64 SteamID of the entity being accused of abuse

ISteamDirectory

GET
Value Name Type Required Description
cellid uint32 Client's Steam cell ID
maxcount uint32 Max number of servers to return
GET
Value Name Type Required Description
cellid uint32 Client's Steam cell ID
maxcount uint32 Max number of servers to return

ISteamEconomy

CanTrade V1 Undocumented
GET
Value Name Type Required Description
appid uint32 That the key is associated with. Must be a steam economy app.
steamid uint64 SteamID of user attempting to initiate a trade
targetid uint64 SteamID of user that is the target of the trade invitation
FinalizeAssetTransaction V1 Undocumented
POST
Value Name Type Required Description
appid uint32 The app ID the user is buying assets for
language string The local language for the user
steamid uint64 SteamID of the user making a purchase
txnid string The transaction ID
GET
Value Name Type Required Description
appid uint32 Must be a steam economy app.
class_count uint32 Number of classes requested. Must be at least one.
classid0 uint64 Class ID of the nth class.
instanceid0 uint64 Instance ID of the nth class.
language string The user's local language
GET
Value Name Type Required Description
appid uint32 Must be a steam economy app.
currency string The currency to filter for
language string The user's local language
GetExportedAssetsForUser V1 Undocumented
GET
Value Name Type Required Description
appid uint32 The app to get exported items from.
contextid uint64 The context in the app to get exported items from.
steamid uint64 SteamID of user
GetMarketPrices V1 Undocumented
GET
Value Name Type Required Description
appid uint32 Must be a steam economy app.
StartAssetTransaction V1 Undocumented
POST
Value Name Type Required Description
appid uint32 The app ID the user is buying assets for
assetid0 string The ID of the first asset the user is buying - there must be at least one
assetquantity0 uint32 The quantity of assetid0's the the user is buying
clientauth bool If true (default is false), the authorization will appear in the user's steam client overlay, rather than as a web page - useful for stores that are embedded in products.
currency string The local currency for the user
ipaddress string The user's IP address
language string The local language for the user
referrer string The referring URL
steamid uint64 SteamID of user making a purchase
StartTrade V1 Undocumented
GET
Value Name Type Required Description
appid uint32 That the key is associated with. Must be a steam economy app.
partya uint64 SteamID of first user in the trade
partyb uint64 SteamID of second user in the trade

ISteamGameServerStats

GET
Value Name Type Required Description
appid uint32 appID of the game
gameid uint64 game id to get stats for, if not a mod, it's safe to use appid here
maxresults uint32 Max number of results to return (up to 1000)
rangeend string range end date/time (Format: YYYY-MM-DD HH:MM:SS, seattle local time
rangestart string range start date/time (Format: YYYY-MM-DD HH:MM:SS, seattle local time

ISteamLeaderboards

DeleteLeaderboard V1 Undocumented
POST
Value Name Type Required Description
appid uint32 appid of game
name string name of the leaderboard to delete
FindOrCreateLeaderboard V1 Undocumented
POST
Value Name Type Required Description
appid uint32 appid of game
createifnotfound bool if this is true the leaderboard will be created if it doesn't exist. Defaults to true.
displaytype string display type for this leaderboard (defaults to Numeric)
name string name of the leaderboard to create
onlyfriendsreads bool if this is true the leaderboard scores can only be read for friends by clients, scores can always be read by publisher. Defaults to false.
onlytrustedwrites bool if this is true the leaderboard scores cannot be set by clients, and can only be set by publisher via SetLeaderboardScore WebAPI. Defaults to false.
sortmethod string sort method to use for this leaderboard (defaults to Ascending)
FindOrCreateLeaderboard V2 Undocumented
POST
Value Name Type Required Description
appid uint32 appid of game
createifnotfound bool if this is true the leaderboard will be created if it doesn't exist. Defaults to true.
displaytype string display type for this leaderboard (defaults to Numeric)
name string name of the leaderboard to create
onlyfriendsreads bool if this is true the leaderboard scores can only be read for friends by clients, scores can always be read by publisher. Defaults to false.
onlytrustedwrites bool if this is true the leaderboard scores cannot be set by clients, and can only be set by publisher via SetLeaderboardScore WebAPI. Defaults to false.
sortmethod string sort method to use for this leaderboard (defaults to Ascending)
GetLeaderboardEntries V1 Undocumented
GET
Value Name Type Required Description
appid uint32 appid of game
datarequest uint32 type of request: RequestGlobal, RequestAroundUser, RequestFriends
leaderboardid int32 ID of the leaderboard to view
rangeend int32 range end or max LB entries
rangestart int32 range start or 0
steamid uint64 SteamID used for friend & around user requests
GetLeaderboardsForGame V1 Undocumented
GET
Value Name Type Required Description
appid uint32 appid of game
GetLeaderboardsForGame V2 Undocumented
GET
Value Name Type Required Description
appid uint32 appid of game
ResetLeaderboard V1 Undocumented
POST
Value Name Type Required Description
appid uint32 appid of game
leaderboardid uint32 numeric ID of the target leaderboard. Can be retrieved from GetLeaderboardsForGame
SetLeaderboardScore V1 Undocumented
POST
Value Name Type Required Description
appid uint32 appid of game
details rawbinary game-specific details for how the score was earned. Up to 256 bytes.
leaderboardid uint32 numeric ID of the target leaderboard. Can be retrieved from GetLeaderboardsForGame
score int32 the score to set for this user
scoremethod string update method to use. Can be "KeepBest" or "ForceUpdate"
steamid uint64 steamID to set the score for

ISteamMicroTxn

AdjustAgreement V1 Undocumented
POST
Value Name Type Required Description
agreementid uint64 ID of agreement
appid uint32 AppID of game
nextprocessdate string Date for next process
steamid uint64 SteamID of user with the agreement
CancelAgreement V1 Undocumented
POST
Value Name Type Required Description
agreementid uint64 ID of agreement
appid uint32 AppID of game
steamid uint64 SteamID of user with the agreement
FinalizeTxn V1 Undocumented
POST
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
orderid uint64 3rd party ID for transaction
FinalizeTxn V2 Undocumented
POST
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
orderid uint64 3rd party ID for transaction
GetReport V1 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
maxresults uint32 Max number of results to return (up to 1000)
time string Beginning time to start report from (RFC 3339 UTC format)
type string Report type (GAMESALES, STEAMSTORE, SETTLEMENT)
GetReport V2 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
maxresults uint32 Max number of results to return (up to 1000)
time string Beginning time to start report from (RFC 3339 UTC format)
type string Report type (GAMESALES, STEAMSTORE, SETTLEMENT)
GetReport V3 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
maxresults uint32 Max number of results to return (up to 1000)
time string Beginning time to start report from (RFC 3339 UTC format)
type string Report type (GAMESALES, STEAMSTORE, SETTLEMENT)
GetReport V4 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
maxresults uint32 Max number of results to return (up to 1000)
time string Beginning time to start report from (RFC 3339 UTC format)
type string Report type (GAMESALES, STEAMSTORE, SETTLEMENT)
GetUserAgreementInfo V1 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of game
steamid uint64 SteamID of user making purchase
GetUserInfo V1 Undocumented
GET
Value Name Type Required Description
ipaddress string ip address of user in string format (xxx.xxx.xxx.xxx). Only required if usersession=web
steamid uint64 SteamID of user making purchase
GetUserInfo V2 Undocumented
GET
Value Name Type Required Description
ipaddress string ip address of user in string format (xxx.xxx.xxx.xxx). Only required if usersession=web
steamid uint64 SteamID of user making purchase
InitTxn V1 Undocumented
POST
Value Name Type Required Description
amount[0] int32 Total cost (in cents) of item(s)
appid uint32 AppID of game this transaction is for
associated_bundle[0] uint32 Optional bundleid of associated bundle
billingtype[0] string Optional recurring billing type
bundle_category[0] string Optional category grouping for bundle
bundle_desc[0] string Description of bundle
bundle_qty[0] uint32 Quantity of this bundle
bundlecount uint32 Number of bundles in cart
bundleid[0] uint32 3rd party ID of the bundle. This shares the same ID space as 3rd party items.
category[0] string Optional category grouping for item
currency string ISO 4217 currency code
description[0] string Description of item
enddate[0] string Optional end date for recurring billing
frequency[0] uint32 Optional frequency for recurring billing
ipaddress string ip address of user in string format (xxx.xxx.xxx.xxx). Only required if usersession=web
itemcount uint32 Number of items in cart
itemid[0] uint32 3rd party ID for item
language string ISO 639-1 language code of description
orderid uint64 3rd party ID for transaction
period[0] string Optional period for recurring billing
qty[0] uint32 Quantity of this item
recurringamt[0] string Optional recurring billing amount
startdate[0] string Optional start date for recurring billing
steamid uint64 SteamID of user making purchase
usersession string session where user will authorize the transaction. client or web (defaults to client)
InitTxn V2 Undocumented
POST
Value Name Type Required Description
amount[0] int32 Total cost (in cents) of item(s)
appid uint32 AppID of game this transaction is for
associated_bundle[0] uint32 Optional bundleid of associated bundle
billingtype[0] string Optional recurring billing type
bundle_category[0] string Optional category grouping for bundle
bundle_desc[0] string Description of bundle
bundle_qty[0] uint32 Quantity of this bundle
bundlecount uint32 Number of bundles in cart
bundleid[0] uint32 3rd party ID of the bundle. This shares the same ID space as 3rd party items.
category[0] string Optional category grouping for item
currency string ISO 4217 currency code
description[0] string Description of item
enddate[0] string Optional end date for recurring billing
frequency[0] uint32 Optional frequency for recurring billing
ipaddress string ip address of user in string format (xxx.xxx.xxx.xxx). Only required if usersession=web
itemcount uint32 Number of items in cart
itemid[0] uint32 3rd party ID for item
language string ISO 639-1 language code of description
orderid uint64 3rd party ID for transaction
period[0] string Optional period for recurring billing
qty[0] uint32 Quantity of this item
recurringamt[0] string Optional recurring billing amount
startdate[0] string Optional start date for recurring billing
steamid uint64 SteamID of user making purchase
usersession string session where user will authorize the transaction. client or web (defaults to client)
InitTxn V3 Undocumented
POST
Value Name Type Required Description
amount[0] int32 Total cost (in cents) of item(s)
appid uint32 AppID of game this transaction is for
associated_bundle[0] uint32 Optional bundleid of associated bundle
billingtype[0] string Optional recurring billing type
bundle_category[0] string Optional category grouping for bundle
bundle_desc[0] string Description of bundle
bundle_qty[0] uint32 Quantity of this bundle
bundlecount uint32 Number of bundles in cart
bundleid[0] uint32 3rd party ID of the bundle. This shares the same ID space as 3rd party items.
category[0] string Optional category grouping for item
currency string ISO 4217 currency code
description[0] string Description of item
enddate[0] string Optional end date for recurring billing
frequency[0] uint32 Optional frequency for recurring billing
ipaddress string ip address of user in string format (xxx.xxx.xxx.xxx). Only required if usersession=web
itemcount uint32 Number of items in cart
itemid[0] uint32 3rd party ID for item
language string ISO 639-1 language code of description
orderid uint64 3rd party ID for transaction
period[0] string Optional period for recurring billing
qty[0] uint32 Quantity of this item
recurringamt[0] string Optional recurring billing amount
startdate[0] string Optional start date for recurring billing
steamid uint64 SteamID of user making purchase
usersession string session where user will authorize the transaction. client or web (defaults to client)
ProcessAgreement V1 Undocumented
POST
Value Name Type Required Description
agreementid uint64 ID of agreement
amount int32 Total cost (in cents) to charge
appid uint32 AppID of game
currency string ISO 4217 currency code
orderid uint64 3rd party ID for transaction
steamid uint64 SteamID of user with the agreement
QueryTxn V1 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
orderid uint64 3rd party ID for transaction
transid uint64 Steam transaction ID
QueryTxn V2 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
orderid uint64 3rd party ID for transaction
transid uint64 Steam transaction ID
RefundTxn V1 Undocumented
POST
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
orderid uint64 3rd party ID for transaction
RefundTxn V2 Undocumented
POST
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
orderid uint64 3rd party ID for transaction

ISteamMicroTxnSandbox

AdjustAgreement V1 Undocumented
POST
Value Name Type Required Description
agreementid uint64 ID of agreement
appid uint32 AppID of game
nextprocessdate string Date for next process
steamid uint64 SteamID of user with the agreement
CancelAgreement V1 Undocumented
POST
Value Name Type Required Description
agreementid uint64 ID of agreement
appid uint32 AppID of game
steamid uint64 SteamID of user with the agreement
FinalizeTxn V1 Undocumented
POST
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
orderid uint64 3rd party ID for transaction
FinalizeTxn V2 Undocumented
POST
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
orderid uint64 3rd party ID for transaction
GetReport V1 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
maxresults uint32 Max number of results to return (up to 1000)
time string Beginning time to start report from (RFC 3339 UTC format)
type string Report type (GAMESALES, STEAMSTORE, SETTLEMENT)
GetReport V2 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
maxresults uint32 Max number of results to return (up to 1000)
time string Beginning time to start report from (RFC 3339 UTC format)
type string Report type (GAMESALES, STEAMSTORE, SETTLEMENT)
GetReport V3 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
maxresults uint32 Max number of results to return (up to 1000)
time string Beginning time to start report from (RFC 3339 UTC format)
type string Report type (GAMESALES, STEAMSTORE, SETTLEMENT)
GetReport V4 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
maxresults uint32 Max number of results to return (up to 1000)
time string Beginning time to start report from (RFC 3339 UTC format)
type string Report type (GAMESALES, STEAMSTORE, SETTLEMENT)
GetUserAgreementInfo V1 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of game
steamid uint64 SteamID of user making purchase
GetUserInfo V1 Undocumented
GET
Value Name Type Required Description
ipaddress string ip address of user in string format (xxx.xxx.xxx.xxx). Only required if usersession=web
steamid uint64 SteamID of user making purchase
GetUserInfo V2 Undocumented
GET
Value Name Type Required Description
ipaddress string ip address of user in string format (xxx.xxx.xxx.xxx). Only required if usersession=web
steamid uint64 SteamID of user making purchase
InitTxn V1 Undocumented
POST
Value Name Type Required Description
amount[0] int32 Total cost (in cents) of item(s)
appid uint32 AppID of game this transaction is for
billingtype[0] string Optional recurring billing type
category[0] string Optional category grouping for item
currency string ISO 4217 currency code
description[0] string Description of item
enddate[0] string Optional start date for recurring billing
frequency[0] uint32 Optional frequency for recurring billing
itemcount uint32 Number of items in cart
itemid[0] uint32 3rd party ID for item
language string ISO 639-1 language code of description
orderid uint64 3rd party ID for transaction
period[0] string Optional period for recurring billing
qty[0] uint32 Quantity of this item
recurringamt[0] string Optional recurring billing amount
startdate[0] string Optional start date for recurring billing
steamid uint64 SteamID of user making purchase
InitTxn V2 Undocumented
POST
Value Name Type Required Description
amount[0] int32 Total cost (in cents) of item(s)
appid uint32 AppID of game this transaction is for
billingtype[0] string Optional recurring billing type
category[0] string Optional category grouping for item
currency string ISO 4217 currency code
description[0] string Description of item
enddate[0] string Optional end date for recurring billing
frequency[0] uint32 Optional frequency for recurring billing
itemcount uint32 Number of items in cart
itemid[0] uint32 3rd party ID for item
language string ISO 639-1 language code of description
orderid uint64 3rd party ID for transaction
period[0] string Optional period for recurring billing
qty[0] uint32 Quantity of this item
recurringamt[0] string Optional recurring billing amount
startdate[0] string Optional start date for recurring billing
steamid uint64 SteamID of user making purchase
InitTxn V3 Undocumented
POST
Value Name Type Required Description
amount[0] int32 Total cost (in cents) of item(s)
appid uint32 AppID of game this transaction is for
billingtype[0] string Optional recurring billing type
category[0] string Optional category grouping for item
currency string ISO 4217 currency code
description[0] string Description of item
enddate[0] string Optional end date for recurring billing
frequency[0] uint32 Optional frequency for recurring billing
itemcount uint32 Number of items in cart
itemid[0] uint32 3rd party ID for item
language string ISO 639-1 language code of description
orderid uint64 3rd party ID for transaction
period[0] string Optional period for recurring billing
qty[0] uint32 Quantity of this item
recurringamt[0] string Optional recurring billing amount
startdate[0] string Optional start date for recurring billing
steamid uint64 SteamID of user making purchase
ProcessAgreement V1 Undocumented
POST
Value Name Type Required Description
agreementid uint64 ID of agreement
amount int32 Total cost (in cents) to charge
appid uint32 AppID of game
currency string ISO 4217 currency code
steamid uint64 SteamID of user with the agreement
QueryTxn V1 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
orderid uint64 3rd party ID for transaction
transid uint64 Steam transaction ID
QueryTxn V2 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
orderid uint64 3rd party ID for transaction
transid uint64 Steam transaction ID
RefundTxn V1 Undocumented
POST
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
orderid uint64 3rd party ID for transaction
RefundTxn V2 Undocumented
POST
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
orderid uint64 3rd party ID for transaction

ISteamNews

GET
Value Name Type Required Description
appid uint32 AppID to retrieve news for
count uint32 # of posts to retrieve (default 20)
enddate uint32 Retrieve posts earlier than this date (unix epoch timestamp)
maxlength uint32 Maximum length for the content to return, if this is 0 the full content is returned, if it's less then a blurb is generated to fit.
tags string Comma-separated list of tags to filter by (e.g. 'patchnodes')
GET
Value Name Type Required Description
appid uint32 AppID to retrieve news for
count uint32 # of posts to retrieve (default 20)
enddate uint32 Retrieve posts earlier than this date (unix epoch timestamp)
feeds string Comma-separated list of feed names to return news for
maxlength uint32 Maximum length for the content to return, if this is 0 the full content is returned, if it's less then a blurb is generated to fit.
tags string Comma-separated list of tags to filter by (e.g. 'patchnodes')
GetNewsForAppAuthed V1 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID to retrieve news for
count uint32 # of posts to retrieve (default 20)
enddate uint32 Retrieve posts earlier than this date (unix epoch timestamp)
maxlength uint32 Maximum length for the content to return, if this is 0 the full content is returned, if it's less then a blurb is generated to fit.
tags string Comma-separated list of tags to filter by (e.g. 'patchnodes')
GetNewsForAppAuthed V2 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID to retrieve news for
count uint32 # of posts to retrieve (default 20)
enddate uint32 Retrieve posts earlier than this date (unix epoch timestamp)
feeds string Comma-seperated list of feed names to return news for
maxlength uint32 Maximum length for the content to return, if this is 0 the full content is returned, if it's less then a blurb is generated to fit.
tags string Comma-separated list of tags to filter by (e.g. 'patchnodes')

ISteamPublishedItemSearch

RankedByPublicationOrder V1 Undocumented
POST
Value Name Type Required Description
appid uint32 appID of product
count uint32 Number Requested
fileType uint32 EPublishedFileInfoMatchingFileType, defaults to k_PFI_MatchingFileType_Items
hasappadminaccess bool Whether the user making the request is an admin for the app and can see private files
startidx uint32 Starting index in the result set (0 based)
steamid uint64 SteamID of user
tag[0] string Tag to filter result set
tagcount uint32 Number of Tags Specified
usertag[0] string A user specific tag
usertagcount uint32 Number of User specific tags requested
RankedByTrend V1 Undocumented
POST
Value Name Type Required Description
appid uint32 appID of product
count uint32 Number Requested
days uint32 [1,7] number of days for the trend period, including today
fileType uint32 EPublishedFileInfoMatchingFileType, defaults to k_PFI_MatchingFileType_Items
hasappadminaccess bool Whether the user making the request is an admin for the app and can see private files
startidx uint32 Starting index in the result set (0 based)
steamid uint64 SteamID of user
tag[0] string Tag to filter result set
tagcount uint32 Number of Tags Specified
usertag[0] string A user specific tag
usertagcount uint32 Number of User specific tags requested
RankedByVote V1 Undocumented
POST
Value Name Type Required Description
appid uint32 appID of product
count uint32 Number Requested
fileType uint32 EPublishedFileInfoMatchingFileType, defaults to k_PFI_MatchingFileType_Items
hasappadminaccess bool Whether the user making the request is an admin for the app and can see private files
startidx uint32 Starting index in the result set (0 based)
steamid uint64 SteamID of user
tag[0] string Tag to filter result set
tagcount uint32 Number of Tags Specified
usertag[0] string A user specific tag
usertagcount uint32 Number of User specific tags requested
ResultSetSummary V1 Undocumented
POST
Value Name Type Required Description
appid uint64 appID relevant to all subsequent tags
fileType uint32 EPublishedFileInfoMatchingFileType, defaults to k_PFI_MatchingFileType_Items
hasappadminaccess bool Whether the user making the request is an admin for the app and can see private files
steamid uint64 SteamID of user
tag[0] string Tag to filter result set
tagcount uint32 Number of Tags Specified
usertag[0] string A user specific tag
usertagcount uint32 Number of User specific tags requested

ISteamPublishedItemVoting

ItemVoteSummary V1 Undocumented
POST
Value Name Type Required Description
appid uint32 appID of product
count uint32 Count of how many items we are querying
publishedfileid[0] uint64 The Published File ID who's vote details are required
steamid uint64 Steam ID of user
UserVoteSummary V1 Undocumented
POST
Value Name Type Required Description
count uint32 Count of how many items we are querying
publishedfileid[0] uint64 A Specific Published Item
steamid uint64 Steam ID of user

ISteamRemoteStorage

EnumerateUserPublishedFiles V1 Undocumented
POST
Value Name Type Required Description
appid uint32 appID of product
steamid uint64 SteamID of user
POST
Value Name Type Required Description
appid uint32 appID of product
listtype uint32 EUCMListType
steamid uint64 SteamID of user
POST
Value Name Type Required Description
collectioncount uint32 Number of collections being requested
publishedfileids[0] uint64 collection ids to get the details for
POST
Value Name Type Required Description
itemcount uint32 Number of items being requested
publishedfileids[0] uint64 published file id to look up
GET
Value Name Type Required Description
appid uint32 appID of product
steamid uint64 If specified, only returns details if the file is owned by the SteamID specified
ugcid uint64 ID of UGC file to get info for
SetUGCUsedByGC V1 Undocumented
POST
Value Name Type Required Description
appid uint32 appID of product to change updating state for
steamid uint64 SteamID of user
ugcid uint64 ID of UGC file whose bits are being fiddled with
used bool New state of flag
SubscribePublishedFile V1 Undocumented
POST
Value Name Type Required Description
appid uint32 appID of product
publishedfileid uint64 published file id to subscribe to
steamid uint64 SteamID of user
UnsubscribePublishedFile V1 Undocumented
POST
Value Name Type Required Description
appid uint32 appID of product
publishedfileid uint64 published file id to unsubscribe from
steamid uint64 SteamID of user

ISteamSpecialSurvey

CheckUserStatus V1 Undocumented
GET
Value Name Type Required Description
appid uint32 appid of game
steamid uint64 SteamID of the user taking the survey
surveyid uint32 ID of the survey being taken
token string Survey identity verification token for the user
SetUserFinished V1 Undocumented
POST
Value Name Type Required Description
appid uint32 appid of game
steamid uint64 SteamID of the user taking the survey
surveyid uint32 ID of the survey being taken
token string Survey identity verification token for the user

ISteamUser

CheckAppOwnership V1 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID to check for ownership
steamid uint64 SteamID of user
CheckAppOwnership V2 Undocumented
GET
Value Name Type Required Description
appid uint32 AppID to check for ownership
steamid uint64 SteamID of user
GetAppPriceInfo V1 Undocumented
GET
Value Name Type Required Description
appids string Comma-delimited list of appids (max: 100)
steamid uint64 SteamID of user
GET
Value Name Type Required Description
relationship string relationship type (ex: friend)
steamid uint64 SteamID of user
GET
Value Name Type Required Description
steamids string Comma-delimited list of SteamIDs
GET
Value Name Type Required Description
steamids string Comma-delimited list of SteamIDs
GET
Value Name Type Required Description
steamids string Comma-delimited list of SteamIDs (max: 100)
GetPublisherAppOwnership V1 Undocumented
GET
Value Name Type Required Description
steamid uint64 SteamID of user
GetPublisherAppOwnership V2 Undocumented
GET
Value Name Type Required Description
steamid uint64 SteamID of user
GetPublisherAppOwnership V3 Undocumented
GET
Value Name Type Required Description
steamid uint64 SteamID of user
GET
Value Name Type Required Description
cdkeyrowversion string The unsigned 64-bit row version to read CD Key changes from. The row version of data read up to will be returned for use in future calls.
packagerowversion string The unsigned 64-bit row version to read package changes from. The row version of data read up to will be returned for use in future calls.
GET
Value Name Type Required Description
steamid uint64 SteamID of user
GrantPackage V1 Undocumented
POST
Value Name Type Required Description
ipaddress string ip address of user in string format (xxx.xxx.xxx.xxx).
packageid uint32 PackageID to grant
steamid uint64 SteamID of user
thirdpartyappid uint32 Has to be set if 'thirdpartykey' is set. The appid associated with the 'thirdpartykey'.
thirdpartykey string Optionally associate third party key during grant. 'thirdpartyappid' will have to be set.
GET
Value Name Type Required Description
url_type int32 The type of vanity URL. 1 (default): Individual profile, 2: Group, 3: Official game group
vanityurl string The vanity URL to get a SteamID for

ISteamUserAuth

POST
Value Name Type Required Description
encrypted_loginkey rawbinary Should be the users hashed loginkey, AES encrypted with the sessionkey.
sessionkey rawbinary Should be a 32 byte random blob of data, which is then encrypted with RSA using the Steam system's public key. Randomness is important here for security.
steamid uint64 Should be the users steamid, unencrypted.
GET
Value Name Type Required Description
appid uint32 appid of game
ticket string Ticket from GetAuthSessionTicket.

ISteamUserOAuth

GET
Value Name Type Required Description
access_token string OAuth2 token for which to return details

ISteamUserStats

GET
Value Name Type Required Description
gameid uint64 GameID to retrieve the achievement percentages for
GET
Value Name Type Required Description
gameid uint64 GameID to retrieve the achievement percentages for
GET
Value Name Type Required Description
appid uint32 AppID that we're getting global stats for
count uint32 Number of stats get data for
enddate uint32 End date for daily totals (unix epoch timestamp)
name[0] string Names of stat to get data for
startdate uint32 Start date for daily totals (unix epoch timestamp)
GET
Value Name Type Required Description
appid uint32 AppID that we're getting user count for
GET
Value Name Type Required Description
appid uint32 AppID to get achievements for
l string Language to return strings for
steamid uint64 SteamID of user
GET
Value Name Type Required Description
appid uint32 appid of game
l string localized langauge to return (english, french, etc.)
GET
Value Name Type Required Description
appid uint32 appid of game
l string localized language to return (english, french, etc.)
GET
Value Name Type Required Description
appid uint32 appid of game
steamid uint64 SteamID of user
GET
Value Name Type Required Description
appid uint32 appid of game
steamid uint64 SteamID of user
SetUserStatsForGame V1 Undocumented
POST
Value Name Type Required Description
appid uint32 appid of game
count uint32 Number of stats and achievements to set a value for (name/value param pairs)
name[0] string Name of stat or achievement to set
steamid uint64 SteamID of user
value[0] uint32 Value to set

ISteamVideo

AddVideo V1 Undocumented
POST
Value Name Type Required Description
accountname string Account name of the video's owner on the provider's site
appid uint32 appID of the video
steamid uint64 SteamID of user
videoid string ID of the video on the provider's site

ISteamWebAPIUtil

GET
Value Name Type Required Description

ISteamWebUserPresenceOAuth

POST
Value Name Type Required Description
message uint32 Message that was last known to the user
pollid uint32 Caller-specific poll id
secidletime uint32 How many seconds is client considering itself idle, e.g. screen is off
sectimeout uint32 Long-poll timeout in seconds
steamid string Steam ID of the user
umqid uint64 UMQ Session ID
use_accountids uint32 Boolean, 0 (default): return steamid_from in output, 1: return accountid_from

ISteamWorkshop

AssociateWorkshopItems V1 Undocumented
POST
Value Name Type Required Description
appid uint32 AppID of game this transaction is for
gameitemdescription[0] string Game's description of the game item
gameitemid[0] uint32 3rd party ID for item
itemcount uint32 Number of items to associate
publishedfileid[0] uint64 the workshop published file id
revenuepercentage[0] float Percentage of revenue the owners of the workshop item will get from the sale of the item [0.0, 100.0]. For bundle-like items, send over an entry for each item in the bundle (gameitemid = bundle id) with different publishedfileids and with the revenue percentage pre-split amongst the items in the bundle (i.e. 30% / 10 items in the bundle)
GetContributors V1 Undocumented
POST
Value Name Type Required Description
appid uint32 AppID of game this transaction is for

IStoreService

GET
Value Name Type Required Description
have_description_language string Return only items that have a description in this language.
if_modified_since uint32 Return only items that have been modified since this date.
include_dlc bool Include DLC
include_games bool Include games (defaults to enabled)
include_hardware bool Include hardware
include_software bool Include software items
include_videos bool Include videos and series
last_appid uint32 For continuations, this is the last appid returned from the previous call.
max_results uint32 Number of results to return at a time. Default 10k, max 50k.

ITFPromos_205790

GET
Value Name Type Required Description
promoid uint32 The promo ID to grant an item for
steamid uint64 The Steam ID to fetch items for
POST
Value Name Type Required Description
promoid uint32 The promo ID to grant an item for
steamid uint64 The Steam ID to fetch items for

ITFPromos_440

GET
Value Name Type Required Description
promoid uint32 The promo ID to grant an item for
steamid uint64 The Steam ID to fetch items for
POST
Value Name Type Required Description
promoid uint32 The promo ID to grant an item for
steamid uint64 The Steam ID to fetch items for

ITFPromos_570

GET
Value Name Type Required Description
promoid uint32 The promo ID to grant an item for
steamid uint64 The Steam ID to fetch items for
POST
Value Name Type Required Description
promoid uint32 The promo ID to grant an item for
steamid uint64 The Steam ID to fetch items for

ITFPromos_620

GET
Value Name Type Required Description
PromoID uint32 The promo ID to grant an item for
steamid uint64 The Steam ID to fetch items for
POST
Value Name Type Required Description
PromoID uint32 The promo ID to grant an item for
steamid uint64 The Steam ID to fetch items for

ITFPromos_730

GetItemID V1 Undocumented
GET
Value Name Type Required Description
PromoID uint32 The promo ID to grant an item for
steamid uint64 The Steam ID to fetch items for
GrantItem V1 Undocumented
POST
Value Name Type Required Description
PromoID uint32 The promo ID to grant an item for
steamid uint64 The Steam ID to fetch items for

ITFPromos_841

GetItemID V1 Undocumented
GET
Value Name Type Required Description
PromoID uint32 The promo ID to grant an item for
steamid uint64 The Steam ID to fetch items for
GrantItem V1 Undocumented
POST
Value Name Type Required Description
PromoID uint32 The promo ID to grant an item for
steamid uint64 The Steam ID to fetch items for

ITestExternalPrivilegeService

CallPublisherKey V1 Undocumented
POST
Value Name Type Required Description
CallPublisherKeyOwnsApp V1 Undocumented
POST
Value Name Type Required Description
appid uint32

IWorkshopService

AddSpecialPayment V1 Undocumented
POST
Value Name Type Required Description
appid uint32 AppID
date string YYY-MM-DD formatted string
gameitemid uint32 Game Item ID
payment_row_usd uint64 ROW Payment portion in USD Cents
payment_us_usd uint64 US Payment portion in USD Cents
GetFinalizedContributors V1 Undocumented
GET
Value Name Type Required Description
appid uint32
gameitemid uint32
GetItemDailyRevenue V1 Undocumented
GET
Value Name Type Required Description
appid uint32
date_end uint32
date_start uint32
item_id uint32
PopulateItemDescriptions V1 Undocumented
POST
Value Name Type Required Description
appid uint32
languages {message}
SetItemPaymentRules V1 Undocumented
POST
Value Name Type Required Description
appid uint32
associated_workshop_files {message}
gameitemid uint32
make_workshop_files_subscribable bool
partner_accounts {message}
validate_only bool Only validates the rules and does not persist them.