Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

steam-market-fetcher

SnaBe187MIT3.0.1TypeScript support: included

A Node.js wrapper for the Steam Community Market API.

steam, market, fetch, community, csgo, tf2, dota2, prices, images, economy, cdn, listings, data, items, callback, promise

readme

steam-market-fetcher

A Node.js wrapper for the Steam Community Market API.

npm version node version npm test dependencies npm downloads license paypal

Installation

Using npm:

$ npm install steam-market-fetcher

Using yarn:

$ yarn add steam-market-fetcher

Testing

Note: Make sure you've supplied a valid steamLoginSecure cookie in the test.js file.

Using npm:

$ npm test

Using yarn:

$ yarn test

Examples

Importing with ES6's import statement.

import SteamMarketFetcher from 'steam-market-fetcher';

Instantiating with the currency and format options.

const market = new SteamMarketFetcher({
    currency: 'EUR',
    format: 'json'
});

Asynchronous requests with callbacks.

market.getItemPrice({
    market_hash_name: 'AK-47 | Redline (Field-Tested)',
    appid: 730,
    callback: (err, price) => {
        if (err) throw err;

        console.log(price);
    }
});

Asynchronous requests with async/await.

(async () => {
    try {
        const image = await market.getItemImage({
            market_hash_name: 'Mann Co. Supply Crate Key',
            appid: 440
        });

        console.log(image);
    } catch (error) {
        console.error('An error occurred: ', error);
    }
})();

Some more examples are available in the test directory.

Documentation

Version 3.0.0 includes breaking changes, please see the newly updated Wiki pages for further documentation.

License

MIT

Copyright 2024, Simon Sørensen