Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itsjfx/node-steamapis
Unofficial community-maintained module for https://steamapis.com
https://github.com/itsjfx/node-steamapis
node-steamapis npm steamapis
Last synced: about 2 months ago
JSON representation
Unofficial community-maintained module for https://steamapis.com
- Host: GitHub
- URL: https://github.com/itsjfx/node-steamapis
- Owner: itsjfx
- License: gpl-3.0
- Created: 2019-10-06T08:49:27.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-08-25T11:34:04.000Z (almost 3 years ago)
- Last Synced: 2024-04-02T12:56:48.579Z (3 months ago)
- Topics: node-steamapis, npm, steamapis
- Language: JavaScript
- Size: 65.4 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-steam - steamapis - Module to use the API of [steamapis.com](https://steamapis.com). (Packages / Node.js)
README
# node-steamapis
[](https://npmjs.com/package/steamapis)
Unofficial community-maintained module for https://steamapis.com
```
npm install steamapis
```
## Usage
I'd recommend checking the examples in the `examples` folder. The JSDoc is also in [doc.md](https://github.com/itsjfx/node-steamapis/blob/master/doc.md).
[Link to SteamApis.com docs](https://steamapis.com/docs)
Currently all methods return promises, and the method parameters mostly match the ones from the SteamApis docs. One exception `api_key` which is automatically put into every request. This value is set in the constructor for the instance.
## Some things to note about the module
Under the hood the inventory requests use my module `node-steam-inventory-api-ng`. Because of this, you can retry requests and customise the request timeout. Both of these are incredibly useful because sometimes SteamApis can be slow if you get a bad proxy. It also aims to be very similar to that of `node-steamcommunity`'s `getUserInventoryContents` call. It does this by returning the exact same response. **Simply put if you already use getUserInventoryContents you should feel right at home.**
All API calls are implemented as of now, however not all have been thoroughly tested as I don't need to use all of them for my use case.