ss
steam-store
npm i steam-store
ss

steam-store

API client for the unofficial steam storefront/big picture resource

by Stefan Dühring

0.4.1 (see all)License:MITTypeScript:Not Found
npm i steam-store
Readme

Steam Store

An API client for the unofficial Steam Storefront (Big Picture) resource, which provides methods to retrieve product information from the platform.

Latest: 0.4.0

Info

Features:

  • allows app listing, lookup and product search
  • usable with promises, stream and callbacks

Getting Started


var SteamStore = require('steam-store');

var store = new SteamStore({
  country:  'DE',
  language: 'en'
});

// store methods to call

Examples can be found here.

API

new SteamStore([options])

Available options for the store settings:

  • timeout - delay in ms to wait, in case the limit (~ 200 per 5 minutes) is reached | default: 5min
  • country - country code (US, GB, DE, ...) for the specific region, e.g. currency and exclusives | default: US
  • language - language of the descriptions

Custom

.getProducts([String|Array <String> types][, Booelan streamable][, Function callback])

.getProductsLists([Function callback])

.getProductsDetails(Array <String|Number> ids [, Boolean streamable][, Function callback])

.getProductsDetail(String|Number id [, Function callback])

.getProductLink(Number|String id)

Steam

.steam(String name [optional: arguments for the specific resource])

TODO

  • include package overview data
  • update documentation
  • write tests

Downloads/wk

27

GitHub Stars

30

LAST COMMIT

7yrs ago

MAINTAINERS

1

CONTRIBUTORS

3

OPEN ISSUES

1

OPEN PRs

0
VersionTagPublished
0.4.1
latest
7yrs ago
No alternatives found
No tutorials found
Add a tutorial