JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 47
  • Score
    100M100P100Q54275F
  • License MIT

A module for interacting with the csgo.tm API

Package Exports

  • node-csgotm-api

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (node-csgotm-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

CSGO.tm API

This is a node module for interacting with the csgo.tm API. Docs available here

Installation

npm install node-csgotm-api

Usage

var csgotm = require('node-csgotm-api');
var api = new csgotm.API(options);

Constructor params

Params:

  • options[apiKey]: your API key required
  • options[baseUrl]: url to API. Default: https://market.csgo.com/.
  • options[apiPath]: relative path to API. Default: api.
  • options[useLimiter]: enable bottleneck limiter. Default: true.
  • options[defaultGotOptions]: default options for got module for all API-call methods without gotOptions param(except static). Default: {}.
  • options[limiterOptions]: options for bottleneck limiter. Default:
{
    maxConcurrent: 1,
    minTime: 200,
    highWater: -1,
    strategy: Bottleneck.strategy.LEAK,
    rejectOnDrop: true
}

Methods

All API-call methods return Promise, and they have gotOptions param for got module

All methods are divided into blocks with a special prefix (except static) like in docs

  • account
  • item
  • sell
  • buy
  • order
  • notification
  • search
  • quick
  • additional

Many of methods require item in the params. It should be an object with properties:

  • i_classid or classid or classId
  • i_instanceid or instanceid or instanceId

Example

api.accountGetTrades().then(trades => {
  console.log(trades);
}).catch(error => {
  console.log(error);
});