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.

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

400 / Bad Request

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

JSON

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

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

502 / Bad Gateway

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

JSON