npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

steam-webapi

v0.6.5

Published

Steam WebAPI wrapper

Downloads

551

Readme

Steam WebAPI library for node.js

Supports Node v0.8.26 (or newer) but might work on older versions

A Steam API Key is needed for many of the methods in the API and is a requirement for this library.

All the methods are created at runtime (available after Steam.ready, which retrieves the API methods), rather than compile-time, so this should theoretically support all (existing and future) Steam API methods. No need to worry about calling the correct API version, as it will always be the latest. If you must use a different version simply pass in a {'version': x} option into a method.

List of methods

To install:

npm install steam-webapi

Example

var Steam = require('steam-webapi');

// Set global Steam API Key
Steam.key = "YOUR API KEY";

Steam.ready(function(err) {
    if (err) return console.log(err);

    var steam = new Steam();

    // Retrieve the steam ID from a steam username/communityID
    steam.resolveVanityURL({vanityurl:'jonbo'}, function(err, data) {
        console.log(data);
        // data -> { steamid: '76561197968620915', success: 1 }

        // Get the Player's TF2 Backpack items
        data.gameid = Steam.TF2;

        // getPlayerItems requires { gameid, steamid }
        steam.getPlayerItems(data, function (err, data) {
            console.log(data);
            // data -> { status: 1, num_backpack_slots: 1100, items: [...], ...}

        });
    });

});

Example with generators and promises

// Requires node 0.11+ and "node --harmony"

var Steam = require('steam-webapi');
var Promise = require('bluebird');

// Set global Steam API Key
Steam.key = "YOUR API KEY";

Steam.ready(Promise.coroutine(function*(err) {
    if (err) return console.log(err);

    // Creates an promise wielding function for every method (with Async attached at the end)
    Promise.promisifyAll(Steam.prototype);

    var steam = new Steam();

    // Retrieve the steam ID from a steam username/communityID
    var data = yield steam.resolveVanityURLAsync({vanityurl:'jonbo'});
    console.log(data);
    // data -> { steamid: '76561197968620915', success: 1 }

    // Get the Player's TF2 Backpack items
    data.gameid = Steam.TF2;
    data = yield steam.getPlayerItemsAsync(data);
    console.log(data);
    // data -> { status: 1, num_backpack_slots: 1100, items: [...], ...}

}));

If you plan on only using this for TF2 data only (or just want to default to it), the first example can be rewritten.

var steam = new Steam({gameid: Steam.TF2, appid:Steam.TF2});

steam.resolveVanityURL({vanityurl:'jonbo'}, function(err, data) {

    // No need for data.gameid = Steam.TF2; here

    steam.getPlayerItems(data, function (err, data) {
        console.log(data);
        // data -> { status: 1, num_backpack_slots: 1100, items: [...], ...}
    });
});

It works the same for 'key' and other fields.

Tests

$ npm run test

License

MIT