Yet another Node.js Steam WebAPI client
MIT License
This is yet another node.js module for the Steam WebAPI. I made it for myself because I'm sure none of the other modules are any good, but anyone is of course welcome to use it. Don't expect too many updates outside of fixing stuff.
It detects and handles errors from the X-eresult
and X-error_message
headers. It also requests gzip compression for
responses.
The constructor takes two arguments: key
and localAddress
.
var SteamWebAPI = require('@doctormckay/steam-webapi');
var api = new SteamWebAPI("yourapikey", "192.168.0.5");
The first argument is your API key. The second is the local IP address you want to make your requests from. Both are optional. If you don't provide an API key you can only use the methods that don't require one.
You can change your API key at any time by assigning it to the key
property. Same goes for localAddress
with the
localAddress
property.
iface
- The WebAPI interface that you want to use. The leading "I" is optional.
IGameServersService
or SteamUser
.method
- The WebAPI method that you want to use.
GetPlayerSummaries
.version
- The numeric version of the method you want to use.
1
.input
- Optional. An object containing the parameters you want to pass to this request.
key
or format
, as these will be filled automatically.input[0]=foo&input[1]=bar
) should be passed as JavaScript arrays. They will be serialized accordingly.callback
- A function to be called when the request completes
Performs a GET request to a method.
Same as get
except with a POST request.
On failure, you'll get back an Error
object with the following properties:
statusCode
- The HTTP status code of the response. This may be 200
if an error was detected elsewhere.eresult
- Only if Steam sends back an X-eresult
header, this will be an EResult value.message
- A string describing the error that occurred. These are the conditions that are checked, in order from top to bottom:
X-eresult
is returned, is not 1
, and X-error_message
is returned, then this is the value of X-error_message
; otherwise,X-eresult
is returned and is not 1
, then this is the string name of the EResult value (for example, NoMatch
); otherwise,Not Found
or Unauthorized
); otherwise,Malformed response
Response data is parsed as JSON. If the top-level object contains exactly one property named response
, then the value
of the response
property is returned. Otherwise, the parsed JSON is returned as-is.