Please read the FAQ before creating any issue and How to contribute section before creating any pull request.
Allows you to automate Steam trading using trade offers in Node.js. It was designed with node-steam in mind, but does not depend on it, so you can use it separately if you can supply it with session information. Some of the methods of the library are wrappers for Steam Web API.
Note: By using this library you automatically agree to Steam API Terms of Use
steam-tradeoffers is a library for Node.js and io.js written in JavaScript.
steam-tradeoffers is not a complete solution for any of your needs.
To use steam-tradeoffers you need to know how to code in JavaScript.
The examples are NOT templates for your bot.
If you don't understand the code in the examples, the library is probably not for you.
npm install steam-tradeoffers
Instantiate a SteamTradeOffers object...
var SteamTradeOffers = require('steam-tradeoffers');
var offers = new SteamTradeOffers();...then setup session:
offers.setup({ sessionID: sessionID, webCookie: cookies });This setup will automatically register and retrieve Steam API key for you.
You'll need to install node-steam in order to run the examples.
The storehouse.js file contains an example of handling incoming trade offers.
The offerbot.js is an example of making a trade offer.
On first launch both of the examples will 'crash' with error code 63. Check your email for Steam Guard code and edit an example file to add it, the run it again.
Please read the FAQ before creating an issue about examples.
The first param for all methods is an object. The second param is callback. All callbacks supplied with Error as the first argument or null if no errors occured.
As noted above, this method is used to setup a web session. It also tries to retrieve Web API key. If you want to operate with trade offers right after startup, do it in callback of this method.
Options:
sessionIDis a valid web session ID. In node-steam, you can use thewebSessionIDevent to get it.webCookieis an array of cookies. In node-steam, you can use thewebLogOnmethod to get it.PINis a Family View PIN, required if account uses Family View.
If failed to retrieve Web API key due to limited account, setup will return Access Denied error in callback, or (if no callback provided) will throw the error.
Loads your inventory for the given app and context. For example, use 440 and 2 for TF2 and 570 and 2 for Dota 2. The second argument to callback will be an array of item objects in case of success.
Options:
appIdis the Steam AppIDcontextIdis the inventory context Idlanguage(optional) is the language for item descriptionstradableOnly(optional) is a boolean flag that defaults totrueto return tradable items only
Loads your partner inventory for the given app and context.
Options:
partnerSteamIdis the SteamID of the trade partnerappIdis the Steam AppIDcontextIdis the inventory context IdtradeOfferId(optional) is needed to load private inventory of the trade partner for received trade offerlanguage(optional) is the language for item descriptions
Makes a trade offer to the partner.
Options:
partnerAccountIdorpartnerSteamId, you need only one of those.accessToken(optional) is a token from the public Trade URL of the partner.itemsFromMeare the items you will lose in the trade.itemsFromThemare the items you will receive in the trade.counteredTradeOffer(optional) is the ID to a trade offer you are countering.message(optional) is a message to include in the offer.
itemsFromMe and itemsFromThem both are arrays of item objects that look like this:
{
"appid": 440,
"contextid": 2,
"amount": 1,
"assetid": "1627590398"
}If success the second param to callback will be an object with tradeofferid of the newly created trade offer.
The first method loads a list of trade offers, and the second loads just a single offer.
Options:
The second argument to callback will be an object that Steam Web API returns. The only thing to note is that the wrapper adds a property steamid_other with the SteamID of the trade partner to each CEcon_TradeOffer object in received trades.
declineOffer or acceptOffer that was sent to you. cancelOffer that you sent.
Options:
tradeOfferIdis a trade offer Id
The second argument to callback will be an object with response from Steam, but don't expect anything meaningful in it.
The second argument to callback will be the offer token of the bot, extracted from its trade offer URL.
Please read this list of common issues before creating an issue.
A. In most cases Access Denied error means that your account is limited. See Steam Support article about limited accounts.
A. Double check that your account credentials and Steam Guard code are correct. This is never a problem of steam-tradeoffers. Examples here use node-steam library to do Steam login.
A. There are two major possible cases:
-
Your params are incorrect and/or items are not tradable.
-
Your account can't trade which is normal for all new logins. Wait for 1-2 weeks, do not remove
sentryfile. There are also some rare cases when even old enough logins can't trade. That means you are very unlucky. Removesentryfile and login again. Blame Steam.
There are also some cases when Steam fails to send a trade offer due to its internal reasons, or returns errors even in cases of success. You know, blame Steam.
A. It means that node-steam at least once failed to get cookies from Steam. Most of the time you can safely ignore it.
A. In some cases 401 error means your cookies are no longer valid, you need to get new cookies from Steam. In node-steam try to do .webLogOn again and re-setup trade offers. If you get 403 in Steam WebAPI methods, try to regenerate your Web API key.
A. Please no. Please open an issue instead. Always try search first!
I appreciate your time and efforts you put in your pull requests, but please follow next simple rules so your efforts wouldn't be in vain.
-
Please consider creating an issue before doing any code. I'll do my best to implement a new feature (if it fits the library) or fix the library.
-
If you did some research, that is great! However, please do not put the results in the code right away, create an issue.
-
If after all you decided that you really need to push your code, please follow the existing code formatting, do not change any interfaces without need, use common sense when adding features so they won't break the existing functionality, test your code prior to submission and update README accordingly. Always do only one pull request per bug/feature.
I reserve the right to close any pull request and/or rewrite your feature or fix myself. Please note that reviewing and testing your code also takes time so your changes won't be merged immediately after submission.
Thank you.
The MIT License (MIT)
Copyright (c) 2013-2014 Alexey Komarov alex7kom@gmail.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.