steam-user
Advanced tools
SteamUser is a handler module for node-steam version 1.0.0 or greater.
It's designed to be a self-contained module which provides all the functionality expected of a Steam user client, with a few exceptions:
There are a number of options which can control the behavior of the SteamUser object. They are:
Controls where the Steam server list and sentry files are written.
Defaults to a platform-specific user data directory.
%localappdata%\doctormckay\node-steamuser~/Library/Application Support/node-steamuser$XDG_DATA_HOME/node-steamuser, or ~/.local/share/node-steamuser if $XDG_DATA_HOME isn't defined or is emptyA boolean which controls whether or not SteamUser will automatically reconnect to Steam if disconnected for any reason (except an explicit logoff).
Defaults to true.
A boolean which controls whether or not SteamUser will use a single sentry file for all accounts.
If off, a file named sentry.accountname.bin will be saved for each account.
If on, a file named sentry.bin will be used for all accounts.
Defaults to false.
A boolean which controls whether or not SteamUser will automatically prompt for Steam Guard codes when necessary from stdin.
Defaults to true.
The SteamClient which is being used to communicate with Steam.
null if not connected, a SteamID containing your SteamID otherwise.
An object containing options for this SteamUser. Read-only, use setOption or setOptions to change an option.
An object containing information about your account's email address. null until emailInfo is emitted.
address - Your email addressvalidated - true if your email is validated, false if notAn object containing information about your account's limitations. null until accountLimitations is emitted.
limited - true if your account is limited, false if notcommunityBanned - true if your account is banned from Steam Community, false if notlocked - true if your account is locked, false if not (accounts can also be locked by Support)canInviteFriends - true if your account can invite friends, false if notAn object containing information about your Steam Wallet. null until wallet is emitted.
hasWallet - true if your account has a Steam Wallet, false if notcurrency - The ID of your wallet's currencybalance - Your account's wallet balance, in the lowest currency denomination (e.g. USD cents)An array containing license data for the packages which your Steam account owns. null until licenses is emitted.
client - An optional SteamClient to use to connect to Steam. If not provided, one will be created automatically.options - An optional object containing zero or more options to set for this SteamUser.Constructs a new SteamUser. If you allow SteamUser to create its own SteamClient, then SteamUser will automatically save and reload the CM server list.
option - The name of the option to setvalue - The value to set for this optionChanges the value of an option.
options - An object containing zero or more options.details - An object containing details for this logon
accountName - If logging into a user account, the account's namepassword - If logging into an account without a login key, the account's passwordloginKey - If logging into an account with a login key, this is the account's login keyrememberPassword - true if you want to get a login key which can be used in lieu of a password for subsequent logins. false or omitted otherwise.Logs onto Steam. The SteamClient should not be connected. Omit the details object if you wish to login to an anonymous user account.
Logs you off of Steam and closes the connection.
SteamUser will automatically log onto steamcommunity.com when a successful connection to Steam is established (as an individual user), but you can call webLogOn() to create a new session if your old one expires or becomes invalid.
Listen for the webSession event to get your cookies.
apps - An array, object, string, or number (see below)
Reports to Steam that you're playing or using zero or more games/apps. To exit all games/apps, use an empty array [].
To play a single game by AppID, use a single integer (e.g. 440)
To play a single non-Steam game by name, use a single string (e.g. "Minecraft")
To play a single game by AppID and name (the client-provided name is what is given to the WebAPI and mobile app), use an object of this format:
{
"game_id": 440,
"game_extra_info": "Team Fortress 2"
}
You can use multiple apps by providing an array of any mixture of the above formats.
appid - The AppID of the app for which you'd like the current player/user count (use 0 to get current logged-in Steam user count)callback - Called when the requested data is available
result - A value from Steam.EResultplayers - How many Steam users are currently playing/using the appRequests a count of how many Steam users are currently playing/using an app.
conditions - A filter string or an object containing one or more of the following properties:
app_id - The AppID of the game for which you want serversgeo_location_ip - The IP address of the querying client, used for geolocation (in x.x.x.x format)region_code - The region code where you want serversfilter_text - A filter stringmax_servers - Maximum number of servers to return in this response (default and hard limit 5000)callback - Called when the response is available
err - If an error occurred, this is an Error object. Otherwise, it's null.servers - An array of objects containing server data
ip - The server's IP in x.x.x.x formatport - The server's game portplayers - How many authenticated players are on this server (the Steam server browser will use this value if the gameserver itself reports more players and doesn't report itself as full, to prevent inflated player counts)Requests a list of game servers from the master server.
filter - A master server filter stringlimit - How many servers should be returned, at maximum. Hard limit is 5000.callback - Called when the requested data is available
servers - An array of objects containing server data
addr - The server's IP address in x.x.x.x:p formatgameport - The port the server is running on for game clientsspecport - The port the server is running on for spectator clients (null for none)steamid - A SteamID object containing the server's SteamIDname - The server's hostnameappid - The AppID of the game which the server is servinggamedir - The directory of the game which the server is servingversion - The version of the game which the server is servingproduct - The product name of the game which the server is servingregion - The region code for where the server is locatedplayers - How many people are currently on this servermax_players - How many people can be on the server at oncebots - How many CPU players are currently on this servermap - The name of the map which the server is currently runningsecure - true if the server is VAC-secure, false if notdedicated - true if the server is dedicated, false if listenos - w if the server is running on Windows, l for Linuxgametype - The server's tags, separated by commasWorks when anonymous. Requests a list gameservers from Steam matching a given filter, along with information about the server as Steam knows it.
ips - An array of IP addresses, in x.x.x.x:p formatcallback - Called when requested data is available
servers - An object whose keys are IP addresses in x.x.x.x:p format and values are SteamID objectsWorks when anonymous. Gets current SteamIDs for servers running on given addresses.
steamids - An array of SteamID objects, or something which can parse into one (64-bit SteamID as string, Steam3 rendered format)callback - Called when requested data is available
servers - An object whose keys are 64-bit numeric SteamIDs and values are IP addresses in x.x.x.x:p formatWorks when anonymous. Gets current IP addresses for servers with given SteamIDs.
sinceChangenumber - The changenumber of the last known changelist. You will get changes which have occurred since then and now. Use 1 to request all changes ever.callback - Called when data is available
currentChangenumber - The changenumber of the newest changelistapps - An array of objects for apps which have changed. Each object has these properties:
appid - The AppID of the appchange_number - The changenumber of the latest changelist in which the app has changedneeds_token - true if you need an access token to get most details about this app, null if notpackages - An array of objects for packages which have changed. Each object has the same properties as the apps array, except appid is packageid.Works when anonymous. Requests a list of all apps/packages which have changed since a given changenumber.
apps - Either an array of AppIDs, or an array of objects containing appid and access_token propertiespackages - Either an array of PackageIDs, or an array of objects containing packageid and access_token propertiescallback - Called when requested data is available
apps - An object whose keys are AppIDs and whose values are objects
changenumber - The changenumber of the latest changelist in which this app changedmissingToken - true if you need to provide an access token to get more details about this appappinfo - An object whose structure is identical to the output of app_info_print in the Steam consolepackages - An object whose keys are PackageIDs and whose values are objects. Each object has the same properties as the apps array, except appinfo is packageinfo.unknownApps - An array of input AppIDs which don't existunknownPackages - An array of input PackageIDs which don't existWorks when anonymous. Requests details about one or more apps or packages.
apps - An array of AppIDspackages - An array of PackageIDscallback - Called when requested data is available
apps - An object whose keys are AppIDs and whose values are access tokenspackages - An object whose keys are PackageIDs and whose values are access tokensappDeniedTokens - An array of AppIDs for which Steam denied you an access tokenpackageDeniedTokens - An array of PackageIDs for which Steam denied you an access tokenWorks when anonymous. Requests access tokens for one or more apps or packages. These access tokens can be used with getProductInfo.
Access tokens are global. That is, everyone who has access to an app receives the same token. Tokens do not seem to expire.
details - An object containing various details about your account (see CMsgClientLogonResponse)Emitted when you're successfully logged into Steam.
domain - If an email code is needed, the domain name of the address where the email was sent. null if an app code is needed.callback - Should be called when the code is available.
code - The Steam Guard auth codeIf the promptSteamGuardCode option is disabled, this event will be emitted when Steam requests a Steam Guard code from us. You should collect the code from the user somehow and then call the callback with the code as the sole argument.
Example:
user.on('steamGuard', function(domain, callback) {
console.log("Steam Guard code needed from email ending in " + domain);
var code = getCodeSomehow();
callback(code);
});
e - An Error objectEmitted when an error occurs during logon. If this event isn't handled, the program will crash.
The Error object will have an eresult parameter which is a value from the EResult enum.
sessionID - The value of the sessionid cookiecookies - An array of cookies, as name=value stringsEmitted when a steamcommunity.com web session is successfully negotiated. This will automatically be emitted on logon and in response to webLogOn calls.
Some libraries require you to provide your sessionID, others don't. If your library doesn't, you can safely ignore it.
key - Your login keyIf you enabled rememberPassword in logOn, this will be emitted when Steam sends us a new login key. This key can be passed to logOn as loginKey in lieu of a password on subsequent logins.
At this time, I'm not sure if login keys expire, so to be safe you should record this somewhere (in a database, in a file, etc) and overwrite it every time the event is emitted.
count - How many new items you have (can be 0)Emitted when Steam sends a notification of new items. You can reset the count to 0 by loading your inventory page (https://steamcommunity.com/my/inventory) while logged in.
count - How many total new comments you have (can be 0)myItems - How many of the total comments are on your content (workshop items, screenshots, your profile, etc.)discussions - How many of the total comments are posts in subscribed discussion threadsEmitted when Steam sends a notification of new comments.
count - How many active received trade offers you have (can be 0)Emitted when Steam sends a notification of new trade offers.
count - How many unread offline chat messages you havefriends - An array of SteamID strings for the users who have sent you unread offline chat messagesEmitted when Steam sends a notification of unread offline chat messages. This will always be emitted after logon, even if you have no messages.
address - Your account's email addressvalidated - A boolean value for whether or not your email address is validatedEmitted on logon and when email info changes. The emailInfo property will be updated after this event is emitted.
limited - true if your account is limited, false if notcommunityBanned - true if your account is banned from Steam Community, false if notlocked - true if your account is locked, false if not (accounts can also be locked by Support)canInviteFriends - true if your account can invite friends, false if notEmitted on logon and probably when limitations change. The limitations property will be updated after this event is emitted.
hasWallet - true if your account has a Steam Wallet, false if notcurrency - The currency ID of your account's walletbalance - Your account's current wallet balance in the lowest currency denomination (e.g. USD cents)Emitted on logon and when wallet balance changes. The wallet property will be updated after this event is emitted.
licenses - An array of licensesContains the license data for the packages which your Steam account owns. To see license object structure, see CMsgClientLicenseList.License.
Emitted on logon and when licenses change. The licenses property will be updated after this event is emitted.
This isn't emitted for anonymous accounts. However, all anonymous user accounts have a license for package 17906 automatically.
FAQs
Steam client for Individual and AnonUser Steam account types
The npm package steam-user receives a total of 5,257 weekly downloads. As such, steam-user popularity was classified as popular.
We found that steam-user demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.