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>

getRecentlyPlayedGames()   Promise<Array>

getMostPlayed()   Promise<Array>

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.