isabella232 / itbit-exc

Node.js module to interface with the ItBit exchange

ItBit exchange API module

Install

npm install itbit-exc

About

This module utilizes the ItBit Exchange API. It only covers the main API endpoints (for now). This document will guide you through a list of the endpoints that this module utilizes, along with explanation of initialization, input parameters, success and error responses, and examples.

Initialization

var ItBitExchange = require('itbit-exc');

var itBitExchange = new ItBitExchange({
    key: 'your_api_key',
    secret: 'your_api_secret',
    walletId: your_wallet_id
  }
);

The constructor has more optional parameters:

• timeRangeBeforeCreatedInMillis: Search interval* min (default 1 min.)
• timeRangeAfterCreatedInMillis: Search interval* max (default 30 min.)
• log: Select another logger if you want. This module uses console-log-level

*The max and min range we search for trades belonging to an ItBit order in getTrade() function. The time is before and after order create time.

Note: All data and errors are returned as objects, not as stringified JSON.

Note: All amounts, except the fee and price for exchange, are denominated in sub-units. This means 0.01 USD will be returned as 100, and 1.0 BTC will be returned as 100000000.

Errors format

We use the Node's native Error class to generate an error, to which we attach two custom properties: code and cause.

• code represents the machine readable code for the certain error. Eg. exchange_server_error (for a list of all error codes used in the exchange OSS modules, see bellow)

• cause contains the raw error object, returned from the system, be it the Node environment, the exchange server or something else We use the Error class because later, upon the error object, we can call the .stack property (or any other native property), that is auto-generated with the object. This way there is no need to assign it explicitly, when returning the error.

Example of an error message

{
  [Error: The base amount must be a number],
   code: 'internal_module_error',
   cause: 'some cause or an error stack'
}

Then, at the receiver side, you can easily call error.message to get the custom, human-readable error message, or error.code for the machine-readable one, and so on (provided that you call your received object error).

List of error codes

• exchange_server_error: Indicates that the error has happened in and was received from the remote exchange server itself (ItBit).

• internal_module_error: Indicates that the error has happened internally in the module. This means that a logical failure, a data manipulation failure has occurred or wrong input parameters have been passed to the exposed endpoint.

Exposed endpoints

Ticker

Returns ticker information for a given currency pair

Input parameters

baseCurrency: The base currency of the currency pair

quoteCurrency: The quote currency of the currency pair

Example call

itBitExchange.getTicker('BTC', 'USD', function(err, ticker) {
  if (err) {
    console.log(err);
  } else {
    console.log(ticker);
  }
});

Response on success

{
  baseCurrency: 'BTC',
  quoteCurrency: 'USD',
  bid: 649.89,
  ask: 650.12,
  lastPrice: 649.97,
  high24Hours: 652.55,
  low24Hours: 634.98,
  vwap24Hours: 647.37,
  volume24Hours: 1234567890 // 12.3456789 BTC
}

Order Book

Returns the current order book of ItBit in a custom organized object.

Input parameters

baseCurrency: The currency of baseAmount

quoteCurrency: The currency to determine the price quoteCurrency/baseCurrency

Example call

itBitExchange.getOrderBook('BTC', 'USD', function (err, data) {
  if (err) {
    console.log(err);
  } else {
    console.log(data);
  }
});

Response on success

{
  baseCurrency: "BTC",
  quoteCurrency: "USD",
  asks: [                   // List of entries with bitcoins for sale, sorted by lowest price first
    {
      price: 450.65,
      baseAmount: 44556677  // 0.44556677 BTC for sale
    }
    // ... more ask entries
  ],
    bids: [                 // List of entries for buying bitcoins, sorted by most highest price first
      {
        price: 450.31,
        baseAmount: 33445566 // Someone wants to buy 0.33445566 BTC
      }
    // ... more bid entries
  ]
}

Get Balance

Returns the available and total balance amounts of the specified wallet for all available currencies.

Input parameters

none

Example call

itBitExchange.getBalance(function (err, data) {
  if (err) {
    console.log(err);
  } else {
    console.log(data);
  }
});

Response on success

{
  available: {
    USD: 123,       // 1.23 USD
    BTC: 23000000   // 23 BTC
  }
  total: {
    USD: 123,
    BTC: 23000000
  }
}

Get Trade

Fetches a trade object from ItBit which contains order status. If order is filled/closed. The trade object is returned with new trade values. If order is open the same trade object is returned without any new values.

Input parameters

This object only has the required fields

trade:
  {
    raw: {
       id: 123456789, // Id of the ItBit order
    }
  }

Example call

itBitExchange.getTrade(trade, function (err, data) {
  if (err) {
    console.log(err);
  } else {
    console.log(data);
  }
});

Response on success

 {
    type: 'limit',
    state: closed',
    baseAmount: -200000000, // Sold 2.00000000 BTC...
    quoteAmount: 74526,     // ... for 745.26 USD
    baseCurrency: 'BTC'     // Currency of the baseAmount
    quoteCurrency: 'USD'    // Currency of the quoteAmount
    feeAmount: 11,          // Paid 0.11 USD to the exchange as commission for the order
    feeCurrency: 'USD',     // Currency of the feeAmount
    raw: {}                 // Exchange-specific object
 }

List Transactions

Returns a list of 'deposit' and 'withdrawal' type transaction objects, starting from the latest one, descending, fetched from your ItBit account. If the latestTransaction is provided, then fetch the transactions from the provided one, onwards. This is made according to the logic that in your system you have the latest transaction, and you want to fetch all the transaction, from your ItBit account, that happened after this transaction.

If this object parameter is not provided (null), return ALL transactions from the account.

Input parameters

This object only has the required fields

var latestTransaction = {
    raw: {
    	time: '2015-02-18T23:43:37.1230000'
    }
};

Example call

itBitExchange.listTransactions(latestTransaction, function (err, data) {
  if (err) {
    console.log(err);
  } else {
    console.log(data);
    console.log(data.length); // to see the number of transactions found
  }
});

Response on success

[
  {
    externalId: '1234-2345-3456-4567',
    state: 'relayed',
    amount: 400000,       // Transaction of 4,000.00 USD
    currency: 'USD',
    type: 'deposit',      // Transaction type. Can be 'deposit' or 'withdrawal'
    raw: {}              // Exchange-specific object
  },
  {
    externalId: '2345-3456-457-5678',
    state: 'completed'
    amount: -2000000000, // Transaction of 20 BTC
    currency: 'BTC',
    type: 'withdrawal',
    raw: {}
   }
   // ... more transactions
]

Place trade

Place a limit BUY or SELL trade (order), depending on the sign of the baseAmount argument. SELL if amount is negative BUY if amount is positive

Input parameters

{int} baseAmount: The amount in base currency to buy or sell on the exchange; If negative amount, place sell limit order. If positive amount, place buy limit order. Denominated in smallest sub-unit of the base currency

{float} limitPrice: The minimum/maximum rate that you want to sell/buy for. If baseAmount is negative, this is the minimum rate to sell for. If baseAmount is positive, this is the maximum rate to buy for. limitPrice must always strictly positive

{string} baseCurrency: The currency of the base amount. {string} quoteCurrency: The currency of the quote amount.

Example call

itBitExchange.placeTrade(-1250000, 460.00, 'BTC', 'USD', function (err, data) {
    if (err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

Response on success

{
  type: 'limit',
  state: 'open',
  baseAmount: 123456789,  // Buy 1.23456789 BTC
  baseCurrency: 'BTC',    // Currency of the baseAmount
  quoteCurrency: 'USD',   // Currency of the quoteAmount
  limitPrice: 500.00,     // Buy bitcoins at a maximum price of 500 USD/BTC
  raw: {}
}

Enjoy!

Disclaimer

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.