steam-webapi-ts

A Typescript wrapper for Steam's Web API

Usage no npm install needed!

<script type="module">
  import steamWebapiTs from 'https://cdn.skypack.dev/steam-webapi-ts';
</script>

README

steam-webapi-ts

npm GitHub package.json dependency version (prod)

A Typescript wrapper for Steam's Web API.

Installation

Using npm

NPM

Using yarn

$ yarn add steam-webapi-ts

Usage

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

You can use either the provided SteamWebApi wrapper, or a specific interface e.g. ISteamUser.

// steam-web-api.ts
import { SteamWebApi } from "steam-webapi-ts"

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

// steam-user-api.ts
import { ISteamUser } from "steam-webapi-ts"

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

Docs

Read the documentation here

Read the Steam Web API documentation here