Game

Query Steam User

0calls
2 credits / call

Want to display a user's Steam profile on your website or app? This endpoint is designed for you.

GET
uapis.cn
/api/v1/game/steam/summary
Query parameters
4
steamid
string

User's Steam identifier. Can be any of the following formats:

  • Numeric SteamID64
  • User's custom URL name (Vanity URL)
  • Complete profile link (containing SteamID64 or custom name)
  • Friend code (e.g., 22202)
id
string

User's Steam custom URL name (Vanity URL). For example, the part after /id/ in the profile link.

id3
string

User's Steam ID3 format identifier. Traditional Steam ID format, like STEAM_X:Y:Z.

key
string

This endpoint accepts an access credential. This parameter is optional, if provided, your value will be used with priority. Please keep it secure and don't put it in public frontend code.

Overview

With a user's Steam identifier (supports multiple formats), you can get their public profile summary, including nickname, avatar, online status, real name (if public) and profile homepage URL.

Supported Parameter Formats

The endpoint now supports the following identifier formats:

  • steamid: 64-bit SteamID (e.g., 76561197960287930)
  • id: Custom URL name (e.g., gabelogannewell)
  • id3: Steam ID3 format (e.g., STEAM_0:0:22202)
  • Complete profile link
  • Friend code

Usage Notes

Important

Access Credential Description This endpoint accepts a key parameter to use your own access credentials. If you choose to provide it, please keep it secure and don't put it in public frontend code.

When processing responses, note the meanings of the following numeric codes:

  • personastate (User Status): 0-Offline, 1-Online, 2-Busy, 3-Away, 4-Snooze, 5-Looking to Trade, 6-Looking to Play.
  • communityvisibilitystate (Community Visibility): 1-Private, 3-Public (API can usually only query these two states).

Query parameters

steamid
stringoptional

User's Steam identifier. Can be any of the following formats:

  • Numeric SteamID64
  • User's custom URL name (Vanity URL)
  • Complete profile link (containing SteamID64 or custom name)
  • Friend code (e.g., 22202)
id
stringoptional

User's Steam custom URL name (Vanity URL). For example, the part after /id/ in the profile link.

id3
stringoptional

User's Steam ID3 format identifier. Traditional Steam ID format, like STEAM_X:Y:Z.

key
stringoptional

This endpoint accepts an access credential. This parameter is optional, if provided, your value will be used with priority. Please keep it secure and don't put it in public frontend code.

Response

200 / OK

Query successful! Returns user's Steam public profile summary.

JSON
{
  // 32x32 pixel small avatar URL.
  "avatar": "https://avatars.steamstatic.com/fef49e7fa7e1997310d705b2a6158ff8dc1cdfeb.jpg",
  // 184x184 pixel large avatar URL.
  "avatarfull": "https://avatars.steamstatic.com/fef49e7fa7e1997310d705b2a6158ff8dc1cdfeb_full.jpg",
  // 64x64 pixel medium avatar URL.
  "avatarmedium": "https://avatars.steamstatic.com/fef49e7fa7e1997310d705b2a6158ff8dc1cdfeb_medium.jpg",
  // Community profile visibility state: 1=Private, 3=Public.
  "communityvisibilitystate": 3,
  // Country code (ISO 3166-1) set in user's profile, if user has set and made it public.
  "loccountrycode": "US",
  // Player's current nickname.
  "personaname": "Gabe Newell",
  // User's current online status: 0-Offline, 1-Online, 2-Busy, 3-Away, 4-Snooze, 5-Looking to Trade, 6-Looking to Play.
  "personastate": 1,
  // 64-bit ID of the player's primary clan.
  "primaryclanid": "103582791429521412",
  // 1 if user has set up their profile.
  "profilestate": 1,
  // Full URL of user's Steam community profile page.
  "profileurl": "https://steamcommunity.com/id/gabelogannewell/",
  // User's real name, if user has set and made it public.
  "realname": "Gabe Logan Newell",
  // 64-bit SteamID of the queried user.
  "steamid": "76561197960435530",
  // Unix timestamp (seconds) when account was created.
  "timecreated": 1063407589,
  // Formatted account creation time for easier reading.
  "timecreated_str": "2003-09-12 22:59:49"
}

400 / Bad Request

Request failed. Please check if you provided any one of the steamid, id or id3 parameters.

JSON
{
  "code": "INVALID_ARGUMENT",
  "details": {},
  "message": "Missing steam identifier parameter. Please provide one of: steamid, id, or id3."
}

401 / Unauthorized

Authentication failed. The Steam Web API Key you provided is invalid or expired, or you didn't provide a Key. Please check your Key.

JSON
{
  "code": "UNAUTHENTICATED",
  "details": {},
  "message": "Missing or invalid API Key."
}

404 / Not Found

User not found. Based on the SteamID you provided, we couldn't find the corresponding user, or the user's profile is completely private.

JSON
{
  "code": "NOT_FOUND",
  "details": {},
  "message": "User with the specified SteamID not found."
}

502 / Bad Gateway

Unable to fetch game data temporarily, please try again later.

JSON
{
  "code": "UPSTREAM_ERROR",
  "details": {},
  "message": "Unable to fetch game data. Please try again later."
}