bd

btce-deal

BTC-E API Wrapper for Node.js

Showing:

Popularity

Downloads/wk

11

GitHub Stars

8

Maintenance

Last Commit

4yrs ago

Contributors

3

Package

Dependencies

1

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

BTC-E API Wrapper for Node.js

API wrapper to BTC-E Cryptocoin Trading platform.

Features


Usage

Install

$ npm install --save btce-deal

Init

BTC-E Deal provides separate objects for access to the Public and Trade API.

var BTCE = require('btce-deal');

var btcePublic = new BTCE.Public(),
    btceTrade = new BTCE.Trade('YOUR-KEY', 'YOUR-SECRET');

Setting alternative domain

var host = 'new domain';

var btcePublic = new BTCE.Public(host),
    btceTrade = new BTCE.Trade('YOUR-KEY', 'YOUR-SECRET', host);

All methods return a Promise object (bluebird implementation).

btcePublic.getInfo()
    .then(function (data) {
        // success handling
    })
    .catch(function (data) {
        // error handling
    });

btceTrade.getInfo()
    .then(callback)
    .catch(callback);

Public API

pairs
Type: Array or String
Default: 'btc_usd'

More information about the parameters can be found in BTC-E Public API documentation.

Get info

btcePublic.getInfo();

Get ticker

btcePublic.getTicker();
btcePublic.getTicker('btc_usd');
btcePublic.getTicker(['btc_usd', 'ltc_usd']);

// etc.

Get depth

params
Type: Object or Number

btcePublic.getDepth();
btcePublic.getDepth('btc_usd', {limit: 10});
btcePublic.getDepth(['btc_usd', 'ltc_usd'], 10);

// etc.

Get trades

params
Type: Object or Number

btcePublic.getTrades();
btcePublic.getTrades('btc_usd', 2);
btcePublic.getTrades(['btc_usd', 'ltc_usd'], {limit: 2});

// etc.

Trade API

More information about the parameters can be found in BTC-E Trade API documentation.

Get trade info

btceTrade.getInfo();

Get transaction history

btceTrade.getTransHistory();
btceTrade.getTransHistory({count: 10, order: 'DESC'});

// etc.

Get trade history

btceTrade.getTradeHistory();
btceTrade.getTradeHistory({pair: 'btc_usd', order: 'ASC', since: Date.now()});

// etc.

Get active orders

params
Type: Object or String

btceTrade.getActiveOrders();
btceTrade.getActiveOrders('btc_usd');
btceTrade.getActiveOrders({pair: 'btc_usd'});

// etc.

Trade

btceTrade.trade({pair: 'btc_usd', type: 'buy', rate: 100.0, amount: 2.0});
btceTrade.trade({pair: 'ltc_usd', type: 'sell', rate: 15.9, amount: 10.7});

// etc.

Cancel order

params
Type: Object or Number

btceTrade.cancelOrder(343154);
btceTrade.cancelOrder({order_id: 343154});

// etc.

Get order info

params
Type: Object or Number

btceTrade.getOrderInfo(343154);
btceTrade.getOrderInfo({order_id: 343154});

// etc.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial