[subsection=BReleaseSteamPipe]BReleaseSteamPipe[/subsection] [code=cpp]bool BReleaseSteamPipe( HSteamPipe hSteamPipe );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]hSteamPipe[/b][/td][td][apitype]ISteamClient::HSteamPipe[/apitype][/td][td]The pipe to release.…

[subsection=CreateLocalUser]CreateLocalUser[/subsection] [code=cpp]HSteamUser CreateLocalUser( HSteamPipe *phSteamPipe, EAccountType eAccountType );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]phSteamPipe[/b][/td][td][apitype]ISteamClient::HSteamPipe[/apitype] *[/td][td][/td][/tr] [tr][td][b]eAccountType[/b][/td][td][apitype]steam_api::EAccountType[/apitype][/td][td][/td][/tr] [/table] Create a Steam user that won't be shared with anyone else. …

[section=EnumerateUserSubscribedFiles]EnumerateUserSubscribedFiles[/section] [code=http]POST https://partner.steam-api.com/ISteamRemoteStorage/EnumerateUserSubscribedFiles/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=SubscribePublishedFile]SubscribePublishedFile[/section] [code=http]POST https://partner.steam-api.com/ISteamRemoteStorage/SubscribePublishedFile/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=k_ESteamHardwareDefaultConfigSteamFrame][td][b]k_ESteamHardwareDefaultConfigSteamFrame[/b][/td][td]7[/td][td]Steam Frame default configuration.[/td][/tr] [/table] [subsection=ESteamHardwareType]ESteamHardwareType[/subsection] Steam API call failure results returned by [api]ISteamUtils::IsRunningOnSteamHardware[/api]. [table] [tr][th]Name[/th][th]Value[/th][th]Description[/th][/tr] [tr=k_ESteamHardwareTypeNone][td][b]k_ESteamHardwareTypeNone[/b][/td][td]0[/td][td]Not playing on Steam hardware device.[/td][/tr] [tr=k_ESteamHardwareTypeSteamDeck][td][b]k_ESteamHardwareTypeSteamDeck[/b][/td][td]1[/td][td]Running on a Steam Deck.[/td][/tr] [tr=k_ESteamHardwareTypeSteamMachine][td][b]k_ESteamHardwareTypeSteamMachine[/b][/td][td]2[/td][td]Running on a Steam Machine.…

[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.…

Adding the station's account to your licensed master account is required in order to view and purchase commercial licenses with the individual station's Steam account. [/list] [/callout] [h3]Purchase games for commercial use on Steam[/h3] [callout] Only games specifically mentioned for commercial use on Steam can be offered to your customers and patrons. …

Begin with a "start_index" of zero, and iterate if necessary if the user has more than "count" files. The response has two fields: [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]files[/b][/td][td]see below[/td][td]A list of file details[/td][/tr] [tr][td][b]total_files[/b][/td][td]uint32[/td][td]The total number of files the user has in Steam Cloud for your app.…

[subsection]Delete[/subsection] Example: [code] POST https://api.steampowered.com/ICloudService/Delete/v1/ HTTP/1.1 Host: api.steampowered.com Content-Type: application/x-www-form-urlencoded Content-Length: <body length> access_token=<token>&input_json={ "appid": "1234", "filename": "%25WinAppDataLocal%25Foobar%2FGamename%2Fcloud%2Fgames%2Fsave.sav" } [/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]access_token[/b][/td][td]string[/td][td]✔[/td][td]OAuth access token for the user[/td][/tr] [tr][td][b]appid[/b][/td][td]uint32[/td][td]✔[/td][td]Your App ID[/td][/tr] [tr][td][b]filename[/b][/td][td]string[/td][td]✔[/td][td]filename of the file to delete[/td][/tr] [/table] This API will delete the specified file from the user's Steam Cloud. …

[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. …

To authenticate a user, redirect the user to [code]https://steamcommunity.com/oauth/login?response_type=token&client_id=client_id_here&state=whatever_you_want[/code] Adding [code-inline]&mobileminimal=1[/code-inline] to the above request is recommended for embedded browsers, as it removes some of the Steam site navigation UI that will not be relevant when the OAuth page is presented directly to a user within your game. If you include the state parameter, it will be passed back to the redirect URI after the user has confirmed or denied access. Note that the authorization code grant type is also supported, by using the response_type=code during login. If the user grants access, they will be redirected back to you at [code]http://redirect/uri/here#access_token=token_here&token_type=steam&state=whatever_you_want[/code] The token should be treated as an opaque string. …

[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.…

Note that after your app releases to customers, your customers will be receiving the build marked as the Default build. In order to test your update, you should upload the new build using Steampipe, then set that build on a test branch with a password to test before moving it to the default branch. …

[section]Overview[/section] Our experience with pre-purchases (or pre-orders) is that they tend to be ineffective unless it’s a heavily anticipated, heavily marketed title, and even then we encourage titles to have short pre-purchase periods on Steam. …

[/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]Overview[/section] In order to help developers understand the usage of the Steamworks API we have included source code for a fully functional version of the classic [b]Spacewar!…

When you ship your own game through Steam this file will not be needed as Steam will auto-detect your AppID when the game is launched. [*] [b]The application has failed to start because steam_api.dll was not found. Re-installing the application may fix this problem.[/b] In order to run successfully [code-inline]steam_api.dll[/code-inline] must be located in the same directory as the example game executable. …

[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.…

[section]Pay for Purchase Titles[/section] The new currency prices need to be approved by you for everything sold on the Steam store in order for us to continue to sell your titles in the affected territories. You will need to approve the new currency prices that we have recommended, or adjust those new currency prices and submit those to us for approval. …

Some developers will choose to participate in Next Fest early in their development cycle to learn more about what customers enjoy. Others will pick the one closest to launch in order to drum up interest in the game shortly before release. There's no right answer- join the Next Fest that makes the most sense for you and your title. …

[/td][/tr] [/table] [subsection=demo]Setting Up Your Demo[/subsection] After registration, you'll need to set up your demo on Steam. This means setting up a demo type app, which is attached to your base game on Steam. For more information about creating, testing, and releasing a demo, please see the [doclink=store/application/demos]Demos documentation[/doclink]. …

[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.…