The JSON response will contain the following fields: [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]ownsapp[/b][/td][td]bool[/td][td]Indicates if the user has an active license for this app.…
[/td][/tr] [tr][td][b]vanityurl[/b][/td][td]string[/td][td]✔[/td][td]The vanity URL to get a SteamID for[/td][/tr] [tr][td][b]url_type[/b][/td][td]int32[/td][td][/td][td]The type of vanity URL. 1 (default): Individual profile, 2: Group, 3: Official game group[/td][/tr] [/table] …
[section=DeleteLeaderboard]DeleteLeaderboard[/section] [code=http]POST https://partner.steam-api.com/ISteamLeaderboards/DeleteLeaderboard/v1/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]key[/b][/td][td]string[/td][td]✔[/td][td]Steamworks Web API publisher authentication key.…
[section=ResetLeaderboard]ResetLeaderboard[/section] [code=http]POST https://partner.steam-api.com/ISteamLeaderboards/ResetLeaderboard/v1/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]key[/b][/td][td]string[/td][td]✔[/td][td]Steamworks Web API publisher authentication key.…
[section=GetRecentlyPlayedGames]GetRecentlyPlayedGames[/section] [code=http]GET https://partner.steam-api.com/IPlayerService/GetRecentlyPlayedGames/v1/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]key[/b][/td][td]string[/td][td]✔[/td][td]Steamworks Web API user authentication key.…
[section=GetSteamLevel]GetSteamLevel[/section] [code=http]GET https:/partner.steam-api.com/IPlayerService/GetSteamLevel/v1/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]key[/b][/td][td]string[/td][td]✔[/td][td]Steamworks Web API user authentication key.…
For positional based leaderboards, use Ascending. For high-score, use Descending. [*]Display Type - Determines the types of data to be displayed with the leaderboard. Select from Numeric, Seconds or Milliseconds. [*]Writes - If this is set to Trusted, the leaderboard scores cannot be set by clients, and can only be set by via SetLeaderboardScore WebAPI. …
Once a leaderboard has been created, you can modify the sort method and display type for a leaderboard through the Game Admin. When FindOrCreateLeaderboard is called for an existing leaderboard, the sort method and display type parameters are ignored. …
[subsection=GetOPFSettings]GetOPFSettings[/subsection] [code=cpp]void GetOPFSettings( AppId_t unVideoAppID );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]unVideoAppID[/b][/td][td][apitype]steam_api::AppId_t[/apitype][/td][td]The video app ID to get the OPF details of.…
After receiving this you can use [api]ISteamVideo::GetOPFStringForApp[/api] to access the OPF details. [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]m_eResult[/b][/td][td][apitype]steam_api::EResult[/apitype][/td][td]The result of the operation. …
[section=GetPlayerAchievements]GetPlayerAchievements[/section] [code=http]GET https://partner.steam-api.com/ISteamUserStats/GetPlayerAchievements/v1/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]key[/b][/td][td]string[/td][td]✔[/td][td]Steamworks Web API user authentication key.…
[section=GetSchemaForGame]GetSchemaForGame[/section] [code=http]GET https://partner.steam-api.com/ISteamUserStats/GetSchemaForGame/v2/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]key[/b][/td][td]string[/td][td]✔[/td][td]Steamworks Web API user authentication key.…
[subsection=SetConfigValue]SetConfigValue[/subsection] [code=cpp]bool SetConfigValue( ESteamNetworkingConfigValue eValue, ESteamNetworkingConfigScope eScopeType, intptr_t scopeObj, ESteamNetworkingConfigDataType eDataType, const void *pArg );[/code] Set a configuration value. [list] [*] eValue: which value is being set [*] eScope: Onto what type of object are you applying the setting? …
E.g. connection handle, listen socket handle, interface pointer, etc. [*] eDataType: What type of data is in the buffer at pValue? This must match the type of the variable exactly! [*] pArg: Value to set it to. …
[section=CanTrade]CanTrade[/section] [code=http]GET https://partner.steam-api.com/ISteamEconomy/CanTrade/v1/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]key[/b][/td][td]string[/td][td]✔[/td][td]Steamworks Web API publisher authentication key.…
[section=StartTrade]StartTrade[/section] [code=http]GET https://partner.steam-api.com/ISteamEconomy/StartTrade/v1/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]key[/b][/td][td]string[/td][td]✔[/td][td]Steamworks Web API publisher authentication key.…
[/td][/tr] [tr][td][b]appdata[/b][/td][td]uint64[/td][td][/td][td](Optional) App specific data about the type of cheating set by developer. (ex 1 = Aimbot, 2 = Wallhack, 3 = Griefing)[/td][/tr] [tr][td][b]heuristic[/b][/td][td]bool[/td][td][/td][td](Optional) Extra information about the source of the cheating - was it a heuristic.…
[b]Response:[/b] [ { "name": "success", "type": "bool", "description": "" } ] …
[section=GetTradeHistory]GetTradeHistory[/section] [code=http]GET https://api.steampowered.com/IEconService/GetTradeHistory/v1/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]key[/b][/td][td]string[/td][td]✔[/td][td]Steamworks Web API user authentication key.…
[section=GetTradeOffers]GetTradeOffers[/section] [code=http]GET https://api.steampowered.com/IEconService/GetTradeOffers/v1/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]key[/b][/td][td]string[/td][td]✔[/td][td]Steamworks Web API user authentication key.…
To do this, find the "Add Individual Apps" area. You'll either type in the game name or appID and select the game from the drop-down. [section]Options for display of games[/section] These options can be combined in a variety of ways to achieve the look you are going for. [docimg=sectionType_Items.jpg]sectionType_Items.jpg[/docimg] Showing a 4-row grid set to display "2/3/4/3" format [subsection]Display as a carousel[/subsection] If you set a section to appear as a carousel, any items that do not fit in the initial display will accessible by click the right or left arrows that appear next to the section. …
[subsection=SetGamePhaseID]SetGamePhaseID[/subsection] [code=cpp] void SetGamePhaseID( const char *pchPhaseID) ;[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]pchPhaseID[/b][/td][td]const char *[/td][td]A game-provided persistent ID for a game phase. …
[subsection=OpenOverlayToGamePhase]OpenOverlayToGamePhase[/subsection] [code=cpp]void OpenOverlayToGamePhase( const char *pchPhaseID );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]pchPhaseID[/b][/td][td]const char *pchPhaseID[/td][td]The game phase to show in the overlay.…
[section=GetAssetID]GetAssetID[/section] [code=http]GET https://partner.steam-api.com/IEconMarketService/GetAssetID/v1/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]key[/b][/td][td]string[/td][td]✔[/td][td]Steamworks Web API publisher authentication key.…
[section=GetPopular]GetPopular[/section] [code=http]GET https://partner.steam-api.com/IEconMarketService/GetPopular/v1/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]key[/b][/td][td]string[/td][td]✔[/td][td]Steamworks Web API publisher authentication key.…
[subsection]Header File[/subsection] We first define a structure to hold our stats data received from steam, define stat types in a handy enum and then provide a macro for creating stats objects. This data maps directly to what is found on the [url=https://partner.steamgames.com/apps/stats/]Stats Configuration[/url] page. [code=cpp] #define _STAT_ID( id,type,name ) { id, type, name, 0, 0, 0, 0 } enum EStatTypes { STAT_INT = 0, STAT_FLOAT = 1, STAT_AVGRATE = 2, }; struct Stat_t { int m_ID; EStatTypes m_eStatType; const char *m_pchStatName; int m_iValue; float m_flValue; float m_flAvgNumerator; float m_flAvgDenominator; }; [/code] Next we define a helper class that will wrap all of the Steam Stats API calls as well as creating all of the [doclink=sdk/api#callbacks]Steam callbacks[/doclink]. …
[section=SetItemPaymentRules]SetItemPaymentRules[/section] [code=http]POST https://partner.steam-api.com/IWorkshopService/SetItemPaymentRules/v1/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]key[/b][/td][td]string[/td][td]✔[/td][td]Steamworks Web API publisher authentication key.…
[section=GetItemDailyRevenue]GetItemDailyRevenue[/section] [code=http]GET https://partner.steam-api.com/IWorkshopService/GetItemDailyRevenue/v1/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]key[/b][/td][td]string[/td][td]✔[/td][td]Steamworks Web API publisher authentication key.…
(Note: You can change the settings to only show the newest events from the last X weeks.) [docimg=NEWS.png]NEWS.png[/docimg] [*][b]Carousel or grid of games[/b] - The basic building blocks for showcasing games. …
[subsection=SetVolume]SetVolume[/subsection] [code=cpp]void SetVolume( float flVolume );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]flVolume[/b][/td][td]float[/td][td]The volume percentage to set from [b]0.0[/b] to [b]1.0[/b].…
[subsection=VolumeHasChanged_t]VolumeHasChanged_t[/subsection] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]m_flNewVolume[/b][/td][td]float[/td][td][/td][/tr] [/table] [section=enums]Enums[/section] These are enums which are defined for use with ISteamMusic. …
Using it, you can: [list] [*] Define the initial statistics and achievements [*] Add additional stats and achievements [*] Update achievement names, descriptions, and icons [*] Update statistic parameters and constraints (max/min values, moving-average window sizes, etc) [/list] Stats have the following properties: [list] [*] [b]ID[/b] - An automatically-generated numerical ID for each stat. [*] [b]Type[/b] - The type of this Stat - INT, FLOAT, or [doclink=#AVGRATE]AVGRATE[/doclink]. [*] [b]API Name[/b] - The string used to access this stat using the API. [*] [b]Set By[/b] - Sets who can modify the stat. …
The Steam Game Overlay will display a notification panel to the user. [/list] [subsection=AVGRATE]The AVGRATE stat type[/subsection] This type of stat provides some unique and very useful functionality, but it requires a little bit more detail to explain. …
[subsection]Community Tabs[/subsection] Community hubs are organized into different tabs based on the type of content they contain. By default, these tabs will show the most popular content posted over the previous week. [list] [*][b]All[/b] - The front page of your hub. …
These settings control the features that your different group member types are able to use. You can access these permissions from the Hub Admin panel by selecting [i]Edit Group Permissions[/i] [*][b]Adding moderators[/b] Once you have a good idea of what features are accessible by which member types, you'll want to promote other members of your team. …
[section=AuthenticateUser]AuthenticateUser[/section] [code=http]POST https://partner.steam-api.com/ISteamUserAuth/AuthenticateUser/v1/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]steamid[/b][/td][td]uint64[/td][td]✔[/td][td]Should be the users steamid, unencrypted.…
[/td][/tr] [/table] [section=AuthenticateUserTicket]AuthenticateUserTicket[/section] [code=http]GET https://partner.steam-api.com/ISteamUserAuth/AuthenticateUserTicket/v1/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]key[/b][/td][td]string[/td][td]✔[/td][td]Steamworks Web API publisher authentication key[/td][/tr] [tr][td][b]appid[/b][/td][td]uint32[/td][td]✔[/td][td]appid of game[/td][/tr] [tr][td][b]ticket[/b][/td][td]string[/td][td]✔[/td][td]Convert the binary ticket data from GetAuthTicketForWebApi into a hexadecimal string and pass that string in as this parameter.…