op-expresstrade v1.0.3

OPSkins ExpressTrade module

Easy interaction with OPSkins ExpressTrade API systems.

Installation

npm i op-expresstrade --save

Usage

var OPExpressTrade = require('op-expresstrade')

var ET = new OPExpressTrade({
  apikey: 'OPSkins API Key',
  twofactorsecret: 'OPSkins 2FA Secret',
  pollInterval: 5000
})

ET.IUser.GetInventory((err, body) => {
  // console.log(body.response.items);
})

ET.ITrade.SendOfferToSteamId({steam_id: '76561198856791616', items: '1234,5678'}, (err, body) => {
  // console.log(body.response.offer);
})

ET.on('offerReceived', (_offer) => {
  console.log(_offer.id)

  ET.ITrade.CancelOffer({offer_id: _offer.id})
})

Syntax

You can either address the methods as object properties like this:

ET.IUser.GetInventory((err, body) => {
  // console.log(body.response.items);
})

or address the path like this:

ET.request('IUser/GetInventory', ((err, body) => {
  // console.log(body.response.items);
})

Request Methods (GET/POST)

The required methods are saved in the API schema and op-expresstrade handles the conversion for GET (query string) and POST (form) on its own.

op-expresstrade accepts any JSON object containing the data.

Events

If pollInterval is set, op-expresstrade will poll for changes. If any new or changed offers are detected, an event will be emitted.

any

• event - The event type
• offer - A Standard Trade Offer Object

Emitted on any event.

offerSent

• offer - A Standard Trade Offer Object

Emitted when an offer has been sent out. The offer is active and the recipient can accept it to exchange the items.

offerReceived

• offer - A Standard Trade Offer Object

Emitted when an offer was received. The offer is active and you can accept it to exchange the items.

offerAccepted

• offer - A Standard Trade Offer Object

Emitted when an offer has been accepted. The recipient accepted the offer and items were exchanged.

offerExpired

• offer - A Standard Trade Offer Object

Emitted when an offer has expired. The offer expired from inactivity.

offerCancelled

• offer - A Standard Trade Offer Object

Emitted when an offer was cancelled. The sender cancelled the offer.

offerDeclined

• offer - A Standard Trade Offer Object

Emitted when an offer has been declined. The recipient declined the offer.

offerNoLongerValid

• offer - A Standard Trade Offer Object

Emitted when an offer is no longer valid. One of the items in the offer is no longer available/eligible so the offer was cancelled automatically.

caseOpenPending

• offer - A Standard Trade Offer Object

Emitted when an offer has a pending case opening. The trade offer was initiated by a VCase site and it's awaiting ETH confirmations. The vKeys have been removed from the user iventory but may be restored on error later.

caseOpenExpired

• offer - A Standard Trade Offer Object

Emitted when an offer for a case opening has expired. The trade offer was initiated by a VCase site and there was an error opening the case due to backend issues. No items should have been exchanged.

caseOpenFailed

• offer - A Standard Trade Offer Object

Emitted when an offer for a case opening failed. The trade offer was initiated by a VCase site and VGO was unable to generate items on the blockchain, so the vKeys have been refunded.