ss-marketplacetf-api

A community made API Wrapper

About

SS-MarketplaceTF-API is a basic wrapper for the Steam API used and maintained by SteamSecurity.org. Please see Limitations for further details.

Installation

npm i SS-MarketplaceTF-API

Basic usage

// There are two ways to include this module in your project
// The first way is on a single line
const MarketplaceTF = new (require('ss-marketplacetf-api'))({ key: MARKETPLACETF_API_KEY });

// Alternatively you can do it like this.
const _marketplacetf = require('ss-marketplacetf-api');
const MarketplaceTF = new _marketplacetf({ key: MARKETPLACETF_API_KEY });

See test.js for more examples.

Options

• key (Required)

  Set this value to your MarketplaceTF API Key. If left unset, this module will throw an error.

• timeout

  Time to wait in milliseconds before canceling the request and returning with an error.

• cache_results

  A Boolean dictating whether or not automatic caching happens. Typically you do not want to change from the default value 'true', however if you are using your own cache solution, you may want to disable this.

• cache_time

  Time to save a cached response in milliseconds. This is ignored if caching is disabled.

• debug

  A Boolean controlling whether or not this module will run in debug mode. This is not recommended for production environments as it outputs a lot of text to the console window.

Methods

• getProfile(steamid64)

  • steamid64: A valid steamid64 for any account.

    This returns a promise formatted as such:

    {
      seller: Boolean,
      banned: Boolean
    }

    Please note that Marketplace.TF does not have records on every Steam profile. It is likely they only have profiles on users that have ever signed into the website using their account. When this happens, Marketplace.TF will not supply their status of either their reputation, nor seller. As a result, critical information is not returned to us. This library assumes all profiles that do not have a "profile" on Marketplace.TF to be both not banned, and not a seller.

Error Handling

Any errors with the MarketplaceTF API or this module should resolve the promise with both an 'error' and 'error_message' value.

{
	error: 'Status code. Typically "1"',
	error_message: 'A more specific error message'
}

Limitations

This module does not handle the 'GetBots/v2' endpoint due to Marketplace.TF's strict policy of only allowing sellers access to that endpoint. We can not maintain that endpoint if we do not have access to it.

Disclaimer

This module is still a work-in-progress. There may be breaking changes with every update. This will remain true until our v1.0.0 release. Subsequent releases will be much more mature. This module is not endorsed or affiliated with Steam or Valve in any way. This module is not endorsed or affiliated with Marketplace.TF in any way. Please ensure your use of Marketplace.TF API is in line with the Marketplace.TF Terms.