Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/steamy/Steam/api/getPlayerSummaries.ts>getPlayerSummaries_ResultPublic

Steamy is a library made to help interact with Valve's REST APIs for their various games and services by providing easy asynchronous functions to call them, along with a key manager, and type checking to boot.
Latest
interface getPlayerSummaries_ResultPublic
import { type getPlayerSummaries_ResultPublic } from "https://deno.land/x/steamy@v0.05a/Steam/api/getPlayerSummaries.ts";

Properties

steamid: string

64bit SteamID of the user

personaname: string

The player's persona name (display name)

profileurl: string

The full URL of the player's Steam Community profile.

avatar: string

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

avatarmedium: string

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

avatarfull: string

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

personastate: 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", except is the user has set their status to looking to trade or looking to play, because a bug makes those status appear even if the profile is private.

communityvisibilitystate: CommunityVisibilityState

This represents whether the profile is visible or not, and if it is visible, why you are allowed to see it. Note that because this WebAPI does not use authentication, there are only two possible values returned: 1 - the profile is not visible to you (Private, Friends Only, etc), 3 - the profile is "Public", and the data is visible. Mike Blaszczak's post on Steam forums says, "The community visibility state this API returns is different than the privacy state. It's the effective visibility state from the account making the request to the account being viewed given the requesting account's relationship to the viewed account."

profilestate: ProfileState

If set, indicates the user has a community profile configured (will be set to '1')

lastlogoff: number

The last time the user was online, in unix time.

commentpermission: number

If set, indicates the profile allows public comments.