get_player_summaries: Get Player Summaries

Description Usage Arguments Value Returns

View source: R/get-player-summaries.R

Description

Get basic profile information for a list of 64-bit Steam ID's.

Usage

1
get_player_summaries(steam_key, steam64_ids = c())

Arguments

steam_key

A Steam Web API Key.

steam64_ids

A vector of 64-bit Steam ID's. Up to 100 Steam IDs can be requested.

Value

Basic profile information for a list of Steam ID's.

Some data associated with a Steam account may be hidden if the user has their profile visibility set to "Friends Only" or "Private". In that case, only public data will be returned.

Returns

Each item in the resulting list contains:

Public Data:

steamid

The user's 64-bit SteamID

personaname

The user's display name

profileurl

The full URL of the users's Steam Community profile

avatar

The full URL of the users's 32x32px avatar. If the user hasn't configured an avatar, this will be the default ? avatar.

avatarmedium

The full URL of the users's 64x64px avatar. If the user hasn't configured an avatar, this will be the default ? avatar.

avatarfull

The full URL of the users's 184x184px avatar. If the user hasn't configured an avatar, this will be the default ? avatar.

personastate

The user's current status. 0 = Offline, 1 = Online, 2 = Busy, 3 = Away, 4 = Snooze, 5 = looking to trade, 6 = looking to play. If the player's profile is private, this will always be 0

communityvisibilitystate

This represents whether the profile is visible or not, and if it is visible, why you are allowed to see it. 1 = the profile is not visible to you (private, friends only, etc.), 3 = the profile is public.

profilestate

1 = the user has a community profile configured, 0 = the user has not configured a community profile.

lastlogoff

A UNIX timestamp representing the last time the user was online.

commentpermission

If set, indicates the profile allows public comments.

Private Data:

realname

If set, the user's real name

primaryclanid

The users's primary group, as configured in their Steam Community profile

timecreated

A UNIX timestamp representing the time the player's account was created.

gameid

If the user is currently in-game, this value will be return the gameid of that game.

gameserverip

The ip and port of the game server the user is currently playing on, if they are playing on-line in a game using Steam matchmaking. Otherwise will be set to "0.0.0.0:0".

gameextrainfo

If the user is currently in-game, this will be the name of the game they are playing. This may be the name of a non-Steam game shortcut.

loccityid

An internal code indicating the user's city of residence.

loccountrycode

If set in the user's Steam Community profile, the user's country of residence - a 2-character ISO country code.

locstatecode

If set in the user's Steam Community profile, the user's state of residence.


josegallegos07/steamR documentation built on May 19, 2019, 8:48 p.m.