-
Notifications
You must be signed in to change notification settings - Fork 105
User
A section of the module dedicated to user-related objects, like SteamUser, SteamGroup and SteamUserBadge.
Initialise a new SteamUser object, associated with a user by their 64-bit Steam userid or their userurl ending (steamcommunity.com/id/userurl). Either of the two needs to be specified, but not both. If a URL ending is specifying, it will be resolved immediately.
avatar [lazy](Lazy Properties) • cached
Type: str
A URL to the user's 32px-sized profile avatar.
avatar_full [lazy](Lazy Properties) • cached
Type: str
A URL to the user's full-sized (184px right now) profile avatar.
avatar_medium [lazy](Lazy Properties) • cached
Type: str
A URL to the user's medium-sized (64px) profile avatar.
badges [lazy](Lazy Properties) • cached
Type: list of SteamUserBadge
A list of badges the user achieved, represented as SteamUserBadge objects.
country_code [lazy](Lazy Properties) • cached
Type: str
A ISO 3166 country code representing the user's selected country.
currently_playing [lazy](Lazy Properties) • cached
Type: SteamApp
The game this user is currently playing, if applicable, represented as a SteamApp object. Returns None if the user isn't in-game.
friends [lazy](Lazy Properties) • cached
Type: list of SteamUser
A Pythonic list of the user's friends, represented as individual SteamUser objects. If pre-caching is enabled, we pre-cache the user summaries (names, real names, avatars, etc.).
games [lazy](Lazy Properties) • cached
Type: list of SteamApp
This user's collection of games, represented as a list of SteamApp objects.
group [lazy](Lazy Properties) • cached
Type: SteamGroup
This user's primary group, represented as a SteamGroup object.
is_community_banned [lazy](Lazy Properties) • cached
Type: bool
A boolean value indicating whether the user is banned from Steam Community.
is_vac_banned [lazy](Lazy Properties) • cached
Type: bool
A boolean value indicating whether the user is VAC-banned.
last_logoff [lazy](Lazy Properties) • cached
Type: datetime
The last time this user logged off, represented as a datetime object.
level [lazy](Lazy Properties) • cached
Type: int
The user's current "level", decided by how many experience points (xp) [s]he has racked up so far from badges.
name [lazy](Lazy Properties) • permanently cached
Type: str
The user's public name, also known as "personaname" in API documentation. Lazily-retrieved along with other summary properties from the web API, unless this user was obtained through another user's friends property.
privacy [lazy](Lazy Properties) • cached
Type: int from enum Consts.CommunityVisibilityState
The user profile's current visibility setting. Returned as a value from an API-based enum CommunityVisibilityState.
profile_url [lazy](Lazy Properties) • cached
Type: str
A URL to the user's profile.
real_name [lazy](Lazy Properties) • permanently cached
Type: str
The user's publicly-displayed Real Name, if available.
recently_played [lazy](Lazy Properties) • cached
Type: list of SteamApp
A list of games the user played in the past two weeks.
state [lazy](Lazy Properties) • cached
Type: int from enum Consts.OnlineState
This user's current presence state. Returned as a value from an API-based enum Consts.OnlineState.
Type: int
The 64-bit Steam ID associated with this object.
time_created [lazy](Lazy Properties) • permanently cached
Type: datetime
When this user was registered.
xp [lazy](Lazy Properties) • cached
Type: int
The user's current experience count.
An object used to represent badges unlocked by a user. Usually obtained from SteamUser.badges. This object is fully-initialised and does not have any lazy properties.
Initialise a new SteamUserBadge object, identified by its badge_id, current level, the time (Unix timestamp or datetime.datetime object) at which it was unlocked (completion_time), its experience value and scarcity (how many users unlocked this badge). If it's a game badge, it can be linked to game by its appid. At this time
Type: int or NoneType
The Steam app ID linked to this badge, if it's a game badge. None otherwise.
Type: int
The badge's ID. Not the unique instance ID, but an ID to identify the badge itself. At this time, badge IDs are not known but the following was observed:
Badge ID 1 is used for the "Years of Service" badge, but also for all game badges. However, game badges contain an appid while the rest (and "Years of Service") do not. If you browse user badges are browsed on <steamcommunity.com>, you can see the badge ID in the URL is either the appid if the badge is linked to a game, or the badge_id if it has no associated appid.
Type: datetime.datetime
When this badge was unlocked.
Type: int
Usually appid, unless this badge has no associated appid, in which case it will be badge_id.
Type: int
This badge's current level. Usually ranges from 1 through 5, except for Foil badges which have only one level. At this time, there's no way to tell a foil badge and a regular badge apart.
Type: int
How rare this badge is. Expressed as an amount of how many people have unlocked it.
Type: int
The amount of experience this badge adds to the user's total experience count.