Skip to content

API client for the unofficial steam storefront/big picture resource

License

Notifications You must be signed in to change notification settings

autarc/steam-store

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

API client for the unofficial steam storefront/big picture resource

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published