Pho3niX90 / steamwebapi

A simplified wrapper for the steam web api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Main: [Coverage Badge]

Develop: [Coverage Badge]

steamwebapi

A simplified wrapper for the steam web api

This is a simple and lightweight wrapper for the steam web api. Created because the other options weren't simple enough for me.

Documentation

Installation

npm install @razr9/steamwebapi

or

yarn add @razr9/steamwebapi

Usage

const Steam = require('steamwebapi')
const api = new Steam(API_KEY_HERE)

const id = 76561198052893297 || 'cmdline' // You can use steamID64 or the vanity url

api.getPlayerSummary(id).then(data => {
  console.log(data)
})

Methods

resolveId(id) // resolves vanity url to steamID64
getNewsForApp(appid[,count = 3, maxLength = 300])
getGlobalAchievementPercentagesForApp(appid)
getGlobalStatsForGame(appid[,count = 1, achievements = []])
getPlayerSummary(id)
getOwnedGames(id [,include_free_games=false, include_appinfo=false])
getUserLevel(id)
getUserBadges(id)
getRecentlyPlayedGames(id)
getPlayerBans(id)
getPlayerAchievements(id, appid)
getUserStatsForGame(id, appid)
getFriendList(id)
isPlayingSharedGame(id, appid)
getSchemaForGame(appid)
getAppList()
getAppInfo(appid)
getNumberOfCurrentPlayers(appid)

More info: https://partner.steamgames.com/doc/webapi/

License

MIT

About

A simplified wrapper for the steam web api


Languages

Language:TypeScript 98.4%Language:JavaScript 1.6%