Skip to content

API Reference / Steam friends

Get an account's Steam friends

Return the most recently cached snapshot of a Steam account's friends list, including each friend's relationship status. The data reflects the live session cache and is returned without contacting Steam.

POST/steam.v1.Steam/GetFriendsList

Request body

application/jsonRequired

Request for an account's cached friends list. Does not contact Steam.

accountNamestring

Steam account name whose friends list to read.

Response body

application/json

Success

friendsList?FriendsList

The account's current friends-list snapshot.

Show attributes
accountName?string

The Steam account this friends list belongs to.

friends?array<Friend>

Every friend and pending invitation currently observed for the account.

Show attributes
relationship?integer

Raw Steam EFriendRelationship value. Callers distinguish pending invitations from established friends based on this value.

Format"int32"

steamId?string

The friend's 64-bit SteamID.

Format"int64"

observedAt?string

When this snapshot was last observed from Steam.

Format"date-time"

workspaceId?string

Workspace the account belongs to.

Format"byte" base64

curl -X POST "https://api.goldmine.to/steam.v1.Steam/GetFriendsList" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "accountName": "trader_bot_01"
  }'
{
  "friendsList": {
    "accountName": "trader_bot_01",
    "workspaceId": "AY86PB0ufwCKGyw9Tl9gcQ==",
    "friends": [
      {
        "steamId": "76561198044443322",
        "relationship": 3
      }
    ],
    "observedAt": "2026-06-29T11:55:00Z"
  }
}