Steam Web API Documentation
/
ISteamLeaderboards
Steam
IAccountCartService
IAccountPrivacyService
IAccountPrivateAppsService
IAssetSetPublishingService
IAuctionService
IAuthenticationService
IAuthenticationSupportService
IBillingService
IBroadcastService
IChatRoomService
ICheatReportingService
ICheckoutService
IClanFAQSService
IClanService
IClientCommService
IClientMetricsService
ICloudService
ICommunityService
IContentFilteringService
IContentModerationService
IContentServerConfigService
IContentServerDirectoryService
ICrashReportService
ICredentialsService
IDailyDealService
IDataPublisherService
IEconMarketService
IEconService
IEmbeddedClientService
IFamilyGroupsService
IForumsService
IFriendMessagesService
IFriendsListService
IGameCoordinator
IGameInventory
IGameNotificationsService
IGamePerformanceStatsService
IGameRecordingClipService
IGameServersService
IHelpRequestLogsService
IInventoryService
ILobbyMatchmakingService
ILoyaltyRewardsService
IMarketingMessagesService
IMobileAppService
IMobileAuthService
IMobileDeviceService
IMobileNotificationService
INewsService
IOnlinePlayService
IParentalService
IPartnerAppNotesService
IPartnerDeadlineService
IPartnerDismissService
IPartnerFinancialsService
IPartnerMeetSteamService
IPartnerMembershipInviteService
IPartnerStoreBrowseService
IPhoneService
IPhysicalGoodsService
IPlayerService
IPlaytestService
IProductInfoService
IPromotionEventInvitesService
IPromotionPlanningService
IPromotionStatsService
IPublishedFileModerationService
IPublishedFileService
IPublishingService
IQuestService
IRemoteClientService
ISaleFeatureService
ISaleItemRewardsService
IShoppingCartService
ISiteLicenseService
ISteamApps
ISteamAwardsService
ISteamBitPay
ISteamBoaCompra
ISteamBroadcast
ISteamCDN
ISteamChartsService
ISteamCloudGaming
ISteamCommunity
ISteamDirectory
ISteamEconomy
ISteamEnvoy
ISteamGameServerStats
ISteamLeaderboards
DeleteLeaderboard
DeleteLeaderboardScore
FindOrCreateLeaderboard
GetLeaderboardEntries
GetLeaderboardsForGame
ModifyLeaderboardScoreMulti
ResetLeaderboard
SetLeaderboardScore
ISteamLearnService
ISteamMicroTxn
ISteamMicroTxnSandbox
ISteamNews
ISteamNodwin
ISteamNotificationService
ISteamPayPalPaymentsHub
ISteamPublishedItemSearch
ISteamPublishedItemVoting
ISteamRemoteStorage
ISteamSpecialSurvey
ISteamTVService
ISteamUser
ISteamUserAuth
ISteamUserOAuth
ISteamUserStats
ISteamWebAPIUtil
ISteamWorkshop
IStoreAppSimilarityService
IStoreBrowseService
IStoreCatalogService
IStoreCurationService
IStoreMarketingService
IStorePreferencesService
IStoreQueryService
IStoreSalesService
IStoreService
IStoreTopSellersService
ITestExternalPrivilegeService
ITestService
ITrustService
ITwoFactorService
IUserAccountService
IUserGameNotesService
IUserReviewsService
IUserStoreVisitService
IVACManagementService
IVideoService
IWishlistService
IWorkshopService
Counter-Strike 2
ICSGOPlayers_730
ICSGOServers_730
ICSGOStreamSystem_730
ICSGOTournaments_730
IEconItems_730
IGCVersion_730
Dota 2
IDOTA2AutomatedTourney_570
IDOTA2CustomGames_570
IDOTA2Events_570
IDOTA2Fantasy_570
IDOTA2Guild_570
IDOTA2League_570
IDOTA2MatchStats_570
IDOTA2Match_570
IDOTA2Operations_570
IDOTA2Plus_570
IDOTA2StreamSystem_570
IDOTA2Teams_570
IDOTA2Ticket_570
IDOTAChat_570
IEconDOTA2_570
IEconItems_570
IGCVersion_570
Team Fortress 2
IEconItems_440
IGCVersion_440
ITFItems_440
ITFPromos_440
ITFSystem_440
Deadlock
ICitadelAdmin_1422450
IGCVersion_1422450
Portal 2
IEconItems_620
IPortal2Leaderboards_620
ITFPromos_620
Dota Underlords
IClientStats_1046930
IEconItems_1046930
IGCVersion_1046930
Artifact Classic
IEconItems_583950
IGCVersion_583950
Artifact Foundry
IEconItems_1269260
IGCVersion_1269260
Dota 2 Experimental
IDOTA2AutomatedTourney_247040
IDOTA2CustomGames_247040
IDOTA2Events_247040
IDOTA2Fantasy_247040
IDOTA2Guild_247040
IDOTA2League_247040
IDOTA2MatchStats_247040
IDOTA2Match_247040
IDOTA2Operations_247040
IDOTA2Plus_247040
IDOTA2StreamSystem_247040
IDOTA2Teams_247040
IDOTA2Ticket_247040
IDOTAChat_247040
IEconDOTA2_247040
IEconItems_247040
IGCVersion_247040
Dota 2 Staging
IDOTA2AutomatedTourney_2305270
IDOTA2CustomGames_2305270
IDOTA2Events_2305270
IDOTA2Fantasy_2305270
IDOTA2Guild_2305270
IDOTA2League_2305270
IDOTA2Operations_2305270
IDOTA2Plus_2305270
IDOTA2Teams_2305270
IDOTAChat_2305270
IGCVersion_2305270
Deadlock Experimental
ICitadelAdmin_3488080
IGCVersion_3488080
Deadlock Unknown
ICitadelAdmin_3781850
IGCVersion_3781850
This page is just a reference of all the known Steam APIs, I do not know how they work. Please do not email me with questions.
PUBLISHER
POST
DeleteLeaderboard
Execute
https://partner.steam-api.com/ISteamLeaderboards/DeleteLeaderboard/v1/
Name
Value
Type
Required
Description
appid
uint32
Yes
appid of game
name
string
Yes
name of the leaderboard to delete
PUBLISHER
POST
DeleteLeaderboardScore
Execute
https://partner.steam-api.com/ISteamLeaderboards/DeleteLeaderboardScore/v1/
Name
Value
Type
Required
Description
appid
uint32
Yes
appid of game
leaderboardid
uint64
Yes
numeric ID of the target leaderboard. Can be retrieved from GetLeaderboardsForGame
steamid
uint64
Yes
steamID to set the score for
PUBLISHER
POST
FindOrCreateLeaderboard
v2
Execute
https://partner.steam-api.com/ISteamLeaderboards/FindOrCreateLeaderboard/v2/
Name
Value
Type
Required
Description
appid
uint32
Yes
appid of game
name
string
Yes
name of the leaderboard to create
sortmethod
string
No
sort method to use for this leaderboard (defaults to Ascending)
displaytype
string
No
display type for this leaderboard (defaults to Numeric)
createifnotfound
bool
No
if this is true the leaderboard will be created if it doesn't exist. Defaults to true.
onlytrustedwrites
bool
No
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.
onlyfriendsreads
bool
No
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.
onlyusersinsameparty
bool
No
if this is true the leaderboard scores for SteamIDs can only be read for party members, scores can always be read by publisher. Defaults to false.
limitrangearounduser
int32
No
limit the range of rows around user. Zero means unlimited. -1 means disabled. Positive is plus/minus limit. Defaults to zero.
limitglobaltopentries
int32
No
limit the top of the leaderboard. Zero means unlimited. -1 means disabled. Positive is limit to TOP(N). Defaults to zero.
PUBLISHER
GET
GetLeaderboardEntries
Execute
https://partner.steam-api.com/ISteamLeaderboards/GetLeaderboardEntries/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
access key
appid
uint32
Yes
appid of game
rangestart
int32
Yes
range start or 0
rangeend
int32
Yes
range end or max LB entries
steamid
uint64
No
SteamID used for friend & around user requests
leaderboardid
int32
Yes
ID of the leaderboard to view
datarequest
uint32
Yes
type of request: RequestGlobal, RequestAroundUser, RequestFriends
PUBLISHER
GET
GetLeaderboardsForGame
v2
Execute
https://partner.steam-api.com/ISteamLeaderboards/GetLeaderboardsForGame/v2/
Name
Value
Type
Required
Description
key
click to set
string
Yes
access key
appid
uint32
Yes
appid of game
PUBLISHER
POST
ModifyLeaderboardScoreMulti
Execute
https://partner.steam-api.com/ISteamLeaderboards/ModifyLeaderboardScoreMulti/v1/
Name
Value
Type
Required
Description
appid
uint32
Yes
appid of game
steamid
uint64
Yes
steamID to set the score for
score
int32
No
the score to set for this user
scoremethod
string
No
update method to use. Can be "KeepBest" or "ForceUpdate"
details
rawbinary
No
game-specific details for how the score was earned. Up to 256 bytes.
leaderboardid_del[0]
+
uint32[]
No
Numeric ID of the target leaderboard to delete user scores from. Multiple leaderboards supported by numbering sequentially [0], [1], [2], ... Leaderboards be retrieved from GetLeaderboardsForGame.
leaderboardid_del[1]
uint32
No
Numeric ID of the target leaderboard to delete user scores from. Multiple leaderboards supported by numbering sequentially [0], [1], [2], ... Leaderboards be retrieved from GetLeaderboardsForGame.
leaderboardid_set[0]
+
uint32[]
No
Numeric ID of the target leaderboard to set user scores into. Multiple leaderboards supported by numbering sequentially [0], [1], [2], ... Scores are set after all delete operations complete. Leaderboards be retrieved from GetLeaderboardsForGame.
leaderboardid_set[1]
uint32
No
Numeric ID of the target leaderboard to set user scores into. Multiple leaderboards supported by numbering sequentially [0], [1], [2], ... Scores are set after all delete operations complete. Leaderboards be retrieved from GetLeaderboardsForGame.
PUBLISHER
POST
ResetLeaderboard
Execute
https://partner.steam-api.com/ISteamLeaderboards/ResetLeaderboard/v1/
Name
Value
Type
Required
Description
appid
uint32
Yes
appid of game
leaderboardid
uint32
Yes
numeric ID of the target leaderboard. Can be retrieved from GetLeaderboardsForGame
PUBLISHER
POST
SetLeaderboardScore
Execute
https://partner.steam-api.com/ISteamLeaderboards/SetLeaderboardScore/v1/
Name
Value
Type
Required
Description
appid
uint32
Yes
appid of game
leaderboardid
uint32
Yes
numeric ID of the target leaderboard. Can be retrieved from GetLeaderboardsForGame
steamid
uint64
Yes
steamID to set the score for
score
int32
Yes
the score to set for this user
scoremethod
string
Yes
update method to use. Can be "KeepBest" or "ForceUpdate"
details
rawbinary
No
game-specific details for how the score was earned. Up to 256 bytes.