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.
/ steam. v1. Steam/ GetFriendsListRequest body
application/jsonRequired
Request for an account's cached friends list. Does not contact Steam.
accountNamestringSteam account name whose friends list to read.
Response body
application/json
Success
friendsList?FriendsListThe account's current friends-list snapshot.
Show attributes
accountName?stringThe Steam account this friends list belongs to.
friends?array<Friend>Every friend and pending invitation currently observed for the account.
Show attributes
relationship?integerRaw Steam EFriendRelationship value. Callers distinguish pending invitations from established friends based on this value.
Format"int32"
steamId?stringThe friend's 64-bit SteamID.
Format"int64"
observedAt?stringWhen this snapshot was last observed from Steam.
Format"date-time"
workspaceId?stringWorkspace the account belongs to.
Format"byte" base64
application/json
The request was malformed, such as a missing required field or an unparseable cursor.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request lacks a valid API key in the Authorization header.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The API key is not allowed to perform this action on this workspace.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The requested resource does not exist in this workspace.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request was rate limited. Slow down and retry later.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
An internal server error occurred.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
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"
}'const res = await fetch("https://api.goldmine.to/steam.v1.Steam/GetFriendsList", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"accountName": "trader_bot_01"
}),
});
const data = await res.json();body := strings.NewReader(`{
"accountName": "trader_bot_01"
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/steam.v1.Steam/GetFriendsList", body)
if err != nil {
return err
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("CSTRADER_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)import os, requests
res = requests.post(
"https://api.goldmine.to/steam.v1.Steam/GetFriendsList",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"accountName": "trader_bot_01"
},
)
data = res.json(){
"friendsList": {
"accountName": "trader_bot_01",
"workspaceId": "AY86PB0ufwCKGyw9Tl9gcQ==",
"friends": [
{
"steamId": "76561198044443322",
"relationship": 3
}
],
"observedAt": "2026-06-29T11:55:00Z"
}
}{
"code": "invalid_argument",
"message": "The request was malformed, such as a missing required field or an unparseable cursor."
}{
"code": "unauthenticated",
"message": "The request lacks a valid API key in the Authorization header."
}{
"code": "permission_denied",
"message": "The API key is not allowed to perform this action on this workspace."
}{
"code": "not_found",
"message": "The requested resource does not exist in this workspace."
}{
"code": "resource_exhausted",
"message": "The request was rate limited. Slow down and retry later."
}{
"code": "internal",
"message": "An internal server error occurred."
}