consequunturatque
Version:
A JavaScript / Python / PHP cryptocurrency trading library with support for 130+ exchanges
413 lines (390 loc) • 16.2 kB
JavaScript
'use strict';
// ---------------------------------------------------------------------------
const Exchange = require ('./base/Exchange');
const { ExchangeError, InsufficientFunds, InvalidOrder, AuthenticationError, PermissionDenied, InvalidNonce, OrderNotFound, DDoSProtection } = require ('./base/errors');
const Precise = require ('./base/Precise');
// ---------------------------------------------------------------------------
module.exports = class btcbox extends Exchange {
describe () {
return this.deepExtend (super.describe (), {
'id': 'btcbox',
'name': 'BtcBox',
'countries': [ 'JP' ],
'rateLimit': 1000,
'version': 'v1',
'has': {
'cancelOrder': true,
'CORS': false,
'createOrder': true,
'fetchBalance': true,
'fetchOpenOrders': true,
'fetchOrder': true,
'fetchOrderBook': true,
'fetchOrders': true,
'fetchTicker': true,
'fetchTickers': false,
'fetchTrades': true,
},
'urls': {
'logo': 'https://user-images.githubusercontent.com/51840849/87327317-98c55400-c53c-11ea-9a11-81f7d951cc74.jpg',
'api': 'https://www.btcbox.co.jp/api',
'www': 'https://www.btcbox.co.jp/',
'doc': 'https://blog.btcbox.jp/en/archives/8762',
'fees': 'https://support.btcbox.co.jp/hc/en-us/articles/360001235694-Fees-introduction',
},
'api': {
'public': {
'get': [
'depth',
'orders',
'ticker',
],
},
'private': {
'post': [
'balance',
'trade_add',
'trade_cancel',
'trade_list',
'trade_view',
'wallet',
],
},
},
'markets': {
'BTC/JPY': { 'id': 'btc', 'symbol': 'BTC/JPY', 'base': 'BTC', 'quote': 'JPY', 'baseId': 'btc', 'quoteId': 'jpy', 'taker': 0.05 / 100, 'maker': 0.05 / 100 },
'ETH/JPY': { 'id': 'eth', 'symbol': 'ETH/JPY', 'base': 'ETH', 'quote': 'JPY', 'baseId': 'eth', 'quoteId': 'jpy', 'taker': 0.10 / 100, 'maker': 0.10 / 100 },
'LTC/JPY': { 'id': 'ltc', 'symbol': 'LTC/JPY', 'base': 'LTC', 'quote': 'JPY', 'baseId': 'ltc', 'quoteId': 'jpy', 'taker': 0.10 / 100, 'maker': 0.10 / 100 },
'BCH/JPY': { 'id': 'bch', 'symbol': 'BCH/JPY', 'base': 'BCH', 'quote': 'JPY', 'baseId': 'bch', 'quoteId': 'jpy', 'taker': 0.10 / 100, 'maker': 0.10 / 100 },
},
'exceptions': {
'104': AuthenticationError,
'105': PermissionDenied,
'106': InvalidNonce,
'107': InvalidOrder, // price should be an integer
'200': InsufficientFunds,
'201': InvalidOrder, // amount too small
'202': InvalidOrder, // price should be [0 : 1000000]
'203': OrderNotFound,
'401': OrderNotFound, // cancel canceled, closed or non-existent order
'402': DDoSProtection,
},
});
}
async fetchBalance (params = {}) {
await this.loadMarkets ();
const response = await this.privatePostBalance (params);
const result = { 'info': response };
const codes = Object.keys (this.currencies);
for (let i = 0; i < codes.length; i++) {
const code = codes[i];
const currency = this.currency (code);
const currencyId = currency['id'];
const free = currencyId + '_balance';
if (free in response) {
const account = this.account ();
const used = currencyId + '_lock';
account['free'] = this.safeString (response, free);
account['used'] = this.safeString (response, used);
result[code] = account;
}
}
return this.parseBalance (result, false);
}
async fetchOrderBook (symbol, limit = undefined, params = {}) {
await this.loadMarkets ();
const market = this.market (symbol);
const request = {};
const numSymbols = this.symbols.length;
if (numSymbols > 1) {
request['coin'] = market['baseId'];
}
const response = await this.publicGetDepth (this.extend (request, params));
return this.parseOrderBook (response, symbol);
}
parseTicker (ticker, market = undefined) {
const timestamp = this.milliseconds ();
let symbol = undefined;
if (market !== undefined) {
symbol = market['symbol'];
}
const last = this.safeNumber (ticker, 'last');
return {
'symbol': symbol,
'timestamp': timestamp,
'datetime': this.iso8601 (timestamp),
'high': this.safeNumber (ticker, 'high'),
'low': this.safeNumber (ticker, 'low'),
'bid': this.safeNumber (ticker, 'buy'),
'bidVolume': undefined,
'ask': this.safeNumber (ticker, 'sell'),
'askVolume': undefined,
'vwap': undefined,
'open': undefined,
'close': last,
'last': last,
'previousClose': undefined,
'change': undefined,
'percentage': undefined,
'average': undefined,
'baseVolume': this.safeNumber (ticker, 'vol'),
'quoteVolume': this.safeNumber (ticker, 'volume'),
'info': ticker,
};
}
async fetchTicker (symbol, params = {}) {
await this.loadMarkets ();
const market = this.market (symbol);
const request = {};
const numSymbols = this.symbols.length;
if (numSymbols > 1) {
request['coin'] = market['baseId'];
}
const response = await this.publicGetTicker (this.extend (request, params));
return this.parseTicker (response, market);
}
parseTrade (trade, market = undefined) {
const timestamp = this.safeTimestamp (trade, 'date');
let symbol = undefined;
if (market !== undefined) {
symbol = market['symbol'];
}
const id = this.safeString (trade, 'tid');
const priceString = this.safeString (trade, 'price');
const amountString = this.safeString (trade, 'amount');
const price = this.parseNumber (priceString);
const amount = this.parseNumber (amountString);
const cost = this.parseNumber (Precise.stringMul (priceString, amountString));
const type = undefined;
const side = this.safeString (trade, 'type');
return {
'info': trade,
'id': id,
'order': undefined,
'timestamp': timestamp,
'datetime': this.iso8601 (timestamp),
'symbol': symbol,
'type': type,
'side': side,
'takerOrMaker': undefined,
'price': price,
'amount': amount,
'cost': cost,
'fee': undefined,
};
}
async fetchTrades (symbol, since = undefined, limit = undefined, params = {}) {
await this.loadMarkets ();
const market = this.market (symbol);
const request = {};
const numSymbols = this.symbols.length;
if (numSymbols > 1) {
request['coin'] = market['baseId'];
}
const response = await this.publicGetOrders (this.extend (request, params));
return this.parseTrades (response, market, since, limit);
}
async createOrder (symbol, type, side, amount, price = undefined, params = {}) {
await this.loadMarkets ();
const market = this.market (symbol);
const request = {
'amount': amount,
'price': price,
'type': side,
'coin': market['baseId'],
};
const response = await this.privatePostTradeAdd (this.extend (request, params));
//
// {
// "result":true,
// "id":"11"
// }
//
return this.parseOrder (response, market);
}
async cancelOrder (id, symbol = undefined, params = {}) {
await this.loadMarkets ();
// a special case for btcbox – default symbol is BTC/JPY
if (symbol === undefined) {
symbol = 'BTC/JPY';
}
const market = this.market (symbol);
const request = {
'id': id,
'coin': market['baseId'],
};
const response = await this.privatePostTradeCancel (this.extend (request, params));
//
// {"result":true, "id":"11"}
//
return this.parseOrder (response, market);
}
parseOrderStatus (status) {
const statuses = {
// TODO: complete list
'part': 'open', // partially or not at all executed
'all': 'closed', // fully executed
'cancelled': 'canceled',
'closed': 'closed', // never encountered, seems to be bug in the doc
'no': 'closed', // not clarified in the docs...
};
return this.safeString (statuses, status, status);
}
parseOrder (order, market = undefined) {
//
// {
// "id":11,
// "datetime":"2014-10-21 10:47:20",
// "type":"sell",
// "price":42000,
// "amount_original":1.2,
// "amount_outstanding":1.2,
// "status":"closed",
// "trades":[]
// }
//
const id = this.safeString (order, 'id');
const datetimeString = this.safeString (order, 'datetime');
let timestamp = undefined;
if (datetimeString !== undefined) {
timestamp = this.parse8601 (order['datetime'] + '+09:00'); // Tokyo time
}
const amount = this.safeNumber (order, 'amount_original');
const remaining = this.safeNumber (order, 'amount_outstanding');
const price = this.safeNumber (order, 'price');
// status is set by fetchOrder method only
let status = this.parseOrderStatus (this.safeString (order, 'status'));
// fetchOrders do not return status, use heuristic
if (status === undefined) {
if (remaining !== undefined && remaining === 0) {
status = 'closed';
}
}
const trades = undefined; // todo: this.parseTrades (order['trades']);
let symbol = undefined;
if (market !== undefined) {
symbol = market['symbol'];
}
const side = this.safeString (order, 'type');
return this.safeOrder ({
'id': id,
'clientOrderId': undefined,
'timestamp': timestamp,
'datetime': this.iso8601 (timestamp),
'lastTradeTimestamp': undefined,
'amount': amount,
'remaining': remaining,
'filled': undefined,
'side': side,
'type': undefined,
'timeInForce': undefined,
'postOnly': undefined,
'status': status,
'symbol': symbol,
'price': price,
'stopPrice': undefined,
'cost': undefined,
'trades': trades,
'fee': undefined,
'info': order,
'average': undefined,
});
}
async fetchOrder (id, symbol = undefined, params = {}) {
await this.loadMarkets ();
// a special case for btcbox – default symbol is BTC/JPY
if (symbol === undefined) {
symbol = 'BTC/JPY';
}
const market = this.market (symbol);
const request = this.extend ({
'id': id,
'coin': market['baseId'],
}, params);
const response = await this.privatePostTradeView (this.extend (request, params));
return this.parseOrder (response, market);
}
async fetchOrdersByType (type, symbol = undefined, since = undefined, limit = undefined, params = {}) {
await this.loadMarkets ();
// a special case for btcbox – default symbol is BTC/JPY
if (symbol === undefined) {
symbol = 'BTC/JPY';
}
const market = this.market (symbol);
const request = {
'type': type, // 'open' or 'all'
'coin': market['baseId'],
};
const response = await this.privatePostTradeList (this.extend (request, params));
const orders = this.parseOrders (response, market, since, limit);
// status (open/closed/canceled) is undefined
// btcbox does not return status, but we know it's 'open' as we queried for open orders
if (type === 'open') {
for (let i = 0; i < orders.length; i++) {
orders[i]['status'] = 'open';
}
}
return orders;
}
async fetchOrders (symbol = undefined, since = undefined, limit = undefined, params = {}) {
return await this.fetchOrdersByType ('all', symbol, since, limit, params);
}
async fetchOpenOrders (symbol = undefined, since = undefined, limit = undefined, params = {}) {
return await this.fetchOrdersByType ('open', symbol, since, limit, params);
}
nonce () {
return this.milliseconds ();
}
sign (path, api = 'public', method = 'GET', params = {}, headers = undefined, body = undefined) {
let url = this.urls['api'] + '/' + this.version + '/' + path;
if (api === 'public') {
if (Object.keys (params).length) {
url += '?' + this.urlencode (params);
}
} else {
this.checkRequiredCredentials ();
const nonce = this.nonce ().toString ();
const query = this.extend ({
'key': this.apiKey,
'nonce': nonce,
}, params);
const request = this.urlencode (query);
const secret = this.hash (this.encode (this.secret));
query['signature'] = this.hmac (this.encode (request), this.encode (secret));
body = this.urlencode (query);
headers = {
'Content-Type': 'application/x-www-form-urlencoded',
};
}
return { 'url': url, 'method': method, 'body': body, 'headers': headers };
}
handleErrors (httpCode, reason, url, method, headers, body, response, requestHeaders, requestBody) {
if (response === undefined) {
return; // resort to defaultErrorHandler
}
// typical error response: {"result":false,"code":"401"}
if (httpCode >= 400) {
return; // resort to defaultErrorHandler
}
const result = this.safeValue (response, 'result');
if (result === undefined || result === true) {
return; // either public API (no error codes expected) or success
}
const code = this.safeValue (response, 'code');
const feedback = this.id + ' ' + body;
this.throwExactlyMatchedException (this.exceptions, code, feedback);
throw new ExchangeError (feedback); // unknown message
}
async request (path, api = 'public', method = 'GET', params = {}, headers = undefined, body = undefined) {
let response = await this.fetch2 (path, api, method, params, headers, body);
if (typeof response === 'string') {
// sometimes the exchange returns whitespace prepended to json
response = this.strip (response);
if (!this.isJsonEncodedObject (response)) {
throw new ExchangeError (this.id + ' ' + response);
}
response = JSON.parse (response);
}
return response;
}
};