[table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]m_SteamID[/b][/td][td][apitype]steam_api::CSteamID[/apitype][/td][td]The Steam ID of the user that is wanting to connect.…

This information can be used to determine which server is bad. [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.…

[subsection=ESteamNetworkingIdentityType]enum ESteamNetworkingIdentityType[/subsection] Different types of identities that a remote host can have. Most of the time on Steam, this will be a CSteamID. …

[code] struct SteamNetworkingIdentity { /// Type of identity. ESteamNetworkingIdentityType m_eType; // // Get/Set in various formats. // void Clear(); bool IsInvalid() const; // Return true if we are the invalid type. …

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

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

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

[subsection=CancelQuery]CancelQuery[/subsection] [code=cpp]void CancelQuery( HServerListRequest hRequest );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]hRequest[/b][/td][td][apitype]ISteamMatchmaking::HServerListRequest[/apitype][/td][td]The handle to the server list request.…

[/td][/tr] [tr=eNoServersListedOnMasterServer][td][b]eNoServersListedOnMasterServer[/b][/td][td]2[/td][td]Only for the internet query type, returned in response callback if no servers of this type match.[/td][/tr] [/table] [section=constants]Constants[/section] These are constants which are defined for use with ISteamMatchmakingServers. …

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

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

[/td][/tr] [tr][td][b]pchContentType[/b][/td][td]const char *[/td][td]Sets the value of the calls "content-type" http header.[/td][/tr] [tr][td][b]pubBody[/b][/td][td][apitype]steam_api::uint8[/apitype] *[/td][td]The raw POST body data to set.…

Setting this raw body makes it the only contents for the post, the [code-inline]pchContentType[/code-inline] parameter will set the "content-type" header for the request to inform the server how to interpret the body. …

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

[/td][/tr] [tr][td][b]m_eType[/b][/td][td][apitype]ISteamRemotePlay::ERemotePlayInputType[/apitype][/td][td]The type of input in this event.[/td][/tr] [tr][td][b]m_MouseMotion[/b][/td][td][apitype]ISteamRemotePlay::RemotePlayInputMouseMotion_t[/apitype][/td][td]Mouse motion event data, valid when m_eType is k_ERemotePlayInputMouseMotion.…

[/td][/tr] [tr=k_ESteamDeviceFormFactorTV][td][b]k_ESteamDeviceFormFactorTV[/b][/td][td]4[/td][td]The device is a TV.[/td][/tr] [/table] [subsection=ERemotePlayInputType]ERemotePlayInputType[/subsection] The type of input in [apitype]ISteamRemotePlay::RemotePlayInput_t[/apitype] [table] [tr][th]Name[/th][th]Value[/th][th]Description[/th][/tr] [tr=k_ERemotePlayInputUnknown][td][b]k_ERemotePlayInputUnknown[/b][/td][td]0[/td][td]Unknown input.…

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

[b]Example:[/b] [code=cpp]const char *localGlyphPath = SteamInput()->GetGlyphSVGForActionOrigin( origins[0], ESteamInputGlyphStyle_Knockout );[/code] [subsection=GetInputTypeForHandle]GetInputTypeForHandle[/subsection] [code=cpp]ESteamInputType GetInputTypeForHandle( InputHandle_t inputHandle );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]inputHandle[/b][/td][td][apitype]ISteamInput::InputHandle_t[/apitype][/td][td]The handle of the controller whose input type (device model) you want to query[/td][/tr] [/table] Returns the input type (device model) for the specified controller. …

[b]NOTE:[/b] Unlike [apitype]ISteamInput::EInputActionOrigin[/apitype], which updates with Steam and may return unrecognized values, [apitype]ISteamInput::ESteamInputType[/apitype] will remain static and only return valid values from your SDK version. [b]Returns:[/b] [apitype]ISteamInput::ESteamInputType[/apitype] [b]Example:[/b] [code=cpp] ESteamInputType inputType = SteamInput()->GetInputTypeForHandle(controller1Handle); switch(inputType) { case k_ESteamInputType_Unknown: printf("unknown!…

[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": "" } ] …

[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]Was the call successful? …

This usually occurs in the rare event the Steam client has some kind of fatal error. [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]m_eFailureType[/b][/td][td][apitype]steam_api::uint8[/apitype][/td][td]This is a [apitype]ISteamUser::EFailureType[/apitype].…

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