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

hitbox-api

v0.0.8

Published

A package that helps the user easily work with the hitbox.tv API.

Downloads

24

Readme

Node.js hitbox.tv API.

Firstly, enter this line at the top of the document, replacing "hb" with whatever you like:

	var hb = require("hitbox-api");

media - (callback) - Returns all the currently live users.

	hb.media(function(err, res, data){
		console.log(data);
	});

mediaUser - (username, callback) - Returns detailed stream information about the given username.

	hb.mediaUser("GamingTom", function(err, res, data){
		console.log(data);
	});

mediaFollowing - (username, callback) - Returns a list of all the currently live people the given username is following.

	hb.mediaFollowing("GamingTom", function(err, res, data){
		console.log(data);
	});

user - (username, callback) - Returns general information about the given username.

	hb.user("GamingTom", function(err, res, data){
		console.log(data);
	});

followers - (username, offset, limit, callback) - Returns a list of the people following the given username.

	hb.followers("GamingTom", "0", "20", function(err, res, data){
		console.log(data);
	});

games - (callback) - Returns a list of all the currently played games, sorted by view count.

	hb.games(function(err, res, data){
		console.log(data);
	});

teams - (callback) - Returns a list of all created teams. (May not work because of the huge amounts of results.)

	hb.teams(function(err, res, data){
		console.log(data);
	});

team - (team, callback) - Returns detailed information about the given team.

	hb.team("hitbox", function(err, res, data){
		console.log(data);
	});

##Example usage: Here is an example to get a list of the people you are following who are live.

hb.mediaFollowing("GamingTom", function(err, res, data){
	if (err == "err01"){
		console.log(err + " - Username does not exist or is not activated.");
	}
	else if (err == "err02"){
		console.log(err + " - No streams online.");
	}
	else if (! err){
		for (var i = 0; i < data.livestream.length; i++) {
			console.log(i+1 + ". - " + data.livestream[i].media_user_name + " - " + data.livestream[i].media_views + " Viewers - " + data.livestream[i].media_status);
		};
	};
});

##Error codes:

  • err01 - Username does not exist or is not yet activated.
  • err02 - No followed streamers are currenty online.