Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/whitlocktech/steam-api-wrapper
Steam API wrapper
https://github.com/whitlocktech/steam-api-wrapper
javascript nodejs steam
Last synced: 1 day ago
JSON representation
Steam API wrapper
- Host: GitHub
- URL: https://github.com/whitlocktech/steam-api-wrapper
- Owner: whitlocktech
- License: mit
- Created: 2023-04-27T17:41:47.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-28T03:07:01.000Z (2 months ago)
- Last Synced: 2024-12-28T04:43:11.895Z (about 1 month ago)
- Topics: javascript, nodejs, steam
- Language: JavaScript
- Homepage:
- Size: 276 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## README
[]
(https://snyk.io/test/github/whitlocktech/steam-api-wrapper)
This is a wrapper for the steam api. I am working to add more functionality to it.
The getMultipeProfiles function is currently non operational. Other functions might retrun an error if the user has a private profile
To Add it to your project
npm i @whitlocktech/steam-api-wrapper
```javascript
const {
getProfile,
getMultipleProfiles,
} = require("@whitlocktech/steam-api-wwrapper");
```
Both functions require you to pass the steamApiKey you get from steam.
### getProfile()
```javascript
getProfile(steamApiKey, steamId);
```
steamId is the 64bit steam id of the user profile that you wish to obtain
### getMultipleProfiles()
```javascript
getMultipleProfiles(steamApiKey, steamIds);
```
steamIds is passed in as an array. The function will join and then request multiple user profiles.
```javascript
getNewsForApp(appId, count, maxLength);
```
You must pass in the appId which is the id that steam uses to identify games, the count of the articles, and the maxLength of characters for the articles.
count defaults to 3 if not passed in
maxLength defaults to 300
```javascript
getGlobalAchievementPercentageForApp(appId);
```
appId is the id used by steam for apps. It will return the global percentages of
acheivemnts
```javascript
getFriendList(steaApiKey, steamId);
```
Requires your steam API key and the 64bit steamId of the person you wish to get the friends list of
```javascript
getPlayerAchievements(appId, steamApiKey, steamId);
```
This is a v0001 api call maybe deperacated in the future
get the achievements for a single user for specific game
Requires appId = steam app id
steamApiKey your steam api key
64bit steamId of the user you are targeting
```javascript
getUserStatsForGame(appId, steamApiKey, steamId);
```
This returns the same data and has the same getPlayerAchievements function but it is the v0002(current) steam api call
```javascript
getOwnedGames(steamApiKey, steamId);
```
This get the owned games list of the targeted player
requires your steam api key, and the 64bit steam id of the player you are targeting.