npm i steamapi
Once signed into Steam, head over to http://steamcommunity.com/dev/apikey to generate an API key.
First, we start by making a SteamAPI "user".
const SteamAPI = require('steamapi');
const steam = new SteamAPI('steam token');
Now, we can call methods on the steam object.
For example, let's retrieve the SteamID64 of a user. SteamAPI provides a resolve method, which accepts URLs and IDs.
steam.resolve('https://steamcommunity.com/id/DimGG').then(id => {
console.log(id); // 76561198146931523
});
Now let's take that ID, and fetch the user's profile.
steam.getUserSummary('76561198146931523').then(summary => {
console.log(summary);
/**
PlayerSummary {
avatar: {
small: 'https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/7f/7fdf55394eb5765ef6f7be3b1d9f834fa9c824e8.jpg',
medium: 'https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/7f/7fdf55394eb5765ef6f7be3b1d9f834fa9c824e8_medium.jpg',
large: 'https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/7f/7fdf55394eb5765ef6f7be3b1d9f834fa9c824e8_full.jpg'
},
steamID: '76561198146931523',
url: 'http://steamcommunity.com/id/DimGG/',
created: 1406393110,
lastLogOff: 1517725233,
nickname: 'Dim',
primaryGroupID: '103582791457347196',
personaState: 1,
personaStateFlags: 0,
commentPermission: 1,
visibilityState: 3
}
*/
});
Kind: global class
Promise.<Object>Promise.<string>Promise.<Array.<App>>Promise.<Array.<Object>>Promise.<Object>Promise.<Object>Promise.<Object>Promise.<Array.<Object>>Promise.<number>Promise.<Object>Promise.<Array.<Server>>Promise.<PlayerAchievements>Promise.<PlayerBadges>Promise.<(PlayerBans|Array.<PlayerBans>)>Promise.<Array.<Friend>>Promise.<Array.<string>>Promise.<number>Promise.<Array.<Game>>Promise.<Array.<RecentGame>>Promise.<PlayerServers>Promise.<PlayerStats>Promise.<PlayerSummary>Sets Steam key for future use.
| Param | Type | Default | Description |
|---|---|---|---|
| key | string | Steam key | |
| [options] | Object | {} | Optional options for caching and warnings getGameDetails() |
| [options.enabled] | boolean | true | Whether caching is enabled |
| [options.expires] | number | 86400000 | How long cache should last for in ms (1 day by default) |
| [options.disableWarnings] | boolean | false | Whether to suppress warnings |
Promise.<Object>Get custom path that isn't in SteamAPI.
Kind: instance method of SteamAPI
Returns: Promise.<Object> - JSON Response
| Param | Type | Default | Description |
|---|---|---|---|
| path | string | Path to request e.g '/IPlayerService/GetOwnedGames/v1?steamid=76561198378422474' | |
| [base] | string | "this.baseAPI" | Base URL |
| [key] | string | "this.key" | The key to use |
Promise.<string>Resolve info based on id, profile, or url. Rejects promise if a profile couldn't be resolved.
Kind: instance method of SteamAPI
Returns: Promise.<string> - Profile ID
| Param | Type | Description |
|---|---|---|
| info | string | Something to resolve e.g 'https://steamcommunity.com/id/xDim' |
Promise.<Array.<App>>Get every single app on steam.
Kind: instance method of SteamAPI
Returns: Promise.<Array.<App>> - Array of apps
Promise.<Array.<Object>>Get featured categories on the steam store.
Kind: instance method of SteamAPI
Returns: Promise.<Array.<Object>> - Featured categories
Promise.<Object>Get featured games on the steam store
Kind: instance method of SteamAPI
Returns: Promise.<Object> - Featured games
Promise.<Object>Get achievements for app id.
Kind: instance method of SteamAPI
Returns: Promise.<Object> - App achievements for ID
| Param | Type | Description |
|---|---|---|
| app | string | App ID |
Promise.<Object>Get details for app id. Requests for this endpoint are limited to 200 every 5 minutes
Kind: instance method of SteamAPI
Returns: Promise.<Object> - App details for ID
| Param | Type | Default | Description |
|---|---|---|---|
| app | string | App ID | |
| [force] | boolean | false | Overwrite cache |
Promise.<Array.<Object>>Get news for app id.
Kind: instance method of SteamAPI
Returns: Promise.<Array.<Object>> - App news for ID
| Param | Type | Description |
|---|---|---|
| app | string | App ID |
Promise.<number>Get number of current players for app id.
Kind: instance method of SteamAPI
Returns: Promise.<number> - Number of players
| Param | Type | Description |
|---|---|---|
| app | string | App ID |
Promise.<Object>Get schema for app id.
Kind: instance method of SteamAPI
Returns: Promise.<Object> - Schema
| Param | Type | Description |
|---|---|---|
| app | string | App ID |
Promise.<Array.<Server>>Get every server associated with host.
Kind: instance method of SteamAPI
Returns: Promise.<Array.<Server>> - Server info
| Param | Type | Description |
|---|---|---|
| host | string | Host to request |
Promise.<PlayerAchievements>Get users achievements for app id.
Kind: instance method of SteamAPI
Returns: Promise.<PlayerAchievements> - Achievements
| Param | Type | Description |
|---|---|---|
| id | string | User ID |
| app | string | App ID |
Promise.<PlayerBadges>Get users badges.
Kind: instance method of SteamAPI
Returns: Promise.<PlayerBadges> - Badges
| Param | Type | Description |
|---|---|---|
| id | string | User ID |
Promise.<(PlayerBans|Array.<PlayerBans>)>Get users bans.
Kind: instance method of SteamAPI
Returns: Promise.<(PlayerBans|Array.<PlayerBans>)> - Ban info
| Param | Type | Description |
|---|---|---|
| id | string | Array.<string> | User ID(s) |
Promise.<Array.<Friend>>Get users friends.
Kind: instance method of SteamAPI
Returns: Promise.<Array.<Friend>> - Friends
| Param | Type | Description |
|---|---|---|
| id | string | User ID |
Promise.<Array.<string>>Get users groups.
Kind: instance method of SteamAPI
Returns: Promise.<Array.<string>> - Groups
| Param | Type | Description |
|---|---|---|
| id | string | User ID |
Promise.<number>Get users level.
Kind: instance method of SteamAPI
Returns: Promise.<number> - Level
| Param | Type | Description |
|---|---|---|
| id | string | User ID |
Promise.<Array.<Game>>Get users owned games.
Kind: instance method of SteamAPI
Returns: Promise.<Array.<Game>> - Owned games
| Param | Type | Description |
|---|---|---|
| id | string | User ID |
Promise.<Array.<RecentGame>>Get users recent games.
Kind: instance method of SteamAPI
Returns: Promise.<Array.<RecentGame>> - Recent games
| Param | Type | Description |
|---|---|---|
| id | string | User ID |
Promise.<PlayerServers>Gets servers on steamcommunity.com/dev/managegameservers using your key or provided key.
Kind: instance method of SteamAPI
Returns: Promise.<PlayerServers> - Servers
| Param | Type | Default | Description |
|---|---|---|---|
| [hide] | boolean | false | Hide deleted/expired servers |
| [key] | string | "this.key" | Key |
Promise.<PlayerStats>Get users stats for app id.
Kind: instance method of SteamAPI
Returns: Promise.<PlayerStats> - Stats for app id
| Param | Type | Description |
|---|---|---|
| id | string | User ID |
| app | string | App ID |
Promise.<PlayerSummary>Get users summary.
Kind: instance method of SteamAPI
Returns: Promise.<PlayerSummary> - Summary
| Param | Type | Description |
|---|---|---|
| id | string | User ID |
FAQs
A nice Steam API wrapper.
The npm package steamapi receives a total of 503 weekly downloads. As such, steamapi popularity was classified as not popular.
We found that steamapi 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
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.
Security News
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.