steam-api-client

Steam Web API client for Node.js.

pnpm add steam-api-client

Usage

import { SteamApiClient } from "steam-api-client";

const steam = new SteamApiClient("API_KEY");

API

Method	Params	Returns
getPlayerSummaries	steamIds: string | string[]	PlayerSummary[]
resolveVanityUrl	vanityUrl: string	string | null
getSteamLevel	steamId: string	number
getPlayerBans	steamIds: string | string[]	PlayerBan[]
getFriendList	steamId: string, relationship?: string	Friend[]
getPlayerAchievements	steamId: string, appId: number	{ steamID, gameName, achievements }
getUserStatsForGame	steamId: string, appId: number	{ steamID, gameName, stats }
getGlobalAchievementPercentagesForApp	appId: number	{ name, percent }[]
getNewsForApp	appId: number, count?: number, maxLength?: number	NewsItem[]
getAppList	—	{ appid, name }[]
getServersAtAddress	addr: string	Server[]

Response Types

getPlayerSummaries → PlayerSummary[]

interface PlayerSummary {
  steamid: string;
  communityvisibilitystate: number;
  profilestate?: number;
  personaname: string;
  profileurl: string;
  avatar: string;
  avatarmedium: string;
  avatarfull: string;
  avatarhash?: string;
  lastlogoff?: number;
  personastate: number;
  primaryclanid?: string;
  timecreated?: number;
  personastateflags?: number;
  loccountrycode?: string;
  locstatecode?: string;
  loccityid?: number;
}

resolveVanityUrl → string | null

getSteamLevel → number

getPlayerBans → PlayerBan[]

interface PlayerBan {
  SteamId: string;
  CommunityBanned: boolean;
  VACBanned: boolean;
  NumberOfVACBans?: number;
  NumberOfGameBans: number;
  EconomyBan: string;
  DaysSinceLastBan?: number;
}

getFriendList → Friend[]

interface Friend {
  steamid: string;
  relationship: string;
  friend_since: number;
}

getPlayerAchievements → PlayerStats

interface PlayerStats {
  steamID: string;
  gameName: string;
  achievements: Achievement[];
  success: boolean;
  error?: string;
}

interface Achievement {
  apiname: string;
  achieved: number;
  unlocktime: number;
  name?: string;
  description?: string;
}

getUserStatsForGame → UserStatsForGame

interface UserStatsForGame {
  steamID: string;
  gameName: string;
  stats: UserStat[];
  achievements?: Achievement[];
  success?: boolean;
  error?: string;
}

interface UserStat {
  name: string;
  value: number;
}

getGlobalAchievementPercentagesForApp → GlobalAchievement[]

interface GlobalAchievement {
  name: string;
  percent: number;
}

getNewsForApp → NewsItem[]

interface NewsItem {
  gid: string;
  title: string;
  url: string;
  is_external_url: boolean;
  author: string;
  contents: string;
  feedlabel: string;
  date: number;
  feedname: string;
  feed_type: number;
  appid: number;
}

getAppList → App[]

interface App {
  appid: number;
  name: string;
}

getServersAtAddress → Server[]

interface Server {
  addr: string;
  gmsindex?: number;
  appid: number;
  gamedir: string;
  region: number;
  secure: boolean;
  lan?: boolean;
  gameport: number;
  specport?: number;
}