steam - Documentation

new steam(settings)

Source:

steam.js, line 11

Creates a new Steam Web instance

Parameters:

Name Type Description

settings

object

Properties

Name	Type	Attributes	Default	Description
`apiKey`	string			The steam web API key, obtained from: http://steamcommunity.com/dev/apikey
`format`	string	<optional>	`json`	The format for the response [json, xml, vdf] - default: json

Methods

getAppList(obj)

Source:

steam.js, line 285

Gets a list of apps and their appid

Parameters:

Name	Type	Description
`obj`	object

getAssetClassInfo(obj)

Source:

steam.js, line 159

Gets class info for a specific game asset

Parameters:

Name	Type	Description
`obj`	object

getAssetPrices(obj)

Source:

steam.js, line 145

Gets the prices for items in a game

Parameters:

Name	Type	Description
`obj`	object

getBadges(obj)

Source:

steam.js, line 375

Gets a user's badges

Parameters:

Name	Type	Description
`obj`	object

getCommunityBadgeProgress(obj)

Source:

steam.js, line 388

Gets a user's progress towards a specific badge

Parameters:

Name	Type	Description
`obj`	object

getFriendList(obj)

Source:

steam.js, line 87

Gets a user's friend list

Parameters:

Name	Type	Description
`obj`	object

getGlobalAchievementPercentagesForApp(obj)

Source:

steam.js, line 56

Gets the global achievement percentages for a specific app

Parameters:

Name	Type	Description
`obj`	object

getGlobalStatsForGame(obj)

Source:

steam.js, line 222

Gets the global stats for a specific game

Parameters:

Name	Type	Description
`obj`	object

getNewsForApp(obj)

Source:

steam.js, line 43

Gets the news for a specific app

Parameters:

Name	Type	Description
`obj`	object

getNumberOfCurrentPlayers(obj)

Source:

steam.js, line 349

Gets the number of current players for a specific game

Parameters:

Name	Type	Description
`obj`	object

getOwnedGames(obj)

Source:

steam.js, line 100

Gets a user's owned games list

Parameters:

Name	Type	Description
`obj`	object

getPlayerAchievements(obj)

Source:

steam.js, line 182

Gets a user's achievements for a specific game

Parameters:

Name	Type	Description
`obj`	object

getPlayerBans(obj)

Source:

steam.js, line 269

Gets a list of bans for a specific user

Parameters:

Name	Type	Description
`obj`	object

getPlayerItems(obj)

Source:

steam.js, line 131

Gets a player's items for a specific game

This will work with TF2 and some other games but it no longer works with Counterstrike, valve has disabled the API See https://www.reddit.com/r/SteamBot/comments/5ztiv6/psa_api_method_shutdown_ieconitems/

Parameters:

Name	Type	Description
`obj`	object

getPlayerSummaries(obj)

Source:

steam.js, line 70

Gets the player summaries for a list of users

Parameters:

Name	Type	Description
`obj`	object

getRecentlyPlayedGames(obj)

Source:

steam.js, line 196

Gets a user's recently played games

Parameters:

Name	Type	Description
`obj`	object

getSchema(obj)

Source:

steam.js, line 113

Gets the item schema for a specific game

Parameters:

Name	Type	Description
`obj`	object

getSchemaForGame(obj)

Source:

steam.js, line 255

Gets a game's statistics schema

Parameters:

Name	Type	Description
`obj`	object

getSchemaURL(obj)

Source:

steam.js, line 421

Gets the schema URL for a specific game

Parameters:

Name	Type	Description
`obj`	object

getServerInfo(obj)

Source:

steam.js, line 401

Gets info on a specific server

Parameters:

Name	Type	Description
`obj`	object

getServersAtAddress(obj)

Source:

steam.js, line 295

Gets a list of servers at a specific address

Parameters:

Name	Type	Description
`obj`	object

getSteamLevel(obj)

Source:

steam.js, line 362

Gets a user's Steam level

Parameters:

Name	Type	Description
`obj`	object

getStoreMetadata(obj)

Source:

steam.js, line 435

Gets the store metadata for a specific game

Parameters:

Name	Type	Description
`obj`	object

getStoreStatus(obj)

Source:

steam.js, line 449

Gets the store status for a specific game (only TF2 currently supported)

Parameters:

Name	Type	Description
`obj`	object

getSupportedAPIList(obj)

Source:

steam.js, line 411

Gets a list of supported API endpoints

Parameters:

Name	Type	Description
`obj`	object

getUserGroupList(obj)

Source:

steam.js, line 323

Gets a user's group memberships

Parameters:

Name	Type	Description
`obj`	object

getUserStatsForGame(obj)

Source:

steam.js, line 209

Gets a user's stats for a specific game

Parameters:

Name	Type	Description
`obj`	object

isPlayingSharedGame(obj)

Source:

steam.js, line 242

Check if a user is playing a shared game

Parameters:

Name	Type	Description
`obj`	object

resolveVanityURL(obj)

Source:

steam.js, line 336

Resolves a specific vanity URL (seems to no longer work)

Parameters:

Name	Type	Description
`obj`	object

upToDateCheck(obj)

Source:

steam.js, line 308

Check if a specific version is the latest version of that game

Parameters:

Name	Type	Description
`obj`	object