Skip to content

API Reference / Steam friends

Get cached persona states

Return the cached persona snapshots (display name, online state, and current game) for the requested Steam users. Only users already observed by the account's session are returned.

POST/steam.v1.Steam/GetPersonaStates

Request body

application/jsonRequired

Request for the cached persona state of a set of Steam users, as observed by one account's session.

accountNamestring

Steam account whose session cache to read.

steamIds?array<string>

SteamIDs to look up. An id the worker has not yet observed is forwarded to Steam and omitted from the response until it is cached.

Response body

application/json

Success

personas?array<Persona>

Cached persona snapshots for the subset of requested SteamIDs already observed.

Show attributes
avatarHash?string

The user's raw Steam avatar hash. Used to derive the avatar image URL. Empty falls back to an initials placeholder.

Format"byte" base64

gameId?string

App id of the game the user is currently playing. Zero when not in a game.

Format"int64"

gameName?string

Name of the game the user is currently playing. Empty when not in a game.

observedAt?string

When this persona snapshot was last observed from Steam.

Format"date-time"

playerName?string

The user's current Steam display name.

state?integer

Raw Steam EPersonaState value for the user's online status.

Format"int32"

steamId?string

The user's 64-bit SteamID.

Format"int64"

steamLevel?integer

The user's Steam level. Zero until it has been observed. Steam_level_observed_at tells the two apart.

Format"int32"

steamLevelObservedAt?string

When steam_level was last read from Steam. Unset until the level has been observed.

Format"date-time"

curl -X POST "https://api.goldmine.to/steam.v1.Steam/GetPersonaStates" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "accountName": "trader_bot_01",
    "steamIds": [
      "76561198044443322",
      "76561198055554433"
    ]
  }'
{
  "personas": [
    {
      "steamId": "76561198044443322",
      "playerName": "BuyerOne",
      "state": 1,
      "gameId": "730",
      "gameName": "Counter-Strike 2",
      "observedAt": "2026-06-29T11:56:00Z"
    }
  ]
}