steam-tradeoffer-manager

Install the module using npm to manage Steam trade offers in your Node.js application.

Requirement: You must use Node.js v4.0.0 or later.

npm install steam-tradeoffer-manager

For technical assistance and questions regarding the module or general coding:

• Questions/Coding Help: Post in the dedicated forum. Do not use GitHub issues for questions.
• Bugs and Feature Requests: Report these via the GitHub issue tracker.

You can fetch the inventory contents of yourself or another user.

Get your own inventory

getInventoryContents(appid, contextid, tradableOnly, callback)

Get another user's inventory

getUserInventoryContents(sid, appid, contextid, tradableOnly, callback)

Parameters:

• sid: The SteamID of the user (string or SteamID object).
• appid: The Steam application ID.
• contextid: The ID of the inventory context.
• tradableOnly: Boolean; if true, only returns tradable items and currencies.
• callback: (err, contents) => {}.

manager.getInventoryContents(730, 2, true, (err, contents) => {
    if (err) return console.error(err);
    console.log('Inventory contents:', contents);
});

The EconItem class provides methods to construct Steam's CDN URLs for item images using the icon_url and icon_url_large properties.

• getImageURL(): Returns the standard size image URL.
• getLargeImageURL(): Returns the large size image URL. If icon_url_large is not present, it falls back to the standard getImageURL().

// Assuming 'item' is an instance of EconItem
const smallImage = item.getImageURL();
const largeImage = item.getLargeImageURL();

Use createOffer() to construct a new TradeOffer object to send to a partner. You can provide either a partner's SteamID or their full Trade URL.

Parameters:

• partner: The partner's SteamID (string or SteamID object) or their full Trade URL.
• token: (Optional) The partner's trade token (required if they are not your friend).

Returns: A TradeOffer instance configured as an outgoing offer (isOurOffer = true).

// Using a SteamID
const offer = manager.createOffer('76561198000000000');

// Using a Trade URL
const offerFromUrl = manager.createOffer('https://steamcommunity.com/tradeoffer/new/?partner=76561198000000000&token=abcdef123456');

After instantiation, you must authenticate the manager using setCookies(). This method sets the cookies for the SteamCommunity instance and handles API key retrieval or access token fallback.

Parameters:

• cookies: An array of cookie objects (e.g., from steam-user).
• familyViewPin: (Optional) A string PIN to unlock Family View.
• callback: A callback function (err) => {} called once authentication and initial polling are complete.

Note: If useAccessToken is enabled, the manager will attempt to extract an access token from the steamLoginSecure cookie to perform API requests if a WebAPI key is not present.

manager.setCookies(cookies, (err) => {
    if (err) {
        console.error('Login failed:', err);
        return;
    }
    console.log('Logged in and polling started!');
});

You can use the getTag(category) method to find a specific tag associated with an item based on its category.

• Parameter: category (string) - The category name to search for.
• Returns: The tag object if found, or null if no tag matches the provided category or if no tags exist.

const tag = item.getTag('Type');
if (tag) {
  console.log(`Tag name: ${tag.name}`);
}

To clean up resources, stop polling, and clear internal state, call shutdown().

This clears the polling timer and resets the internal SteamCommunity and SteamUser references.

manager.shutdown();

The TradeOfferManager class exports several enums used for filtering and identifying trade states:

• SteamID: A utility for parsing and working with SteamIDs.
• ETradeOfferState: Represents the current state of a trade offer.
• EOfferFilter: Used in getOffers() to filter results:
  • ActiveOnly
  • HistoricalOnly
  • All
• EResult: Represents the result of a trade operation.
• EConfirmationMethod: Represents how a trade is confirmed.
• ETradeStatus: Represents the status of a trade.