steam-mini-api

Simple Steam API wrapper exposing some useful methods

Requirements

Get a Steam API Key for the package.

Installation

# Install with npm
npm install steam-mini-api

Usage

import { SteamMini } from "steam-mini-api";

const steam = new SteamMini("<YOUR-STEAM-API-KEY>");

// Get info about a single steam user by their 64 bit steam id
const user = await steam.getUserInfo("<STEAM-USER-ID>");

// Get the user's most recently played games (default return limit is 1)
const recentlyPlayed = await steam.getRecentlyPlayedGames("<STEAM-USER-ID>", 4);

// Get topmost played games, sorted by playtime
const topGames = await steam.getMostPlayed("<STEAM-USER-ID>", 4, {
  includePlayedFreeGames: false,
  includeAppInfo: true,
});

Methods

getUserInfo()   Promise<Object>

Options	Type	Description
steamid	string	The 64 bit steam id of the player to get the info of.

getRecentlyPlayedGames()   Promise<Array>

Options	Type	Description
steamid	string	The 64 bit steam id of the player to get the info of.
count	number	Count of recently played games to return. (Default: 3)

getMostPlayed()   Promise<Array>

Options	Type	Description
steamid	string	The Steam User ID of the player to get the info of.
count	number (1 <= n <= 10)	Count of recently played games to return. (Default: 3)
options.includePlayedFreeGames	boolean	Include free games if the player has played them. (Default: false)
options.includeAppInfo	boolean	Include game name and logo information in the output. (Default: true)

License

Steam Mini is packaged and distributed using the MIT License which allows for commercial use, distribution, modification and private use provided that all copies of the software contain the same license and copyright.