Steam.getFriendList()

Returns the friend list of any Steam user, provided his Steam Community profile visibility is set to "Public".

Usage

Hover over inputs/exits for more info.

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


// Returns the friend list of any Steam user, provided his Steam Community profile visibility is set to "Public".

Steam.getFriendList({

steamid: '76561197960435530',

key: 'XXXXXXXXXXXXXXXXXXXXXXX',

relationship: 'friend',

}).exec({

// An unexpected error occurred.

error: function (err) {

 

},

// OK.

success: function (result) {

 

},

});

Inputs

steamid required

64 bit Steam ID to return friend list for.

'76561197960435530'
key required

Steam API Key

'XXXXXXXXXXXXXXXXXXXXXXX'
relationship

Relationship filter. Possibles values: all, friend.

'friend'

Exits

error

An unexpected error occurred.

success

OK.

{ friendslist: 
   { friends: 
      [ { steamid: '76561197960265731',
          relationship: 'friend',
          friend_since: 0 } ] } }