# steamwebapi-ts

> > A simplified wrapper for the steam web api

Latest version **1.13.1** (published 2026-08-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install steamwebapi-ts
pnpm add steamwebapi-ts
yarn add steamwebapi-ts
bun add steamwebapi-ts
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.13.1 |
| Published | 2026-08-11 |
| First published | 2021-12-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | ^22.0.0 \|\| ^24.0.0 |
| Dependencies | 4 |
| Unpacked size | 96.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | pho3nix90 |
| Keywords | steam, web, api, node, typescript, library |

## Links

- npm: https://www.npmjs.com/package/steamwebapi-ts
- Repository: https://github.com/Pho3niX90/steamwebapi-ts
- Homepage: https://github.com/Pho3niX90/steamwebapi-ts#readme
- Issues: https://github.com/Pho3niX90/steamwebapi-ts/issues
- npm.io page: https://npm.io/package/steamwebapi-ts

## Dependencies (4)

- [axios](https://npm.io/package/axios.md) ^1.19.0
- [dotenv](https://npm.io/package/dotenv.md) ^17.4.2
- [append-query](https://npm.io/package/append-query.md) ^2.1.1
- [@babel/preset-typescript](https://npm.io/package/@babel/preset-typescript.md) ^7.29.7

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.13.1 (latest) — 2026-08-11
- 1.11.2 — 2025-06-20
- 1.11.1 — 2025-06-20
- 1.11.0 — 2025-06-19
- 1.10.0 — 2024-02-24
- 1.9.13 — 2024-02-23
- 1.9.12 — 2024-02-23
- 1.9.11 — 2024-02-16
- 1.9.10 — 2024-02-16
- 1.9.9 — 2023-07-03
- 1.9.8 — 2023-06-25
- 1.9.2 — 2023-06-20
- 1.9.1 — 2023-06-20
- 1.9.0 — 2023-06-20
- 1.7.7 — 2023-06-05
- … 29 more at https://npm.io/package/steamwebapi-ts/versions

## README

Main: [![Coverage Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/Pho3niX90/66e2656c1157700d2adcc8a9adef6929/raw/steamwebapi_ts_heads_main.json)]

# steamwebapi-ts

> A simplified wrapper for the steam web api

This is a simple and lightweight wrapper for the steam web api. Created because the other options weren't simple enough for me.

## Documentation

### Installation

```
npm install steamwebapi-ts
```

### Usage

```typescript
import {Steam} from 'steamwebapi-ts';
const api = new Steam(API_KEY_HERE)

const id = 76561198052893297 || 'cmdline' // You can use steamID64 or the vanity url

api.getPlayerSummary(id).then(data => {
  console.log(data)
})
```

### Methods

```javascript
isRateLimited // returns obj indicating if you are rate limited
requestCount // returns obj with total requests to steam and lastReset of the counter
resolveId(id) // resolves vanity url to steamID64
getNewsForApp(appid[,count = 3, maxLength = 300])
getGlobalAchievementPercentagesForApp(appid)
getGlobalStatsForGame(appid[,count = 1, achievements = []])
getPlayerSummary(id)
getOwnedGames(id [,include_free_games=false, include_appinfo=false])
getUserLevel(id)
getUserBadges(id)
getRecentlyPlayedGames(id)
getPlayerBans(id)
getPlayerAchievements(id, appid)
getUserStatsForGame(id, appid)
getFriendList(id)
isPlayingSharedGame(id, appid)
getSchemaForGame(appid)
getAppList()
getAppInfo(appid)
getNumberOfCurrentPlayers(appid)
```

More info: https://partner.steamgames.com/doc/webapi/

## License

MIT

originally forked from https://github.com/DevNvll/steamwebapi

---
_Source: https://npm.io/package/steamwebapi-ts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._