API Reference / Steam accounts
Get multiple Steam accounts by name
Look up several Steam accounts in one call. Returns the accounts that exist and lists any requested names that were not found.
/ steam. v1. Steam/ GetAccountsRequest body
application/jsonRequired
Request for several Steam accounts in the caller's workspace by account name, in one call.
accountNames?array<string>Steam account names to look up.
Response body
application/json
Success
accounts?array<Account>The accounts that were found.
Show attributes
accountName?stringUnique Steam account name within the workspace.
apiKeyConfigured?booleanWhether the account has its own account-tier Steam Web API key configured. Never the key itself.
apiKeySaved?AccountSecretSavedWhen the account's own Steam Web API key was last saved and by whom. Unset when none is saved, and for a key saved before the platform recorded it.
Show attributes
savedAt?stringWhen the secret was saved.
Format"date-time"
savedBy?stringThe member who saved it. Absent when it was saved by the platform rather than a member, such as a staff import.
Format"byte" base64
avatarUrl?stringFull-size Steam profile picture of the account, from its most recently observed persona. Unset until Steam has provided the account's avatar.
banSeverity?stringWhat the account's bans mean for trading, derived from the ban fields: stops trading for an economy ban, trade lock or community ban, a warning for a VAC ban, game ban or economy probation, otherwise none.
Value in"ACCOUNT_"ACCOUNT_"ACCOUNT_
capabilities?array<string>Opt-in per-market trading actions this account may perform. Always empty when is_scraping is true.
Value in"ACCOUNT_"ACCOUNT_"ACCOUNT_"ACCOUNT_
communityBanned?booleanWhether the Steam account is community banned.
createdAt?stringWhen the account was added to the workspace. Unset for accounts added before the platform recorded it.
Format"date-time"
deletedAt?stringWhen the account was soft deleted. Unset for an active account.
Format"date-time"
economyBan?stringSteam economy ban state: none, probation, or banned.
generation?stringPersistent account lifecycle generation. Changes on creation or restoration, remains stable across sessions and ordinary updates. Zero means the producer does not provide an authoritative generation.
Format"int64"
identitySecretConfigured?booleanWhether a mobile authenticator identity secret is saved for the account, so trade and market confirmations can be accepted. Never the secret itself.
identitySecretSaved?AccountSecretSavedWhen the confirmation (identity) secret was last saved and by whom. Unset when none is saved, and for a secret saved before the platform recorded it.
Show attributes
savedAt?stringWhen the secret was saved.
Format"date-time"
savedBy?stringThe member who saved it. Absent when it was saved by the platform rather than a member, such as a staff import.
Format"byte" base64
inventoryCheckedAt?stringWhen the account's community inventory was last successfully fetched. Unset when the inventory has never been fetched.
Format"date-time"
inventoryPrivateSince?stringWhen the account's community inventory was first observed as private. Unset when the inventory is readable.
Format"date-time"
isLimited?booleanWhether Steam reports the account as limited, meaning it has not spent the minimum on Steam and cannot use some community and trading features.
isScraping?booleanCross-market scraping toggle. A scraping account may only be used for read-only operations on any market, never to hold buying balance, place a buy order or offer, bid an auction, or list inventory for sale.
lastSessionError?stringSteam EResult name of the most recent session error. Not cleared on recovery, so it stays the last-error breadcrumb until overwritten by the next error.
locked?booleanWhether the Steam account is trade and market locked.
loginRetryAt?stringWhen a login-throttle cooldown ends and the next sign-in may be attempted. Unset when the account is not cooling down.
Format"date-time"
loginStatus?stringWhat the account's Steam session means for the operator, derived by the server from session_status and session_error_reason.
Value in"LOGIN_"LOGIN_"LOGIN_"LOGIN_
numberOfGameBans?integerNumber of game bans on the Steam account.
Format"int32"
passwordSaved?AccountSecretSavedWhen the password was last saved and by whom. Unset for a password saved before the platform recorded it.
Show attributes
savedAt?stringWhen the secret was saved.
Format"date-time"
savedBy?stringThe member who saved it. Absent when it was saved by the platform rather than a member, such as a staff import.
Format"byte" base64
personaName?stringMost recently observed self-persona display name. Unset until Steam explicitly provides the account's name. Separate from its login username.
personaObservedAt?stringWhen Steam explicitly provided the self-persona state. Name-only and avatar-only updates do not refresh this state observation clock.
Format"date-time"
personaState?stringMost recently explicitly observed self-persona state. Zero is observed Offline. Unset means unknown. Last-known presence is separate from current connection status.
Value in"PERSONA_"PERSONA_"PERSONA_"PERSONA_"PERSONA_"PERSONA_"PERSONA_
reconnectCount?integerNumber of reconnects made within the current session establishment. Resets to 0 on each new session start.
Format"int32"
requestLatency?stringLatest measured correlated Steam request-to-first-response round trip in milliseconds, including server processing. Observed zero is valid. Unset means unmeasured. Separate from logon latency.
requestLatencyObservedAt?stringOriginal response time of the latest passively measured request round trip. Best-effort projection, separate from current connection and collection freshness.
Format"date-time"
sessionConnectedAt?stringWhen the account's current online stretch began: the logon that brought it online, kept across a reconnect or a move to another worker that logs on again within five minutes of going offline. Unset until the first logon.
Format"date-time"
sessionDisconnectedAt?stringWhen the account last went offline: moves when a logged-on account drops and stays put while an offline account keeps failing to sign in. Kept after it comes back online. Compare with session_connected_at.
Format"date-time"
sessionErrorReason?stringTyped cause of the most recent session error. Unset until a session has errored. Like last_session_error it is not cleared on recovery.
Value in"SESSION_"SESSION_"SESSION_"SESSION_"SESSION_"SESSION_"SESSION_"SESSION_"SESSION_"SESSION_
sessionErrorUserFixable?booleanWhether the customer can fix the account's current session error themselves, such as by updating its password or assigning a proxy. False when the session is not in error.
sessionLatency?stringMost recent logon round-trip latency in milliseconds. Unset until the session's first successful logon.
sessionStatus?stringCurrent Steam session lifecycle state.
Value in"SESSION_"SESSION_"SESSION_"SESSION_"SESSION_
sharedSecretSaved?AccountSecretSavedWhen the Steam Guard shared secret was last saved and by whom. Unset for a secret saved before the platform recorded it.
Show attributes
savedAt?stringWhen the secret was saved.
Format"date-time"
savedBy?stringThe member who saved it. Absent when it was saved by the platform rather than a member, such as a staff import.
Format"byte" base64
steamCreatedAt?stringWhen the Steam account itself was made, as Steam reports it. Unset until it has been read, and for an account whose Steam profile is private.
Format"date-time"
steamId?stringThe account's 64-bit SteamID. Unset until the account has logged on at least once.
tradeOfferCheckedAt?stringWhen the current trade-offer list was last completely fetched and persisted in this account lifecycle, including a successful empty list. Unset until the first complete check. Separate from initial historical synchronization.
Format"date-time"
tradeOfferHistorySyncError?stringBounded reason the scheduled history synchronization is waiting to retry. No recorded error when unspecified. Successful pages clear it without resetting progress.
Value in"TRADE_"TRADE_"TRADE_
tradeOfferHistorySyncedAt?stringWhen initial synchronization consumed all historical offer pages returned by Steam. Unset while pending or incomplete. Not a guarantee of lifetime history retention.
Format"date-time"
vacBanned?booleanWhether the Steam account has a VAC ban.
workspaceId?stringWorkspace the account belongs to.
Format"byte" base64
notFoundAccountNames?array<string>Requested account names that do not exist in the workspace.
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 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/GetAccounts" \
-H "Authorization: Bearer $CSTRADER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountNames": [
"trader_bot_01",
"trader_bot_02"
]
}'const res = await fetch("https://api.goldmine.to/steam.v1.Steam/GetAccounts", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"accountNames": [
"trader_bot_01",
"trader_bot_02"
]
}),
});
const data = await res.json();body := strings.NewReader(`{
"accountNames": [
"trader_bot_01",
"trader_bot_02"
]
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/steam.v1.Steam/GetAccounts", 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/GetAccounts",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"accountNames": [
"trader_bot_01",
"trader_bot_02"
]
},
)
data = res.json(){
"accounts": [
{
"accountName": "trader_bot_01",
"workspaceId": "AY86PB0ufwCKGyw9Tl9gcQ==",
"sessionStatus": "SESSION_STATUS_LOGGED_ON",
"steamId": "76561198000000001",
"sessionConnectedAt": "2026-06-29T11:45:00Z",
"communityBanned": false,
"locked": false,
"vacBanned": false,
"numberOfGameBans": 0,
"economyBan": "none"
}
],
"notFoundAccountNames": [
"trader_bot_02"
]
}{
"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": "resource_exhausted",
"message": "The request was rate limited. Slow down and retry later."
}{
"code": "internal",
"message": "An internal server error occurred."
}