Difference between revisions of "WebAPI/GetPlayerSummaries"

From Team Fortress Wiki
Jump to: navigation, search
(Result data)
Line 17: Line 17:
 
::;profilestate: If set to 1 the user has configured the profile.
 
::;profilestate: If set to 1 the user has configured the profile.
 
::;personaname: User's display name.
 
::;personaname: User's display name.
::;lastlogoff: A unix timestamp of when the user was last online.
 
 
::;profileurl: The URL to the user's Steam Community profile.
 
::;profileurl: The URL to the user's Steam Community profile.
 
::;avatar: A 32x32 image
 
::;avatar: A 32x32 image

Revision as of 14:27, 5 February 2020

URL

http://api.steampowered.com/ISteamUser/GetPlayerSummaries/v0002/

Method-specific parameters

steamids
A comma-separated list of 64 bit IDs to retrieve profiles for.

Result data

response
players
A list of profile objects. Contained information varies depending on whether or not the user has their profile set to Friends only or Private.
steamid
The user's 64 bit ID
communityvisibilitystate
An integer that describes the access setting of the profile
1
Private
2
Friends only
3
Friends of Friends[1]
4
Users Only
5
Public
profilestate
If set to 1 the user has configured the profile.
personaname
User's display name.
profileurl
The URL to the user's Steam Community profile.
avatar
A 32x32 image
avatarmedium
A 64x64 image
avatarfull
A 184x184 image
personastate
The user's status
0
Offline (Also set when the profile is Private)
1
Online
2
Busy
3
Away
4
Snooze
5
Looking to trade
6
Looking to play
commentpermission (Optional)
If present the profile allows public comments.
realname (Optional)
The user's real name.
primaryclanid (Optional)
The 64 bit ID of the user's primary group.
timecreated (Optional)
A unix timestamp of the date the profile was created.
loccountrycode (Optional)
ISO 3166 code of where the user is located.
locstatecode (Optional)
Variable length code representing the state the user is located in.
loccityid (Optional)
An integer ID internal to Steam representing the user's city.
gameid (Optional)
If the user is in game this will be set to it's app ID as a string.
gameextrainfo (Optional)
The title of the game.
gameserverip (Optional)
The server URL given as an IP address and port number separated by a colon, this will not be present or set to "0.0.0.0:0" if none is available.

Notes

  1. Currently this value is also set for "Public" and "Users Only" profiles