Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thunbergolle/steamgroupstats

Get the stats of a group.
https://github.com/thunbergolle/steamgroupstats

get-group-members get-group-stats get-stat-of-a-steamgroup get-steamgoups groupmembers node-steam steam steam-group steam-group-stats steam-stats steamgroups steamgroupstats steamstats

Last synced: about 1 month ago
JSON representation

Get the stats of a group.

Awesome Lists containing this project

README

        

# Steam-groups
This is an easy to use module that gets all the members from a steamgroup and outputs them as an object.
This module was made and published by [OlleThunberg](https://github.com/ThunbergOlle).
If you are looking for only getting the steamids of the members then check out [this](https://www.npmjs.com/package/node-steam-group) module.

**Contribute:**[Github](https://github.com/ThunbergOlle/steamgroupstats)

**Install**
```js
npm install steam-group-stats --save
```
**Import**
```js
const steamgroup = require('steam-group-stats');
```

## Methods
```js
steamgroup.getstats("unturnedgametrade", function(err, callback){});
```
- callback.id: Gets the id of the group.
- callback.totalmembers: Gets the total amount of members of the group.
- callback.name: Gets the name of the steamgroup. (Not the URL)
- callback.headline: Gets the headline of the steamgroup.
- callback.icon: Gets the avatar icon URL of the steamgroup.
- callback.online: Gets the current amount of members that's online.
- callback.ingame: Gets the current amount of members that's in game.
- callback.inchat: Gets the current amount of members that's in chat.
#### Example in JS format
```js
steamgroup.getstats("unturnedgametrade", function(err, callback){
console.log(callback.id);
console.log(callback.name);
console.log(callback.headline);
//And so on.
});
```

## Examples
**You can copy and paste these!**

### Get all info about group
```js
steamgroup.getstats("unturnedgametrade", function(err, group){
if(err) throw err;
console.log(group);
});
```

**Output**
```
{ totalmembers: [ '22' ],
id: [ '103582791460358474' ],
groupdetails:
{ groupName: [ 'UnturnedGame.com' ],
groupURL: [ 'unturnedgametrade' ],
headline: [ ' Giveaways and Community Group!' ],
summary: [ '