Jump to code documentation

How to Get Started with Steam Web API
In order to use the Steam Web API, you have to request a key here: https://steamcommunity.com/dev/apikey. This key acts as your secret identifier when making requests to the API, so don't lose or share it.
How to Make a Steam Web API Request

Requests contain the following elements

Base URL
Usually https://api.steampowered.com but there's no guarantee that it won't change in the future.
Interface Name
Indicates which method group (interface) you want to use. Methods are usually grouped by similarities, but that doesn't seem to be a hard and fast rule.
Method Name
Indicates which method within the interface you want to use.
Method Version
Indicates which version of the method you want to use. Valve will occasionally (almost never) update the API and roll the version number on the method. This allows applications to continue working with older versions while new applications can take advantage of the new versions
Parameters
sometimes optional A one to many list of parameters to be passed to the selected method. Parameters are delimited by the & character.

Request URL format

https://{base_url}/{interface}/{method}/{version}?{parameters}

Sample request URL

http://api.steampowered.com/ISteamWebAPIUtil/GetSupportedAPIList/v1/

Sample request URL with parameters

http://api.steampowered.com/ISteamWebAPIUtil/GetSupportedAPIList/v1/?key=1234567890&steamid=000123000456
How to Use a Steam Web API Response

Response format

Responses to the requests can come in three different formats: json, vdf, xml. The default and preferred format is json.

Sample request/response

Request URL
https://api.steampowered.com/ISteamUser/GetPlayerSummaries/v2/?key={key}&steamids=76561197960361544
Response Format
json
Note that the {key} parameter is not filled in because it is a secret that you must provide.

{
	"response": {
		"players": [
			{
				"steamid": "76561197960361544",
				"communityvisibilitystate": 3,
				"profilestate": 1,
				"personaname": "aro",
				"lastlogoff": 1447902060,
				"commentpermission": 1,
				"profileurl": "http://steamcommunity.com/id/aro/",
				"avatar": "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/1c/1cc16a968510ac7a3cf79bdae96c2c494e3e5e03.jpg",
				"avatarmedium": "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/1c/1cc16a968510ac7a3cf79bdae96c2c494e3e5e03_medium.jpg",
				"avatarfull": "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/1c/1cc16a968510ac7a3cf79bdae96c2c494e3e5e03_full.jpg",
				"personastate": 1,
				"realname": "The Dude",
				"primaryclanid": "103582791435784710",
				"timecreated": 1063378043,
				"personastateflags": 0,
				"gameextrainfo": "Dota 2",
				"gameid": "570",
				"loccountrycode": "US",
				"locstatecode": "FL",
				"loccityid": 928
			}
		]
		
	}
}
                    

Interfaces and Methods


The contents of this section are updated automatically every 24 hours.
Only publicly available and listed interfaces are included in this documentation.

ICSGOServers_730

GetGameServersStatus Version: 1
GET https://api.steampowered.com/ICSGOServers_730/GetGameServersStatus/v1
This method has no listed parameters.

ICSGOTournaments_730

GetTournamentFantasyLineup Version: 1
GET https://api.steampowered.com/ICSGOTournaments_730/GetTournamentFantasyLineup/v1
Name Type Required? Description
event uint32 The event ID
steamid uint64 The SteamID of the user inventory
steamidkey string Authentication obtained from the SteamID
GetTournamentItems Version: 1
GET https://api.steampowered.com/ICSGOTournaments_730/GetTournamentItems/v1
Name Type Required? Description
event uint32 The event ID
steamid uint64 The SteamID of the user inventory
steamidkey string Authentication obtained from the SteamID
GetTournamentLayout Version: 1
GET https://api.steampowered.com/ICSGOTournaments_730/GetTournamentLayout/v1
Name Type Required? Description
event uint32 The event ID
GetTournamentPredictions Version: 1
GET https://api.steampowered.com/ICSGOTournaments_730/GetTournamentPredictions/v1
Name Type Required? Description
event uint32 The event ID
steamid uint64 The SteamID of the user inventory
steamidkey string Authentication obtained from the SteamID
UploadTournamentFantasyLineup Version: 1
POST https://api.steampowered.com/ICSGOTournaments_730/UploadTournamentFantasyLineup/v1
Name Type Required? Description
event uint32 The event ID
steamid uint64 The SteamID of the user inventory
steamidkey string Authentication obtained from the SteamID
sectionid uint32 Event section id
pickid0 uint32 PickID to select for the slot
itemid0 uint64 ItemID to lock in for the pick
pickid1 uint32 PickID to select for the slot
itemid1 uint64 ItemID to lock in for the pick
pickid2 uint32 PickID to select for the slot
itemid2 uint64 ItemID to lock in for the pick
pickid3 uint32 PickID to select for the slot
itemid3 uint64 ItemID to lock in for the pick
pickid4 uint32 PickID to select for the slot
itemid4 uint64 ItemID to lock in for the pick
UploadTournamentPredictions Version: 1
POST https://api.steampowered.com/ICSGOTournaments_730/UploadTournamentPredictions/v1
Name Type Required? Description
event uint32 The event ID
steamid uint64 The SteamID of the user inventory
steamidkey string Authentication obtained from the SteamID
sectionid uint32 Event section id
groupid uint32 Event group id
index uint32 Index in group
pickid uint32 Pick ID to select
itemid uint64 ItemID to lock in for the pick

IDOTA2Fantasy_205790

GetFantasyPlayerStats Version: 1
GET https://api.steampowered.com/IDOTA2Fantasy_205790/GetFantasyPlayerStats/v1
Name Type Required? Description
FantasyLeagueID uint32 The fantasy league ID
StartTime uint32 An optional filter for minimum timestamp
EndTime uint32 An optional filter for maximum timestamp
matchid uint64 An optional filter for a specific match
SeriesID uint32 An optional filter for a specific series
PlayerAccountID uint32 An optional filter for a specific player
GetPlayerOfficialInfo Version: 1
GET https://api.steampowered.com/IDOTA2Fantasy_205790/GetPlayerOfficialInfo/v1
Name Type Required? Description
accountid uint32 The account ID to look up
GetProPlayerList Version: 1
GET https://api.steampowered.com/IDOTA2Fantasy_205790/GetProPlayerList/v1
This method has no listed parameters.

IDOTA2Fantasy_570

GetFantasyPlayerStats Version: 1
GET https://api.steampowered.com/IDOTA2Fantasy_570/GetFantasyPlayerStats/v1
Name Type Required? Description
FantasyLeagueID uint32 The fantasy league ID
StartTime uint32 An optional filter for minimum timestamp
EndTime uint32 An optional filter for maximum timestamp
matchid uint64 An optional filter for a specific match
SeriesID uint32 An optional filter for a specific series
PlayerAccountID uint32 An optional filter for a specific player
GetPlayerOfficialInfo Version: 1
GET https://api.steampowered.com/IDOTA2Fantasy_570/GetPlayerOfficialInfo/v1
Name Type Required? Description
accountid uint32 The account ID to look up
GetProPlayerList Version: 1
GET https://api.steampowered.com/IDOTA2Fantasy_570/GetProPlayerList/v1
This method has no listed parameters.

IDOTA2MatchStats_205790

GetRealtimeStats Version: 1
GET https://api.steampowered.com/IDOTA2MatchStats_205790/GetRealtimeStats/v1
Name Type Required? Description
server_steam_id uint64 This parameter has no listed description.

IDOTA2MatchStats_570

GetRealtimeStats Version: 1
GET https://api.steampowered.com/IDOTA2MatchStats_570/GetRealtimeStats/v1
Name Type Required? Description
server_steam_id uint64 This parameter has no listed description.

IDOTA2Match_205790

GetLeagueListing Version: 1
GET https://api.steampowered.com/IDOTA2Match_205790/GetLeagueListing/v1
This method has no listed parameters.
GetLiveLeagueGames Version: 1
GET https://api.steampowered.com/IDOTA2Match_205790/GetLiveLeagueGames/v1
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
GetMatchDetails Version: 1
GET https://api.steampowered.com/IDOTA2Match_205790/GetMatchDetails/v1
Name Type Required? Description
match_id uint64 Match id
GetMatchHistory Version: 1
GET https://api.steampowered.com/IDOTA2Match_205790/GetMatchHistory/v1
Name Type Required? Description
hero_id uint32 The ID of the hero that must be in the matches being queried
game_mode uint32 Which game mode to return matches for
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
min_players string Minimum number of human players that must be in a match for it to be returned
account_id string An account ID to get matches from. This will fail if the user has their match history hidden
league_id string The league ID to return games from
start_at_match_id uint64 The minimum match ID to start from
matches_requested string The number of requested matches to return
tournament_games_only string Whether or not tournament games should only be returned
GetMatchHistoryBySequenceNum Version: 1
GET https://api.steampowered.com/IDOTA2Match_205790/GetMatchHistoryBySequenceNum/v1
Name Type Required? Description
start_at_match_seq_num uint64 This parameter has no listed description.
matches_requested uint32 This parameter has no listed description.
GetScheduledLeagueGames Version: 1
GET https://api.steampowered.com/IDOTA2Match_205790/GetScheduledLeagueGames/v1
Name Type Required? Description
date_min uint32 The starting time stamp to collect scheduled games from. If ignored, it will use the current time
date_max uint32 The ending time stamp. If this is more than 7 days past the starting time stamp, it will be clamped to 7 days.
GetTeamInfoByTeamID Version: 1
GET https://api.steampowered.com/IDOTA2Match_205790/GetTeamInfoByTeamID/v1
Name Type Required? Description
start_at_team_id uint64 This parameter has no listed description.
teams_requested uint32 This parameter has no listed description.
GetTopLiveGame Version: 1
GET https://api.steampowered.com/IDOTA2Match_205790/GetTopLiveGame/v1
Name Type Required? Description
partner int32 Which partner's games to use.
GetTournamentPlayerStats Version: 2
GET https://api.steampowered.com/IDOTA2Match_205790/GetTournamentPlayerStats/v2
Name Type Required? Description
account_id string This parameter has no listed description.
league_id string This parameter has no listed description.
hero_id string This parameter has no listed description.
time_frame string This parameter has no listed description.
match_id uint64 This parameter has no listed description.
phase_id uint32 This parameter has no listed description.

IDOTA2Match_570

GetLeagueListing Version: 1
GET https://api.steampowered.com/IDOTA2Match_570/GetLeagueListing/v1
This method has no listed parameters.
GetLiveLeagueGames Version: 1
GET https://api.steampowered.com/IDOTA2Match_570/GetLiveLeagueGames/v1
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
GetMatchDetails Version: 1
GET https://api.steampowered.com/IDOTA2Match_570/GetMatchDetails/v1
Name Type Required? Description
match_id uint64 Match id
GetMatchHistory Version: 1
GET https://api.steampowered.com/IDOTA2Match_570/GetMatchHistory/v1
Name Type Required? Description
hero_id uint32 The ID of the hero that must be in the matches being queried
game_mode uint32 Which game mode to return matches for
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
min_players string Minimum number of human players that must be in a match for it to be returned
account_id string An account ID to get matches from. This will fail if the user has their match history hidden
league_id string The league ID to return games from
start_at_match_id uint64 The minimum match ID to start from
matches_requested string The number of requested matches to return
tournament_games_only string Whether or not tournament games should only be returned
GetMatchHistoryBySequenceNum Version: 1
GET https://api.steampowered.com/IDOTA2Match_570/GetMatchHistoryBySequenceNum/v1
Name Type Required? Description
start_at_match_seq_num uint64 This parameter has no listed description.
matches_requested uint32 This parameter has no listed description.
GetScheduledLeagueGames Version: 1
GET https://api.steampowered.com/IDOTA2Match_570/GetScheduledLeagueGames/v1
Name Type Required? Description
date_min uint32 The starting time stamp to collect scheduled games from. If ignored, it will use the current time
date_max uint32 The ending time stamp. If this is more than 7 days past the starting time stamp, it will be clamped to 7 days.
GetTeamInfoByTeamID Version: 1
GET https://api.steampowered.com/IDOTA2Match_570/GetTeamInfoByTeamID/v1
Name Type Required? Description
start_at_team_id uint64 This parameter has no listed description.
teams_requested uint32 This parameter has no listed description.
GetTopLiveGame Version: 1
GET https://api.steampowered.com/IDOTA2Match_570/GetTopLiveGame/v1
Name Type Required? Description
partner int32 Which partner's games to use.
GetTournamentPlayerStats Version: 2
GET https://api.steampowered.com/IDOTA2Match_570/GetTournamentPlayerStats/v2
Name Type Required? Description
account_id string This parameter has no listed description.
league_id string This parameter has no listed description.
hero_id string This parameter has no listed description.
time_frame string This parameter has no listed description.
match_id uint64 This parameter has no listed description.
phase_id uint32 This parameter has no listed description.

IDOTA2StreamSystem_205790

GetBroadcasterInfo Version: 1
GET https://api.steampowered.com/IDOTA2StreamSystem_205790/GetBroadcasterInfo/v1
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

GetBroadcasterInfo Version: 1
GET https://api.steampowered.com/IDOTA2StreamSystem_570/GetBroadcasterInfo/v1
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

IDOTA2Teams_205790

GetTeamInfo Version: 1
GET https://api.steampowered.com/IDOTA2Teams_205790/GetTeamInfo/v1
Name Type Required? Description
team_id uint32 Team ID that you're requesting info about
league_id uint32 League ID for which you're requesting all regisered teams info

IDOTA2Teams_570

GetTeamInfo Version: 1
GET https://api.steampowered.com/IDOTA2Teams_570/GetTeamInfo/v1
Name Type Required? Description
team_id uint32 Team ID that you're requesting info about
league_id uint32 League ID for which you're requesting all regisered teams info

IDOTA2Ticket_205790

SetSteamAccountPurchased Version: 1
POST https://api.steampowered.com/IDOTA2Ticket_205790/SetSteamAccountPurchased/v1
Name Type Required? Description
eventid uint32 Event ID
steamid uint64 The 64-bit Steam ID
SteamAccountValidForEvent Version: 1
GET https://api.steampowered.com/IDOTA2Ticket_205790/SteamAccountValidForEvent/v1
Name Type Required? Description
eventid uint32 Event ID
steamid uint64 The 64-bit Steam ID

IDOTA2Ticket_570

ClaimBadgeReward Version: 1
GET https://api.steampowered.com/IDOTA2Ticket_570/ClaimBadgeReward/v1
Name Type Required? Description
eventid uint32 Event ID
BadgeID string The badge ID
GetSteamIDForBadgeID Version: 1
GET https://api.steampowered.com/IDOTA2Ticket_570/GetSteamIDForBadgeID/v1
Name Type Required? Description
BadgeID string The badge ID
SetSteamAccountPurchased Version: 1
POST https://api.steampowered.com/IDOTA2Ticket_570/SetSteamAccountPurchased/v1
Name Type Required? Description
eventid uint32 Event ID
steamid uint64 The 64-bit Steam ID
SteamAccountValidForEvent Version: 1
GET https://api.steampowered.com/IDOTA2Ticket_570/SteamAccountValidForEvent/v1
Name Type Required? Description
eventid uint32 Event ID
steamid uint64 The 64-bit Steam ID

IEconDOTA2_205790

GetEventStatsForAccount Version: 1
GET https://api.steampowered.com/IEconDOTA2_205790/GetEventStatsForAccount/v1
Name Type Required? Description
eventid uint32 The League ID of the compendium you're looking for.
accountid uint32 The account ID to look up.
language string The language to provide hero names in.
GetGameItems Version: 1
GET https://api.steampowered.com/IEconDOTA2_205790/GetGameItems/v1
Name Type Required? Description
language string The language to provide item names in.
GetHeroes Version: 1
GET https://api.steampowered.com/IEconDOTA2_205790/GetHeroes/v1
Name Type Required? Description
language string The language to provide hero names in.
itemizedonly bool Return a list of itemized heroes only.
GetItemIconPath Version: 1
GET https://api.steampowered.com/IEconDOTA2_205790/GetItemIconPath/v1
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
GetRarities Version: 1
GET https://api.steampowered.com/IEconDOTA2_205790/GetRarities/v1
Name Type Required? Description
language string The language to provide rarity names in.
GetTournamentPrizePool Version: 1
GET https://api.steampowered.com/IEconDOTA2_205790/GetTournamentPrizePool/v1
Name Type Required? Description
leagueid uint32 The ID of the league to get the prize pool of

IEconDOTA2_570

GetEventStatsForAccount Version: 1
GET https://api.steampowered.com/IEconDOTA2_570/GetEventStatsForAccount/v1
Name Type Required? Description
eventid uint32 The League ID of the compendium you're looking for.
accountid uint32 The account ID to look up.
language string The language to provide hero names in.
GetGameItems Version: 1
GET https://api.steampowered.com/IEconDOTA2_570/GetGameItems/v1
Name Type Required? Description
language string The language to provide item names in.
GetHeroes Version: 1
GET https://api.steampowered.com/IEconDOTA2_570/GetHeroes/v1
Name Type Required? Description
language string The language to provide hero names in.
itemizedonly bool Return a list of itemized heroes only.
GetItemIconPath Version: 1
GET https://api.steampowered.com/IEconDOTA2_570/GetItemIconPath/v1
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
GetRarities Version: 1
GET https://api.steampowered.com/IEconDOTA2_570/GetRarities/v1
Name Type Required? Description
language string The language to provide rarity names in.
GetTournamentPrizePool Version: 1
GET https://api.steampowered.com/IEconDOTA2_570/GetTournamentPrizePool/v1
Name Type Required? Description
leagueid uint32 The ID of the league to get the prize pool of

IEconItems_205790

GetPlayerItems Version: 1
GET https://api.steampowered.com/IEconItems_205790/GetPlayerItems/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for
GetSchema Version: 1
GET https://api.steampowered.com/IEconItems_205790/GetSchema/v1
Name Type Required? Description
language string The language to return the names in. Defaults to returning string keys.
GetSchemaURL Version: 1
GET https://api.steampowered.com/IEconItems_205790/GetSchemaURL/v1
This method has no listed parameters.
GetStoreMetaData Version: 1
GET https://api.steampowered.com/IEconItems_205790/GetStoreMetaData/v1
Name Type Required? Description
language string The language to results in.

IEconItems_218620

GetPlayerItems Version: 1
GET https://api.steampowered.com/IEconItems_218620/GetPlayerItems/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for

IEconItems_221540

GetPlayerItems Version: 1
GET https://api.steampowered.com/IEconItems_221540/GetPlayerItems/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for

IEconItems_238460

GetPlayerItems Version: 1
GET https://api.steampowered.com/IEconItems_238460/GetPlayerItems/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for

IEconItems_440

GetPlayerItems Version: 1
GET https://api.steampowered.com/IEconItems_440/GetPlayerItems/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for
GetSchema Version: 1
GET https://api.steampowered.com/IEconItems_440/GetSchema/v1
Name Type Required? Description
language string The language to return the names in. Defaults to returning string keys.
GetSchemaURL Version: 1
GET https://api.steampowered.com/IEconItems_440/GetSchemaURL/v1
This method has no listed parameters.
GetStoreMetaData Version: 1
GET https://api.steampowered.com/IEconItems_440/GetStoreMetaData/v1
Name Type Required? Description
language string The language to results in.
GetStoreStatus Version: 1
GET https://api.steampowered.com/IEconItems_440/GetStoreStatus/v1
This method has no listed parameters.

IEconItems_570

GetEquippedPlayerItems Version: 1
GET https://api.steampowered.com/IEconItems_570/GetEquippedPlayerItems/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for
class_id uint32 Return items equipped for this class id
GetPlayerItems Version: 1
GET https://api.steampowered.com/IEconItems_570/GetPlayerItems/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for
GetSchema Version: 1
GET https://api.steampowered.com/IEconItems_570/GetSchema/v1
Name Type Required? Description
language string The language to return the names in. Defaults to returning string keys.
GetSchemaURL Version: 1
GET https://api.steampowered.com/IEconItems_570/GetSchemaURL/v1
This method has no listed parameters.
GetStoreMetaData Version: 1
GET https://api.steampowered.com/IEconItems_570/GetStoreMetaData/v1
Name Type Required? Description
language string The language to results in.

IEconItems_620

GetPlayerItems Version: 1
GET https://api.steampowered.com/IEconItems_620/GetPlayerItems/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for
GetSchema Version: 1
GET https://api.steampowered.com/IEconItems_620/GetSchema/v1
Name Type Required? Description
language string The language to return the names in. Defaults to returning string keys.

IEconItems_730

GetPlayerItems Version: 1
GET https://api.steampowered.com/IEconItems_730/GetPlayerItems/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for
GetSchema Version: 2
GET https://api.steampowered.com/IEconItems_730/GetSchema/v2
Name Type Required? Description
language string The language to return the names in. Defaults to returning string keys.
GetSchemaURL Version: 2
GET https://api.steampowered.com/IEconItems_730/GetSchemaURL/v2
This method has no listed parameters.
GetStoreMetaData Version: 1
GET https://api.steampowered.com/IEconItems_730/GetStoreMetaData/v1
Name Type Required? Description
language string The language to results in.

IEconItems_841

GetPlayerItems Version: 1
GET https://api.steampowered.com/IEconItems_841/GetPlayerItems/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for
GetSchema Version: 1
GET https://api.steampowered.com/IEconItems_841/GetSchema/v1
Name Type Required? Description
language string The language to return the names in. Defaults to returning string keys.

IGCVersion_205790

GetClientVersion Version: 1
GET https://api.steampowered.com/IGCVersion_205790/GetClientVersion/v1
This method has no listed parameters.
GetServerVersion Version: 1
GET https://api.steampowered.com/IGCVersion_205790/GetServerVersion/v1
This method has no listed parameters.

IGCVersion_440

GetClientVersion Version: 1
GET https://api.steampowered.com/IGCVersion_440/GetClientVersion/v1
This method has no listed parameters.
GetServerVersion Version: 1
GET https://api.steampowered.com/IGCVersion_440/GetServerVersion/v1
This method has no listed parameters.

IGCVersion_570

GetClientVersion Version: 1
GET https://api.steampowered.com/IGCVersion_570/GetClientVersion/v1
This method has no listed parameters.
GetServerVersion Version: 1
GET https://api.steampowered.com/IGCVersion_570/GetServerVersion/v1
This method has no listed parameters.

IGCVersion_730

GetServerVersion Version: 1
GET https://api.steampowered.com/IGCVersion_730/GetServerVersion/v1
This method has no listed parameters.

IPortal2Leaderboards_620

GetBucketizedData Version: 1
GET https://api.steampowered.com/IPortal2Leaderboards_620/GetBucketizedData/v1
Name Type Required? Description
leaderboardName string The leaderboard name to fetch data for.

IPortal2Leaderboards_841

GetBucketizedData Version: 1
GET https://api.steampowered.com/IPortal2Leaderboards_841/GetBucketizedData/v1
Name Type Required? Description
leaderboardName string The leaderboard name to fetch data for.

ISteamApps

GetAppList Version: 1
GET https://api.steampowered.com/ISteamApps/GetAppList/v1
This method has no listed parameters.
GetAppList Version: 2
GET https://api.steampowered.com/ISteamApps/GetAppList/v2
This method has no listed parameters.
GetServersAtAddress Version: 1
GET https://api.steampowered.com/ISteamApps/GetServersAtAddress/v1
Name Type Required? Description
addr string IP or IP:queryport to list
UpToDateCheck Version: 1
GET https://api.steampowered.com/ISteamApps/UpToDateCheck/v1
Name Type Required? Description
appid uint32 AppID of game
version uint32 The installed version of the game

ISteamBitPay

BitPayPaymentNotification Version: 1
POST https://api.steampowered.com/ISteamBitPay/BitPayPaymentNotification/v1
This method has no listed parameters.

ISteamCDN

SetClientFilters Version: 1
POST https://api.steampowered.com/ISteamCDN/SetClientFilters/v1
Name Type Required? Description
key string access key
cdnname string Steam name of CDN property
allowedipblocks string comma-separated list of allowed IP address blocks in CIDR format - blank for not used
allowedasns string comma-separated list of allowed client network AS numbers - blank for not used
allowedipcountries string comma-separated list of allowed client IP country codes in ISO 3166-1 format - blank for not used
SetPerformanceStats Version: 1
POST https://api.steampowered.com/ISteamCDN/SetPerformanceStats/v1
Name Type Required? Description
key string access key
cdnname string Steam name of CDN property
mbps_sent uint32 Outgoing network traffic in Mbps
mbps_recv uint32 Incoming network traffic in Mbps
cpu_percent uint32 Percent CPU load
cache_hit_percent uint32 Percent cache hits

ISteamDirectory

GetCMList Version: 1
GET https://api.steampowered.com/ISteamDirectory/GetCMList/v1
Name Type Required? Description
cellid uint32 Client's Steam cell ID
maxcount uint32 Max number of servers to return

ISteamEconomy

GetAssetClassInfo Version: 1
GET https://api.steampowered.com/ISteamEconomy/GetAssetClassInfo/v1
Name Type Required? Description
appid uint32 Must be a steam economy app.
language string The user's local language
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.
GetAssetPrices Version: 1
GET https://api.steampowered.com/ISteamEconomy/GetAssetPrices/v1
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

ISteamEnvoy

PaymentOutNotification Version: 1
POST https://api.steampowered.com/ISteamEnvoy/PaymentOutNotification/v1
This method has no listed parameters.
PaymentOutReversalNotification Version: 1
POST https://api.steampowered.com/ISteamEnvoy/PaymentOutReversalNotification/v1
This method has no listed parameters.

ISteamNews

GetNewsForApp Version: 1
GET https://api.steampowered.com/ISteamNews/GetNewsForApp/v1
Name Type Required? Description
appid uint32 AppID to retrieve 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.
enddate uint32 Retrieve posts earlier than this date (unix epoch timestamp)
count uint32 # of posts to retrieve (default 20)
GetNewsForApp Version: 2
GET https://api.steampowered.com/ISteamNews/GetNewsForApp/v2
Name Type Required? Description
appid uint32 AppID to retrieve 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.
enddate uint32 Retrieve posts earlier than this date (unix epoch timestamp)
count uint32 # of posts to retrieve (default 20)
feeds string Comma-seperated list of feed names to return news for

ISteamPayPalPaymentsHub

PayPalPaymentsHubPaymentNotification Version: 1
POST https://api.steampowered.com/ISteamPayPalPaymentsHub/PayPalPaymentsHubPaymentNotification/v1
This method has no listed parameters.

ISteamRemoteStorage

GetCollectionDetails Version: 1
POST https://api.steampowered.com/ISteamRemoteStorage/GetCollectionDetails/v1
Name Type Required? Description
collectioncount uint32 Number of collections being requested
publishedfileids[0] uint64 collection ids to get the details for
GetPublishedFileDetails Version: 1
POST https://api.steampowered.com/ISteamRemoteStorage/GetPublishedFileDetails/v1
Name Type Required? Description
itemcount uint32 Number of items being requested
publishedfileids[0] uint64 published file id to look up
GetUGCFileDetails Version: 1
GET https://api.steampowered.com/ISteamRemoteStorage/GetUGCFileDetails/v1
Name Type Required? Description
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
appid uint32 appID of product

ISteamUser

GetFriendList Version: 1
GET https://api.steampowered.com/ISteamUser/GetFriendList/v1
Name Type Required? Description
key string access key
steamid uint64 SteamID of user
relationship string relationship type (ex: friend)
GetPlayerBans Version: 1
GET https://api.steampowered.com/ISteamUser/GetPlayerBans/v1
Name Type Required? Description
key string access key
steamids string Comma-delimited list of SteamIDs
GetPlayerSummaries Version: 1
GET https://api.steampowered.com/ISteamUser/GetPlayerSummaries/v1
Name Type Required? Description
key string access key
steamids string Comma-delimited list of SteamIDs
GetPlayerSummaries Version: 2
GET https://api.steampowered.com/ISteamUser/GetPlayerSummaries/v2
Name Type Required? Description
key string access key
steamids string Comma-delimited list of SteamIDs (max: 100)
GetUserGroupList Version: 1
GET https://api.steampowered.com/ISteamUser/GetUserGroupList/v1
Name Type Required? Description
key string access key
steamid uint64 SteamID of user
ResolveVanityURL Version: 1
GET https://api.steampowered.com/ISteamUser/ResolveVanityURL/v1
Name Type Required? Description
key string access key
vanityurl string The vanity URL to get a SteamID for
url_type int32 The type of vanity URL. 1 (default): Individual profile, 2: Group, 3: Official game group

ISteamUserAuth

AuthenticateUser Version: 1
POST https://api.steampowered.com/ISteamUserAuth/AuthenticateUser/v1
Name Type Required? Description
steamid uint64 Should be the users steamid, unencrypted.
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.
encrypted_loginkey rawbinary Should be the users hashed loginkey, AES encrypted with the sessionkey.
AuthenticateUserTicket Version: 1
GET https://api.steampowered.com/ISteamUserAuth/AuthenticateUserTicket/v1
Name Type Required? Description
key string access key
appid uint32 appid of game
ticket string Ticket from GetAuthSessionTicket.

ISteamUserOAuth

GetTokenDetails Version: 1
GET https://api.steampowered.com/ISteamUserOAuth/GetTokenDetails/v1
Name Type Required? Description
access_token string OAuth2 token for which to return details

ISteamUserStats

GetGlobalAchievementPercentagesForApp Version: 1
GET https://api.steampowered.com/ISteamUserStats/GetGlobalAchievementPercentagesForApp/v1
Name Type Required? Description
gameid uint64 GameID to retrieve the achievement percentages for
GetGlobalAchievementPercentagesForApp Version: 2
GET https://api.steampowered.com/ISteamUserStats/GetGlobalAchievementPercentagesForApp/v2
Name Type Required? Description
gameid uint64 GameID to retrieve the achievement percentages for
GetGlobalStatsForGame Version: 1
GET https://api.steampowered.com/ISteamUserStats/GetGlobalStatsForGame/v1
Name Type Required? Description
appid uint32 AppID that we're getting global stats for
count uint32 Number of stats get data for
name[0] string Names of stat to get data for
startdate uint32 Start date for daily totals (unix epoch timestamp)
enddate uint32 End date for daily totals (unix epoch timestamp)
GetNumberOfCurrentPlayers Version: 1
GET https://api.steampowered.com/ISteamUserStats/GetNumberOfCurrentPlayers/v1
Name Type Required? Description
appid uint32 AppID that we're getting user count for
GetPlayerAchievements Version: 1
GET https://api.steampowered.com/ISteamUserStats/GetPlayerAchievements/v1
Name Type Required? Description
key string access key
steamid uint64 SteamID of user
appid uint32 AppID to get achievements for
l string Language to return strings for
GetSchemaForGame Version: 1
GET https://api.steampowered.com/ISteamUserStats/GetSchemaForGame/v1
Name Type Required? Description
key string access key
appid uint32 appid of game
l string localized langauge to return (english, french, etc.)
GetSchemaForGame Version: 2
GET https://api.steampowered.com/ISteamUserStats/GetSchemaForGame/v2
Name Type Required? Description
key string access key
appid uint32 appid of game
l string localized language to return (english, french, etc.)
GetUserStatsForGame Version: 1
GET https://api.steampowered.com/ISteamUserStats/GetUserStatsForGame/v1
Name Type Required? Description
key string access key
steamid uint64 SteamID of user
appid uint32 appid of game
GetUserStatsForGame Version: 2
GET https://api.steampowered.com/ISteamUserStats/GetUserStatsForGame/v2
Name Type Required? Description
key string access key
steamid uint64 SteamID of user
appid uint32 appid of game

ISteamWebAPIUtil

GetServerInfo Version: 1
GET https://api.steampowered.com/ISteamWebAPIUtil/GetServerInfo/v1
This method has no listed parameters.
GetSupportedAPIList Version: 1
GET https://api.steampowered.com/ISteamWebAPIUtil/GetSupportedAPIList/v1
Name Type Required? Description
key string access key

ISteamWebUserPresenceOAuth

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

ITFItems_440

GetGoldenWrenches Version: 2
GET https://api.steampowered.com/ITFItems_440/GetGoldenWrenches/v2
This method has no listed parameters.

ITFPromos_205790

GetItemID Version: 1
GET https://api.steampowered.com/ITFPromos_205790/GetItemID/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for
promoid uint32 The promo ID to grant an item for
GrantItem Version: 1
POST https://api.steampowered.com/ITFPromos_205790/GrantItem/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for
promoid uint32 The promo ID to grant an item for

ITFPromos_440

GetItemID Version: 1
GET https://api.steampowered.com/ITFPromos_440/GetItemID/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for
promoid uint32 The promo ID to grant an item for
GrantItem Version: 1
POST https://api.steampowered.com/ITFPromos_440/GrantItem/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for
promoid uint32 The promo ID to grant an item for

ITFPromos_570

GetItemID Version: 1
GET https://api.steampowered.com/ITFPromos_570/GetItemID/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for
promoid uint32 The promo ID to grant an item for
GrantItem Version: 1
POST https://api.steampowered.com/ITFPromos_570/GrantItem/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for
promoid uint32 The promo ID to grant an item for

ITFPromos_620

GetItemID Version: 1
GET https://api.steampowered.com/ITFPromos_620/GetItemID/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for
PromoID uint32 The promo ID to grant an item for
GrantItem Version: 1
POST https://api.steampowered.com/ITFPromos_620/GrantItem/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for
PromoID uint32 The promo ID to grant an item for

ITFPromos_841

GetItemID Version: 1
GET https://api.steampowered.com/ITFPromos_841/GetItemID/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for
PromoID uint32 The promo ID to grant an item for
GrantItem Version: 1
POST https://api.steampowered.com/ITFPromos_841/GrantItem/v1
Name Type Required? Description
steamid uint64 The Steam ID to fetch items for
PromoID uint32 The promo ID to grant an item for

ITFSystem_440

GetWorldStatus Version: 1
GET https://api.steampowered.com/ITFSystem_440/GetWorldStatus/v1
This method has no listed parameters.

IGameServersService

GetAccountList Version: 1
GET https://api.steampowered.com/IGameServersService/GetAccountList/v1
Name Type Required? Description
key string Access key
CreateAccount Version: 1
POST https://api.steampowered.com/IGameServersService/CreateAccount/v1
Name Type Required? Description
key string Access key
appid uint32 The app to use the account for
memo string The memo to set on the new account
SetMemo Version: 1
POST https://api.steampowered.com/IGameServersService/SetMemo/v1
Name Type Required? Description
key string Access key
steamid uint64 The SteamID of the game server to set the memo on
memo string The memo to set on the new account
ResetLoginToken Version: 1
POST https://api.steampowered.com/IGameServersService/ResetLoginToken/v1
Name Type Required? Description
key string Access key
steamid uint64 The SteamID of the game server to reset the login token of
DeleteAccount Version: 1
POST https://api.steampowered.com/IGameServersService/DeleteAccount/v1
Name Type Required? Description
key string Access key
steamid uint64 The SteamID of the game server account to delete
GetAccountPublicInfo Version: 1
GET https://api.steampowered.com/IGameServersService/GetAccountPublicInfo/v1
Name Type Required? Description
key string Access key
steamid uint64 The SteamID of the game server to get info on
QueryLoginToken Version: 1
GET https://api.steampowered.com/IGameServersService/QueryLoginToken/v1
Name Type Required? Description
key string Access key
login_token string Login token to query
GetServerSteamIDsByIP Version: 1
GET https://api.steampowered.com/IGameServersService/GetServerSteamIDsByIP/v1
Name Type Required? Description
key string Access key
server_ips string This parameter has no listed description.
GetServerIPsBySteamID Version: 1
GET https://api.steampowered.com/IGameServersService/GetServerIPsBySteamID/v1
Name Type Required? Description
key string Access key
server_steamids uint64 This parameter has no listed description.

IPublishedFileService

QueryFiles Version: 1
GET https://api.steampowered.com/IPublishedFileService/QueryFiles/v1
Name Type Required? Description
key string Access key
query_type uint32 enumeration EPublishedFileQueryType in clientenums.h
page uint32 Current page
numperpage uint32 (Optional) The number of results, per page to return.
creator_appid uint32 App that created the files
appid uint32 App that consumes the files
requiredtags string Tags to match on. See match_all_tags parameter below
excludedtags string (Optional) Tags that must NOT be present on a published file to satisfy the query.
match_all_tags bool If true, then items must have all the tags specified, otherwise they must have at least one of the tags.
required_flags string Required flags that must be set on any returned items
omitted_flags string Flags that must not be set on any returned items
search_text string Text to match in the item's title or description
filetype uint32 EPublishedFileInfoMatchingFileType
child_publishedfileid uint64 Find all items that reference the given item.
days uint32 If query_type is k_PublishedFileQueryType_RankedByTrend, then this is the number of days to get votes for [1,7].
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
cache_max_age_seconds uint32 Allow stale data to be returned for the specified number of seconds.
language int32 Language to search in and also what gets returned. Defaults to English.
required_kv_tags {message} Required key-value tags to match on.
totalonly bool (Optional) If true, only return the total number of files that satisfy this query.
ids_only bool (Optional) If true, only return the published file ids of files that satisfy this query.
return_vote_data bool Return vote data
return_tags bool Return tags in the file details
return_kv_tags bool Return key-value tags in the file details
return_previews bool Return preview image and video details in the file details
return_children bool Return child item ids in the file details
return_short_description bool Populate the short_description field instead of file_description
return_for_sale_data bool Return pricing information, if applicable
return_metadata bool Populate the metadata

IPlayerService

RecordOfflinePlaytime Version: 1
POST https://api.steampowered.com/IPlayerService/RecordOfflinePlaytime/v1
Name Type Required? Description
steamid uint64 This parameter has no listed description.
ticket string This parameter has no listed description.
play_sessions {message} This parameter has no listed description.
GetRecentlyPlayedGames Version: 1
GET https://api.steampowered.com/IPlayerService/GetRecentlyPlayedGames/v1
Name Type Required? Description
key string Access key
steamid uint64 The player we're asking about
count uint32 The number of games to return (0/unset: all)
GetOwnedGames Version: 1
GET https://api.steampowered.com/IPlayerService/GetOwnedGames/v1
Name Type Required? Description
key string Access key
steamid uint64 The player we're asking about
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.
appids_filter uint32 if set, restricts result set to the passed in apps
GetSteamLevel Version: 1
GET https://api.steampowered.com/IPlayerService/GetSteamLevel/v1
Name Type Required? Description
key string Access key
steamid uint64 The player we're asking about
GetBadges Version: 1
GET https://api.steampowered.com/IPlayerService/GetBadges/v1
Name Type Required? Description
key string Access key
steamid uint64 The player we're asking about
GetCommunityBadgeProgress Version: 1
GET https://api.steampowered.com/IPlayerService/GetCommunityBadgeProgress/v1
Name Type Required? Description
key string Access key
steamid uint64 The player we're asking about
badgeid int32 The badge we're asking about
IsPlayingSharedGame Version: 1
GET https://api.steampowered.com/IPlayerService/IsPlayingSharedGame/v1
Name Type Required? Description
key string Access key
steamid uint64 The player we're asking about
appid_playing uint32 The game player is currently playing

IInventoryService

GetPriceSheet Version: 1
GET https://api.steampowered.com/IInventoryService/GetPriceSheet/v1
Name Type Required? Description
key string Access key
ecurrency int32 This parameter has no listed description.

IEconService

GetTradeHistory Version: 1
GET https://api.steampowered.com/IEconService/GetTradeHistory/v1
Name Type Required? Description
key string Access key
max_trades uint32 The number of trades to return information for
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
navigating_back bool The user wants the previous page of results, so return the previous max_trades trades before the start time and ID
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
include_failed bool This parameter has no listed description.
include_total bool If set, the total number of trades the account has participated in will be included in the response
GetTradeOffers Version: 1
GET https://api.steampowered.com/IEconService/GetTradeOffers/v1
Name Type Required? Description
key string Access key
get_sent_offers bool Request the list of sent offers.
get_received_offers bool Request the list of received offers.
get_descriptions bool If set, the item display data for the items included in the returned trade offers will also be returned.
language string The language to use when loading item display data.
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
historical_only bool Indicates we should only return offers which are not active.
time_historical_cutoff uint32 When active_only is set, offers updated since this time will also be returned
GetTradeOffer Version: 1
GET https://api.steampowered.com/IEconService/GetTradeOffer/v1
Name Type Required? Description
key string Access key
tradeofferid uint64 This parameter has no listed description.
language string This parameter has no listed description.
GetTradeOffersSummary Version: 1
GET https://api.steampowered.com/IEconService/GetTradeOffersSummary/v1
Name Type Required? Description
key string Access key
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.
DeclineTradeOffer Version: 1
POST https://api.steampowered.com/IEconService/DeclineTradeOffer/v1
Name Type Required? Description
key string Access key
tradeofferid uint64 This parameter has no listed description.
CancelTradeOffer Version: 1
POST https://api.steampowered.com/IEconService/CancelTradeOffer/v1
Name Type Required? Description
key string Access key
tradeofferid uint64 This parameter has no listed description.

ICheatReportingService

ReportCheatData Version: 1
POST https://api.steampowered.com/ICheatReportingService/ReportCheatData/v1
Name Type Required? Description
key string Access key
steamid uint64 steamid of the user running and reporting the cheat.
appid uint32 The appid.
pathandfilename string path and file name of the cheat executable.
webcheaturl string web url where the cheat was found and downloaded.
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 )
cheatname string descriptive name for the cheat.
game_process_id uint32 process ID of the running game.
cheat_process_id uint32 process ID of the cheat process that ran
cheat_param_1 uint64 cheat param 1
cheat_param_2 uint64 cheat param 2

IAccountRecoveryService

ReportAccountRecoveryData Version: 1
POST https://api.steampowered.com/IAccountRecoveryService/ReportAccountRecoveryData/v1
Name Type Required? Description
loginuser_list string This parameter has no listed description.
install_config string This parameter has no listed description.
shasentryfile string This parameter has no listed description.
machineid string This parameter has no listed description.
RetrieveAccountRecoveryData Version: 1
POST https://api.steampowered.com/IAccountRecoveryService/RetrieveAccountRecoveryData/v1
Name Type Required? Description
requesthandle string This parameter has no listed description.