@j4ckofalltrades/steam-webapi-ts

steam-webapi-ts

Isomorphic Steam WebAPI wrapper in TypeScript.

Installation

Using npm

$ npm install @j4ckofalltrades/steam-webapi-ts

Using yarn

$ yarn add @j4ckofalltrades/steam-webapi-ts

Using GitHub Packages

This step requires authenticating to GitHub Packages, then installing the package using npm.

$ npm install @j4ckofalltrades/steam-webapi-ts

via CDN

• jsDelivr cdn.jsdelivr.net/npm/@j4ckofalltrades/steam-webapi-ts/
• unpkg unpkg.com/browse/@j4ckofalltrades/steam-webapi-ts/

Usage

This requires a Steam WebAPI Key, you can get one at https://steamcommunity.com/dev/apikey

You can use either the provided SteamWebApi wrapper

import { SteamWebApi } from "@j4ckofalltrades/steam-webapi-ts"

const steamWebApi = new SteamWebApi("api_key")
await steamWebApi.usersApi.getPlayerSummaries(["steam_ids"])

or with a specific interface e.g. ISteamUser

import { ISteamUser } from "@j4ckofalltrades/steam-webapi-ts"

const usersApi = new ISteamUser("api_key")
await usersApi.getPlayerSummaries(["steam_ids"])

Docs

For more detailed documentation see https://j4ckofalltrades.github.io/steam-webapi-ts.

Stats