Node Bittrex API is an asynchronous node.js library for the Bittrex API - https://bittrex.com/. The Bittrex API data can be received either as a GET request or a Stream.
Documentation to the Bittrex API: https://bittrex.com/Home/Api
install it most convenient via npm:
$ npm install node.bittrex.apifetch the project via git:
$ git clone https://github.com/n0mad01/node.bittrex.api.gitthen meet the package dependencies:
$ cd node-bittrex-api/
$ npm installinclude node.bittrex.api.js into your project:
var bittrex = require('./node.bittrex.api.js');bittrex.options({
'apikey' : API_KEY,
'apisecret' : API_SECRET,
'stream' : true,
'verbose' : true,
'cleartext' : false
});By default the returned data is an object, in order to get clear text you have to add the option cleartext (streams will always return objects):
'cleartext' : trueThe baseUrl itself can also be set via options
'baseUrl' : 'https://bittrex.com/api/v1'To activate Streaming simply add to your options:
'stream' : trueStreaming depends on the following npm packages:
- JSONStream https://www.npmjs.org/package/JSONStream
- event-stream https://www.npmjs.org/package/event-stream
After configuration you can use the object right away: example #1
bittrex.getmarketsummaries( function( data ) {
for( var i in data.result ) {
bittrex.getticker( { market : data.result[i].MarketName }, function( ticker ) {
console.log( ticker );
});
}
});example #2
bittrex.getbalance({ currency : 'BTC' }, function( data ) {
console.log( data );
});Other libraries utilized:
For HmacSHA512 this package is using a part of Crypto.js from google because the node crpyt package could not provide any appropriate result.
Optional parameters may have to be looked up at https://bittrex.com/Home/Api.
Not all Bittrex API methods are implemented yet (and may never be), also some could have been forgotten in the documentation ( therefore i recomend you to consult the class code ).
Nonetheless the method sendCustomRequest enables completely custom requests anyway.
- url String
- callback Function
- credentials Boolean optional whether the credentials should be applied to the request/stream or not, default is set to false.
example #1
var url = 'https://bittrex.com/api/v1.1/public/getticker?market=BTC-LTC';
bittrex.sendCustomRequest( uri, function( data ) {
console.log( data );
});example #2 (credentials applied to request/stream)
bittrex.sendCustomRequest( 'https://bittrex.com/api/v1.1/account/getbalances?currency=BTC', function( data ) {
console.log( data );
}, true );
will result in (the Header is being set too):
https://bittrex.com/api/v1.1/account/getbalances?currency=BTC&apikey=API_KEY&nonce=4456490600bittrex.getticker( { market : 'BTC-LTC' }, function( data ) {
console.log( data );
});bittrex.getbalances( function( data ) {
console.log( data );
});bittrex.getmarkethistory({ market : 'BTC-LTC', count : 3 }, function( data ) {
console.log( data );
});bittrex.getmarketsummaries( function( data ) {
console.log( data );
});bittrex.getorderbook({ market : 'BTC-LTC', depth : 10, type : 'both' }, function( data ) {
console.log( data );
});bittrex.getwithdrawalhistory({ currency : 'BTC', count : 1 }, function( data ) {
console.log( data );
});bittrex.getdepositaddress({ currency : 'BTC' }, function( data ) {
console.log( data );
});bittrex.getbalance({ currency : 'BTC' }, function( data ) {
console.log( data );
});BTC
1N5T2VYACYKxK3UUDHhp7g69qtUmsDdAjZ