astro-perp-ccxt-dev
Version:
2,602 lines • 111 kB
JavaScript
'use strict';
var btcex$1 = require('./abstract/btcex.js');
var number = require('./base/functions/number.js');
var errors = require('./base/errors.js');
var Precise = require('./base/Precise.js');
// ---------------------------------------------------------------------------
class btcex extends btcex$1 {
describe() {
return this.deepExtend(super.describe(), {
'id': 'btcex',
'name': 'BTCEX',
'countries': ['CA'],
'version': 'v1',
'certified': false,
'pro': true,
'requiredCredentials': {
'apiKey': true,
'secret': true,
},
'urls': {
'logo': 'https://user-images.githubusercontent.com/1294454/173489620-d49807a4-55cd-4f4e-aca9-534921298bbf.jpg',
'www': 'https://www.btcex.com/',
'api': {
'rest': 'https://api.btcex.com',
},
'doc': 'https://docs.btcex.com/',
'fees': 'https://support.btcex.com/hc/en-us/articles/4415995130647',
'referral': {
'url': 'https://www.btcex.com/en-us/register?i=48biatg1',
'discount': 0.1,
},
},
'has': {
'CORS': undefined,
'spot': true,
'margin': true,
'swap': true,
'future': true,
'option': true,
'cancelAllOrders': true,
'cancelOrder': true,
'createLimitBuyOrder': true,
'createLimitSellOrder': true,
'createMarketBuyOrder': true,
'createMarketSellOrder': true,
'createOrder': true,
'createPostOnlyOrder': true,
'createReduceOnlyOrder': true,
'createStopLimitOrder': true,
'createStopMarketOrder': true,
'createStopOrder': true,
'editOrder': false,
'fetchBalance': true,
'fetchBorrowRate': false,
'fetchBorrowRateHistories': false,
'fetchBorrowRateHistory': false,
'fetchBorrowRates': false,
'fetchClosedOrders': true,
'fetchCurrencies': false,
'fetchDepositAddress': false,
'fetchDeposits': true,
'fetchFundingHistory': false,
'fetchFundingRate': true,
'fetchFundingRateHistory': false,
'fetchFundingRates': true,
'fetchIndexOHLCV': false,
'fetchLeverage': true,
'fetchLeverageTiers': true,
'fetchMarginMode': false,
'fetchMarketLeverageTiers': true,
'fetchMarkets': true,
'fetchMarkOHLCV': false,
'fetchMyTrades': true,
'fetchOHLCV': true,
'fetchOpenInterest': true,
'fetchOpenInterestHistory': false,
'fetchOpenOrders': true,
'fetchOrder': true,
'fetchOrderBook': true,
'fetchOrders': true,
'fetchOrderTrades': true,
'fetchPosition': true,
'fetchPositionMode': false,
'fetchPositions': true,
'fetchPremiumIndexOHLCV': false,
'fetchTicker': true,
'fetchTickers': false,
'fetchTime': false,
'fetchTrades': true,
'fetchTradingFee': false,
'fetchTradingFees': false,
'fetchTransactionFees': undefined,
'fetchWithdrawal': true,
'fetchWithdrawals': true,
'setLeverage': true,
'setMarginMode': true,
'signIn': true,
'transfer': true,
'withdraw': false,
},
'timeframes': {
'1m': '1',
'3m': '3',
'5m': '5',
'15m': '15',
'30m': '30',
'1h': '60',
'2h': '120',
'3h': '180',
'4h': '240',
'6h': '360',
'12h': '720',
'1d': '1D',
'3d': '3D',
'1M': '30D',
},
'api': {
'public': {
'get': [
// Market data
'get_last_trades_by_currency',
'get_last_trades_by_instrument',
'get_order_book',
'tickers',
'get_instruments',
'get_tradingview_chart_data',
// CMC
'cmc_spot_summary',
'cmc_spot_ticker',
'cmc_spot_orderbook',
'cmc_market_trades',
'cmc_contracts',
'cmc_contract_orderbook',
// CoinGecko
'coin_gecko_spot_pairs',
'coin_gecko_spot_ticker',
'coin_gecko_spot_orderbook',
'coin_gecko_market_trades',
'coin_gecko_contracts',
'coin_gecko_contract_orderbook',
'get_perpetual_leverage_bracket',
'get_perpetual_leverage_bracket_all',
],
'post': [
'auth',
],
},
'private': {
'get': [
// wallet
'get_deposit_record',
'get_withdraw_record',
// trade
'get_position',
'get_positions',
'get_open_orders_by_currency',
'get_open_orders_by_instrument',
'get_order_history_by_currency',
'get_order_history_by_instrument',
'get_order_state',
'get_user_trades_by_currency',
'get_user_trades_by_instrument',
'get_user_trades_by_order',
'get_perpetual_user_config',
],
'post': [
// auth
'logout',
// wallet
'get_assets_info',
'add_withdraw_address',
// trade
'buy',
'sell',
'cancel',
'cancel_all_by_currency',
'cancel_all_by_instrument',
'close_position',
'adjust_perpetual_leverage',
'adjust_perpetual_margin_type',
'submit_transfer',
],
'delete': [],
},
},
'fees': {
'trading': {
'tierBased': false,
'percentage': true,
'maker': this.parseNumber('0.001'),
'taker': this.parseNumber('0.001'),
},
'margin': {
'tierBased': false,
'percentage': true,
'maker': this.parseNumber('0.001'),
'taker': this.parseNumber('0.001'),
},
'perpetual': {
'tierBased': false,
'percentage': true,
'maker': this.parseNumber('0.002'),
'taker': this.parseNumber('0.002'),
},
},
'exceptions': {
'exact': {
'9999': errors.ExchangeError,
'9900': errors.ExchangeNotAvailable,
'401': errors.AuthenticationError,
'403': errors.AuthenticationError,
'1000': errors.ExchangeNotAvailable,
'1001': errors.BadRequest,
'1005': errors.DDoSProtection,
'2000': errors.AuthenticationError,
'2001': errors.AuthenticationError,
'2002': errors.AuthenticationError,
'2003': errors.AuthenticationError,
'2010': errors.PermissionDenied,
'3000': errors.AuthenticationError,
'3002': errors.AuthenticationError,
'3003': errors.AuthenticationError,
'3004': errors.BadRequest,
'3005': errors.NotSupported,
'3007': errors.AuthenticationError,
'3008': errors.AuthenticationError,
'3009': errors.AuthenticationError,
'3011': errors.AuthenticationError,
'3012': errors.AuthenticationError,
'3013': errors.RequestTimeout,
'3015': errors.AuthenticationError,
'3016': errors.AuthenticationError,
'3018': errors.BadRequest,
'3019': errors.BadRequest,
'3020': errors.BadRequest,
'3021': errors.BadRequest,
'3022': errors.BadRequest,
'3023': errors.BadRequest,
'3024': errors.BadRequest,
'3025': errors.BadRequest,
'3026': errors.BadRequest,
'3027': errors.BadRequest,
'3028': errors.BadRequest,
'3029': errors.DDoSProtection,
'3030': errors.DDoSProtection,
'3031': errors.BadRequest,
'3032': errors.BadRequest,
'3033': errors.BadRequest,
'3034': errors.AuthenticationError,
'3035': errors.BadRequest,
'3036': errors.BadRequest,
'3037': errors.BadRequest,
'3038': errors.BadRequest,
'3039': errors.BadRequest,
'3040': errors.AuthenticationError,
'3041': errors.BadRequest,
'4000': errors.BadRequest,
'4001': errors.InvalidAddress,
'4002': errors.InvalidAddress,
'4003': errors.BadRequest,
'4004': errors.NotSupported,
'4005': errors.ExchangeError,
'4006': errors.InsufficientFunds,
'4007': errors.BadRequest,
'4008': errors.NotSupported,
'4009': errors.InvalidAddress,
'4010': errors.BadRequest,
'4011': errors.BadRequest,
'5001': errors.InvalidOrder,
'5002': errors.OrderNotFound,
'5003': errors.InvalidOrder,
'5004': errors.InvalidOrder,
'5005': errors.InvalidOrder,
'5006': errors.InvalidOrder,
'5007': errors.InvalidOrder,
'5008': errors.InvalidOrder,
'5009': errors.InvalidOrder,
'5010': errors.InvalidOrder,
'5011': errors.InvalidOrder,
'5012': errors.InvalidOrder,
'5013': errors.InvalidOrder,
'5014': errors.InvalidOrder,
'5109': errors.InvalidOrder,
'5119': errors.InvalidOrder,
'5135': errors.InvalidOrder,
'5901': errors.InvalidOrder,
'5902': errors.InvalidOrder,
'5903': errors.InvalidOrder,
'5904': errors.InvalidOrder,
'5905': errors.InvalidOrder,
'5906': errors.InvalidOrder,
'5907': errors.InsufficientFunds,
'8000': errors.BadRequest,
'8001': errors.BadRequest,
'8100': errors.BadRequest,
'8101': errors.RequestTimeout,
'8102': errors.DDoSProtection,
'8103': errors.BadRequest,
'8104': errors.BadRequest,
'8105': errors.BadRequest,
'8106': errors.DDoSProtection,
'8107': errors.ExchangeError,
'10000': errors.AuthenticationError,
'11000': errors.BadRequest, // CHANNEL_REGEX_ERROR channel regex not match
},
'broad': {},
},
'precisionMode': number.TICK_SIZE,
'options': {
'accountsByType': {
'wallet': 'WALLET',
'spot': 'SPOT',
'perpetual': 'PERPETUAL',
'margin': 'MARGIN',
'swap': 'PERPETUAL',
'BTC': 'BTC',
'ETH': 'ETH',
},
'createMarketBuyOrderRequiresPrice': true,
},
'commonCurrencies': {
'ALT': 'ArchLoot',
},
});
}
async fetchMarkets(params = {}) {
const response = await this.publicGetGetInstruments(params);
const markets = this.safeValue(response, 'result', []);
//
// {
// "jsonrpc":"2.0",
// "usIn":1647533492507,
// "usOut":1647533492511,
// "usDiff":4,
// "result":[{
// "currency":"BTC",
// "base_currency":"USDT",
// "contract_size":"0.01",
// "creation_timestamp":"1632384961348",
// "expiration_timestamp":"1648195200000",
// "instrument_name":"BTC-25MAR22",
// "show_name":"BTC-25MAR22",
// "is_active":true,
// "kind":"future",
// "leverage":0,
// "maker_commission":"10",
// "taker_commission":"17",
// "min_trade_amount":"0.01",
// "option_type":"init",
// "quote_currency":"USDT",
// "settlement_period":"week",
// "strike":"0",
// "tick_size":"0.1",
// "instr_multiple":"0.01",
// "order_price_low_rate":"0.8",
// "order_price_high_rate":"1.2",
// "order_price_limit_type":0,
// "min_qty":"0.01",
// "min_notional":"0",
// "support_trace_trade":false
// }]
// }
//
const result = [];
for (let i = 0; i < markets.length; i++) {
const market = markets[i];
const id = this.safeString(market, 'instrument_name');
const type = this.safeString(market, 'kind');
let unifiedType = type;
if (type === 'perpetual') {
unifiedType = 'swap';
}
let baseId = this.safeString(market, 'quote_currency');
const quoteId = this.safeString(market, 'base_currency');
const swap = (type === 'perpetual');
const spot = (type === 'spot');
const margin = (type === 'margin');
const option = (type === 'option');
const future = (type === 'future');
const contract = swap || future || option;
let expiry = undefined;
if (option || future) {
baseId = this.safeString(market, 'currency');
expiry = this.safeInteger(market, 'expiration_timestamp');
}
let contractSize = undefined;
let settleId = undefined;
let settle = undefined;
if (contract) {
settleId = quoteId;
settle = this.safeCurrencyCode(settleId);
}
let optionType = undefined;
let strike = undefined;
if (option) {
optionType = this.safeString(market, 'option_type');
strike = this.safeNumber(market, 'strike');
}
const base = this.safeCurrencyCode(baseId);
const quote = this.safeCurrencyCode(quoteId);
let symbol = undefined;
if (margin) {
symbol = id;
}
else {
symbol = base + '/' + quote;
}
if (contract) {
contractSize = this.safeNumber(market, 'contract_size');
symbol = symbol + ':' + settle;
if (future || option) {
symbol = symbol + '-' + this.yymmdd(expiry);
if (option) {
const letter = (optionType === 'call') ? 'C' : 'P';
symbol = symbol + ':' + this.numberToString(strike) + ':' + letter;
}
}
}
const minTradeAmount = this.safeNumber(market, 'min_trade_amount');
const tickSize = this.safeNumber(market, 'tick_size');
const maker = this.safeNumber(market, 'maker_commission');
const taker = this.safeNumber(market, 'taker_commission');
const percentage = !(option || future);
result.push({
'id': id,
'symbol': symbol,
'base': base,
'quote': quote,
'baseId': baseId,
'quoteId': quoteId,
'settleId': settleId,
'settle': settle,
'type': unifiedType,
'maker': maker,
'taker': taker,
'percentage': percentage,
'spot': spot,
'margin': margin,
'swap': swap,
'future': future,
'option': option,
'active': this.safeValue(market, 'is_active'),
'contract': contract,
'linear': contract ? true : undefined,
'inverse': contract ? false : undefined,
'contractSize': contractSize,
'expiry': expiry,
'expiryDatetime': this.iso8601(expiry),
'strike': strike,
'optionType': optionType,
'precision': {
'amount': minTradeAmount,
'price': tickSize,
},
'limits': {
'leverage': {
'min': undefined,
'max': this.safeString(market, 'leverage'),
},
'amount': {
'min': minTradeAmount,
'max': undefined,
},
'price': {
'min': tickSize,
'max': undefined,
},
'cost': {
'min': undefined,
'max': undefined,
},
},
'info': market,
});
}
return result;
}
parseTicker(ticker, market = undefined) {
//
// {
// "best_ask_amount":"0.20962",
// "best_ask_price":"40491.7",
// "best_bid_amount":"0.08855",
// "best_bid_price":"40491.6",
// "instrument_name":"BTC-USDT",
// "last_price":"40493",
// "mark_price":"40493.10644717",
// "state":"open",
// "stats":{
// "high":"41468.8",
// "low":"40254.9",
// "price_change":"-0.0159",
// "volume":"3847.35240000000000005"
// "turnover":"1109811189.67100102035328746"
// },
// "timestamp":"1647569486224"
// }
//
let marketId = this.safeString(ticker, 'instrument_name');
if (marketId.indexOf('PERPETUAL') < 0) {
marketId = marketId + '-SPOT';
}
market = this.safeMarket(marketId, market);
const symbol = this.safeSymbol(marketId, market, '-');
const timestamp = this.safeInteger(ticker, 'timestamp');
const stats = this.safeValue(ticker, 'stats');
return this.safeTicker({
'symbol': symbol,
'timestamp': timestamp,
'datetime': this.iso8601(timestamp),
'high': this.safeString(stats, 'high'),
'low': this.safeString(stats, 'low'),
'bid': this.safeString(ticker, 'best_bid_price'),
'bidVolume': this.safeString(ticker, 'best_bid_amount'),
'ask': this.safeString(ticker, 'best_ask_price'),
'askVolume': this.safeString(ticker, 'best_ask_amount'),
'vwap': undefined,
'open': undefined,
'close': this.safeString(ticker, 'last_price'),
'last': this.safeString(ticker, 'last_price'),
'previousClose': undefined,
'change': undefined,
'percentage': this.safeString(stats, 'price_change'),
'average': undefined,
'baseVolume': this.safeString(stats, 'volume'),
'quoteVolume': this.safeString(stats, 'turnover'),
'info': ticker,
}, market);
}
async fetchTicker(symbol, params = {}) {
await this.loadMarkets();
const market = this.market(symbol);
const request = {
'instrument_name': market['id'],
};
const response = await this.publicGetTickers(this.extend(request, params));
const result = this.safeValue(response, 'result', {});
//
// {
// "jsonrpc":"2.0",
// "usIn":1647569487238,
// "usOut":1647569487240,
// "usDiff":2,
// "result":[{
// "best_ask_amount":"0.20962",
// "best_ask_price":"40491.7",
// "best_bid_amount":"0.08855",
// "best_bid_price":"40491.6",
// "instrument_name":"BTC-USDT",
// "last_price":"40493",
// "mark_price":"40493.10644717",
// "state":"open",
// "stats":{
// "high":"41468.8",
// "low":"40254.9",
// "price_change":"-0.0159",
// "volume":"3847.35240000000000005"
// },
// "timestamp":"1647569486224"
// }]
// }
//
const ticker = this.safeValue(result, 0);
return this.parseTicker(ticker, market);
}
async fetchOrderBook(symbol, limit = undefined, params = {}) {
await this.loadMarkets();
const market = this.market(symbol);
const request = {
'instrument_name': market['id'],
};
if (limit !== undefined) {
request['depth'] = limit;
}
const response = await this.publicGetGetOrderBook(this.extend(request, params));
const result = this.safeValue(response, 'result', {});
//
// {
// "jsonrpc":"2.0",
// "usIn":1647573916524,
// "usOut":1647573916526,
// "usDiff":2,
// "result":{
// "asks":[["10155.00000","0.200","186.980","0.000"],["10663.00000","0.200","217.480","0.000"]],
// "bids":[["7896.00000","0.200","1.000","0.000"],["7481.00000","0.200","1.000","0.000"]],
// "timestamp":"1647573916525",
// "instrument_name":"BTC-25MAR22-32000-C",
// "version":1002541
// }
// }
//
const timestamp = this.safeInteger(result, 'timestamp');
const orderBook = this.parseOrderBook(result, market['symbol'], timestamp);
orderBook['nonce'] = this.safeInteger(result, 'version');
return orderBook;
}
parseOHLCV(ohlcv, market = undefined) {
//
// {
// "tick":1647547200,
// "open":"40868.16800000",
// "high":"40877.65600000",
// "low":"40647.00000000",
// "close":"40699.10000000",
// "volume":"100.27789000",
// "cost":"4083185.78337596"
// }
//
return [
this.safeTimestamp(ohlcv, 'tick'),
this.safeNumber(ohlcv, 'open'),
this.safeNumber(ohlcv, 'high'),
this.safeNumber(ohlcv, 'low'),
this.safeNumber(ohlcv, 'close'),
this.safeNumber(ohlcv, 'volume'),
];
}
async fetchOHLCV(symbol, timeframe = '1m', since = undefined, limit = undefined, params = {}) {
await this.loadMarkets();
const market = this.market(symbol);
if (limit === undefined) {
limit = 10;
}
const request = {
'resolution': this.safeString(this.timeframes, timeframe, timeframe),
// 'start_timestamp': 0,
// 'end_timestamp': 0,
};
let marketId = market['id'];
if (market['spot'] || market['margin']) {
marketId = market['baseId'] + '-' + market['quoteId'];
}
request['instrument_name'] = marketId;
if (since === undefined) {
request['end_timestamp'] = this.milliseconds();
request['start_timestamp'] = 0;
}
else {
const timeframeInSeconds = this.parseTimeframe(timeframe);
const timeframeInMilliseconds = timeframeInSeconds * 1000;
request['start_timestamp'] = since;
request['end_timestamp'] = this.sum(request['start_timestamp'], limit * timeframeInMilliseconds);
}
const response = await this.publicGetGetTradingviewChartData(this.extend(request, params));
const result = this.safeValue(response, 'result', []);
//
// {
// "jsonrpc":"2.0",
// "usIn":1647578562427,
// "usOut":1647578562428,
// "usDiff":1,
// "result":[{
// "tick":1647547200,
// "open":"40868.16800000",
// "high":"40877.65600000",
// "low":"40647.00000000",
// "close":"40699.10000000",
// "volume":"100.27789000",
// "cost":"4083185.78337596"
// }]
// }
//
return this.parseOHLCVs(result, market, timeframe, since, limit);
}
parseTrade(trade, market = undefined) {
//
// fetchTrades (public)
//
// {
// "amount":"0.0003",
// "direction":"sell",
// "iv":"0",
// "price":"40767.18",
// "timestamp":"1647582687050",
// "instrument_name":"BTC-USDT-SPOT",
// "trade_id":57499240
// }
//
// fetchOrderTrades || fetchMyTrades
//
// {
// "direction":"sell",
// "amount":"0.03",
// "price":"397.8",
// "fee":"0.011934",
// "timestamp":1647668570759,
// "role":"taker",
// "trade_id":"58319385",
// "order_id":"250979478947823616",
// "instrument_name":"BNB-USDT-SPOT",
// "order_type":"market",
// "fee_use_coupon":false,
// "fee_coin_type":"USDT",
// "index_price":"",
// "self_trade":false
// }
//
const id = this.safeString(trade, 'trade_id');
const marketId = this.safeString(trade, 'instrument_name');
const symbol = this.safeSymbol(marketId, market);
const timestamp = this.safeInteger(trade, 'timestamp');
const side = this.safeString(trade, 'direction');
const priceString = this.safeString(trade, 'price');
const amountString = this.safeString(trade, 'amount');
const takerOrMaker = this.safeString(trade, 'role');
const feeCostString = this.safeString(trade, 'fee');
let fee = undefined;
if (feeCostString !== undefined) {
const feeCurrencyId = this.safeString(trade, 'fee_coin_type');
const feeCurrencyCode = this.safeCurrencyCode(feeCurrencyId);
fee = {
'cost': feeCostString,
'currency': feeCurrencyCode,
};
}
return this.safeTrade({
'info': trade,
'id': id,
'timestamp': timestamp,
'datetime': this.iso8601(timestamp),
'symbol': symbol,
'order': this.safeString(trade, 'order_id'),
'type': this.safeString(trade, 'order_type'),
'side': side,
'takerOrMaker': takerOrMaker,
'price': priceString,
'amount': amountString,
'cost': undefined,
'fee': fee,
}, market);
}
async fetchTrades(symbol, since = undefined, limit = undefined, params = {}) {
await this.loadMarkets();
const market = this.market(symbol);
const request = {
'instrument_name': market['id'],
// 'start_id' : 0,
// 'end_id': 0,
// 'sorting': 'asc', // asc | desc
};
if (limit !== undefined) {
request['count'] = limit; // default 10
}
const response = await this.publicGetGetLastTradesByInstrument(this.extend(request, params));
const result = this.safeValue(response, 'result', {});
//
// {
// "jsonrpc":"2.0",
// "usIn":1647582703220,
// "usOut":1647582703253,
// "usDiff":33,
// "result":{
// "trades":[{
// "amount":"0.0003",
// "direction":"sell",
// "iv":"0",
// "price":"40767.18",
// "timestamp":"1647582687050",
// "instrument_name":"BTC-USDT-SPOT",
// "trade_id":57499240
// }],
// "has_more":true
// }
// }
//
const trades = this.safeValue(result, 'trades', []);
return this.parseTrades(trades, market, since, limit);
}
async signIn(params = {}) {
let accessToken = this.safeString(this.options, 'accessToken');
if (accessToken !== undefined) {
return accessToken;
}
this.checkRequiredCredentials();
const request = {
'grant_type': 'client_credentials',
'client_id': this.apiKey,
'client_secret': this.secret,
// 'refresh_token': '', // Required for grant type refresh_token
// 'signature': '', // Required for grant type client_signature
};
const response = await this.publicPostAuth(this.extend(request, params));
const result = this.safeValue(response, 'result');
//
// {
// jsonrpc: '2.0',
// usIn: '1647601525586',
// usOut: '1647601525597',
// usDiff: '11',
// result: {
// access_token: '',
// token_type: 'bearer',
// refresh_token: '',
// expires_in: '604799',
// scope: 'account:read_write block_trade:read_write trade:read_write wallet:read_write'
// }
// }
//
accessToken = this.safeString(result, 'access_token');
this.options['accessToken'] = accessToken;
return accessToken;
}
parseBalance(response) {
//
// {
// "WALLET":{
// "total":"0",
// "coupon":"0",
// "details":[{
// "available":"0",
// "freeze":"0",
// "coin_type":"1INCH",
// "current_mark_price":"1.657"
// }]
// },
// "MARGIN":{
// "total":"0",
// "net":"0",
// "available":"0",
// "borrowed":"0",
// "details":[],
// "maintenance_margin":"0",
// "interest_owed":"0"
// },
// "SPOT":{
// "total":"3.965",
// "available":"15.887066",
// "details":[{
// "available":"0",
// "freeze":"0",
// "total":"0",
// "coin_type":"1INCH",
// "current_mark_price":"1.657"
// }]
// },
// "BTC":{
// "currency":"BTC",
// "balance":"0",
// "freeze":"0",
// "equity":"0",
// "base_currency":"USDT",
// "available_funds":"0",
// "available_withdrawal_funds":"0",
// "initial_margin":"0",
// "maintenance_margin":"0",
// "margin_balance":"0",
// "session_funding":"0",
// "session_rpl":"0",
// "session_upl":"0",
// "futures_pl":"0",
// "futures_session_rpl":"0",
// "futures_session_upl":"0",
// "options_value":"0",
// "options_pl":"0",
// "options_session_rpl":"0",
// "options_session_upl":"0",
// "total_pl":"0",
// "options_delta":"0",
// "options_gamma":"0",
// "options_theta":"0",
// "options_vega":"0",
// "delta_total":"0"
// },
// "ETH":{
// "currency":"ETH",
// "balance":"0",
// "freeze":"0",
// "equity":"0",
// "base_currency":"USDT",
// "available_funds":"0",
// "available_withdrawal_funds":"0",
// "initial_margin":"0",
// "maintenance_margin":"0",
// "margin_balance":"0",
// "session_funding":"0",
// "session_rpl":"0",
// "session_upl":"0",
// "futures_pl":"0",
// "futures_session_rpl":"0",
// "futures_session_upl":"0",
// "options_value":"0",
// "options_pl":"0",
// "options_session_rpl":"0",
// "options_session_upl":"0",
// "total_pl":"0",
// "options_delta":"0",
// "options_gamma":"0",
// "options_theta":"0",
// "options_vega":"0",
// "delta_total":"0"
// },
// "PERPETUAL":{
// "bonus":"0",
// "global_state":0,
// "available_funds":"0",
// "wallet_balance":"0",
// "available_withdraw_funds":"0",
// "total_pl":"0",
// "total_upl":"0",
// "position_rpl":"0",
// "total_upl_isolated":"0",
// "total_upl_cross":"0",
// "total_initial_margin_cross":"0",
// "total_initial_margin_isolated":"0",
// "total_margin_balance_isolated":"0",
// "total_margin_balance":"0",
// "total_margin_balance_cross":"0",
// "total_maintenance_margin_cross":"0",
// "total_wallet_balance_isolated":"0",
// "order_frozen":"0",
// "order_cross_frozen":"0",
// "order_isolated_frozen":"0",
// "risk_level":"0",
// "bonus_max":"0"
// }
// }
//
const result = { 'info': response };
const assetTypes = Object.keys(response);
for (let i = 0; i < assetTypes.length; i++) {
const assetType = assetTypes[i];
const currency = this.safeValue(response, assetType);
if ((assetType === 'WALLET') || (assetType === 'SPOT')) {
const details = this.safeValue(currency, 'details');
if (details !== undefined) {
for (let j = 0; j < details.length; j++) {
const detail = details[j];
const coinType = this.safeString(detail, 'coin_type');
const code = this.safeCurrencyCode(coinType);
const account = this.safeValue(result, code, this.account());
account['free'] = this.safeString(detail, 'available');
account['used'] = this.safeString(detail, 'freeze');
account['total'] = this.safeString(detail, 'total');
result[code] = account;
}
}
}
else {
// all other wallets are linear futures
const code = 'USDT';
const account = this.account();
account['total'] = this.safeString(currency, 'wallet_balance');
account['free'] = this.safeString(currency, 'available_withdraw_funds');
result[code] = account;
}
}
return this.safeBalance(result);
}
async fetchBalance(params = {}) {
await this.signIn();
await this.loadMarkets();
const type = this.safeStringLower(params, 'type', 'spot');
const types = this.safeValue(this.options, 'accountsByType', {});
const assetType = this.safeString(types, type, type);
params = this.omit(params, 'type');
const request = {
'asset_type': [assetType],
};
const response = await this.privatePostGetAssetsInfo(this.extend(request, params));
const result = this.safeValue(response, 'result', []);
//
// {
// "id":"1647675393",
// "jsonrpc":"2.0",
// "usIn":1647675394091,
// "usOut":1647675394104,
// "usDiff":13,
// "result":{
// "WALLET":{
// "total":"0",
// "coupon":"0",
// "details":[{
// "available":"0",
// "freeze":"0",
// "coin_type":"1INCH",
// "current_mark_price":"1.657"
// }]
// },
// "MARGIN":{
// "total":"0",
// "net":"0",
// "available":"0",
// "borrowed":"0",
// "details":[],
// "maintenance_margin":"0",
// "interest_owed":"0"
// },
// "SPOT":{
// "total":"3.965",
// "available":"15.887066",
// "details":[{
// "available":"0",
// "freeze":"0",
// "total":"0",
// "coin_type":"1INCH",
// "current_mark_price":"1.657"
// }]
// },
// "BTC":{
// "currency":"BTC",
// "balance":"0",
// "freeze":"0",
// "equity":"0",
// "base_currency":"USDT",
// "available_funds":"0",
// "available_withdrawal_funds":"0",
// "initial_margin":"0",
// "maintenance_margin":"0",
// "margin_balance":"0",
// "session_funding":"0",
// "session_rpl":"0",
// "session_upl":"0",
// "futures_pl":"0",
// "futures_session_rpl":"0",
// "futures_session_upl":"0",
// "options_value":"0",
// "options_pl":"0",
// "options_session_rpl":"0",
// "options_session_upl":"0",
// "total_pl":"0",
// "options_delta":"0",
// "options_gamma":"0",
// "options_theta":"0",
// "options_vega":"0",
// "delta_total":"0"
// },
// "ETH":{
// "currency":"ETH",
// "balance":"0",
// "freeze":"0",
// "equity":"0",
// "base_currency":"USDT",
// "available_funds":"0",
// "available_withdrawal_funds":"0",
// "initial_margin":"0",
// "maintenance_margin":"0",
// "margin_balance":"0",
// "session_funding":"0",
// "session_rpl":"0",
// "session_upl":"0",
// "futures_pl":"0",
// "futures_session_rpl":"0",
// "futures_session_upl":"0",
// "options_value":"0",
// "options_pl":"0",
// "options_session_rpl":"0",
// "options_session_upl":"0",
// "total_pl":"0",
// "options_delta":"0",
// "options_gamma":"0",
// "options_theta":"0",
// "options_vega":"0",
// "delta_total":"0"
// },
// "PERPETUAL":{
// "bonus":"0",
// "global_state":0,
// "available_funds":"0",
// "wallet_balance":"0",
// "available_withdraw_funds":"0",
// "total_pl":"0",
// "total_upl":"0",
// "position_rpl":"0",
// "total_upl_isolated":"0",
// "total_upl_cross":"0",
// "total_initial_margin_cross":"0",
// "total_initial_margin_isolated":"0",
// "total_margin_balance_isolated":"0",
// "total_margin_balance":"0",
// "total_margin_balance_cross":"0",
// "total_maintenance_margin_cross":"0",
// "total_wallet_balance_isolated":"0",
// "order_frozen":"0",
// "order_cross_frozen":"0",
// "order_isolated_frozen":"0",
// "risk_level":"0",
// "bonus_max":"0"
// }
// }
// }
//
return this.parseBalance(result);
}
parseOrderStatus(status) {
const statuses = {
'open': 'open',
'cancelled': 'canceled',
'filled': 'closed',
'rejected': 'rejected',
};
return this.safeString(statuses, status, status);
}
parseTimeInForce(timeInForce) {
if (timeInForce === '-') {
return undefined;
}
const timeInForces = {
'good_til_cancelled': 'GTC',
'good_til_date': 'GTD',
'fill_or_kill': 'FOK',
'immediate_or_cancel': 'IOC',
};
return this.safeString(timeInForces, timeInForce, timeInForce);
}
parseOrder(order, market = undefined) {
//
// fetchOrder || fetchOpenOrders || fetchClosedOrders
// {
// "kind":"spot",
// "direction":"sell",
// "amount":"0.02",
// "price":"900",
// "advanced":"usdt",
// "source":"api",
// "mmp":false,
// "version":1,
// "order_id":"250971492850401280",
// "order_state":"open",
// "instrument_name":"BNB-USDT-SPOT",
// "filled_amount":"0",
// "average_price":"0",
// "order_type":"limit",
// "time_in_force":"GTC",
// "post_only":false,
// "reduce_only":false,
// "creation_timestamp":1647666666723,
// "last_update_timestamp":1647666666725
// }
//
// createOrder
//
// {
// "order_id":"251052889774161920",
// "custom_order_id":"-"
// }
//
// closeOrder
// {
// "order_id":"250979354159153152"
// }
//
const timestamp = this.safeInteger(order, 'creation_timestamp');
const lastUpdate = this.safeInteger(order, 'last_update_timestamp');
const id = this.safeString(order, 'order_id');
let priceString = this.safeString(order, 'price');
if (priceString === '-1') {
priceString = undefined;
}
const averageString = this.safeString(order, 'average_price');
const amountString = this.safeString(order, 'amount');
const filledString = this.safeString(order, 'filled_amount');
const status = this.parseOrderStatus(this.safeString(order, 'order_state'));
const marketId = this.safeString(order, 'instrument_name');
market = this.safeMarket(marketId, market);
const side = this.safeStringLower(order, 'direction');
let feeCostString = this.safeString(order, 'commission');
let fee = undefined;
if (feeCostString !== undefined) {
feeCostString = Precise["default"].stringAbs(feeCostString);
fee = {
'cost': feeCostString,
'currency': market['base'],
};
}
// injected in createOrder
const trades = this.safeValue(order, 'trades');
const stopPrice = this.safeNumber(order, 'trigger_price');
return this.safeOrder({
'info': order,
'id': id,
'clientOrderId': undefined,
'timestamp': timestamp,
'datetime': this.iso8601(timestamp),
'lastTradeTimestamp': lastUpdate,
'symbol': market['symbol'],
'type': this.safeString(order, 'order_type'),
'timeInForce': this.parseTimeInForce(this.safeString(order, 'time_in_force')),
'postOnly': this.safeValue(order, 'post_only'),
'side': side,
'price': this.parseNumber(priceString),
'stopPrice': stopPrice,
'triggerPrice': stopPrice,
'stopLossPrice': this.safeNumber(order, 'stop_loss_price'),
'takeProfitPrice': this.safeNumber(order, 'take_profit_price'),
'amount': amountString,
'cost': undefined,
'average': averageString,
'filled': filledString,
'remaining': undefined,
'status': status,
'fee': fee,
'trades': trades,
}, market);
}
async fetchOrder(id, symbol = undefined, params = {}) {
await this.signIn();
await this.loadMarkets();
const request = {
'order_id': id,
};
const response = await this.privateGetGetOrderState(this.extend(request, params));
const result = this.safeValue(response, 'result');
//
// {
// "jsonrpc":"2.0",
// "usIn":1647672034018,
// "usOut":1647672034033,
// "usDiff":15,
// "result":{
// "currency":"SPOT",
// "kind":"spot",
// "direction":"sell",
// "amount":"0.03",
// "price":"-1",
// "advanced":"usdt",
// "source":"api",
// "mmp":false,
// "version":1,
// "order_id":"250979478947823616",
// "order_state":"filled",
// "instrument_name":"BNB-USDT-SPOT",
// "filled_amount":"0.03",
// "average_price":"397.8",
// "order_type":"market",
// "time_in_force":"GTC",
// "post_only":false,
// "reduce_only":false,
// "creation_timestamp":1647668570759,
// "last_update_timestamp":1647668570761
// }
// }
//
return this.parseOrder(result);
}
async createOrder(symbol, type, side, amount, price = undefined, params = {}) {
/**
* @method
* @name btcex#createOrder
* @description create a trade order
* @param {string} symbol unified symbol of the market to create an order in
* @param {string} type 'market' or 'limit'
* @param {string} side 'buy' or 'sell'
* @param {float} amount how much of currency you want to trade in units of the base currency
* @param {float|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders
* @param {object} params extra parameters specific to the btcex api endpoint
* ----------------- Exchange Specific Parameters -----------------
* @param {float|undefined} params.cost amount in USDT to spend for market orders
* @param {float|undefined} params.triggerPrice price to trigger stop orders
* @param {float|undefined} params.stopPrice price to trigger stop orders
* @param {float|undefined} params.stopLossPrice price to trigger stop-loss orders (only for perpetuals)
* @param {float|undefined} params.takeProfitPrice price to trigger take-profit orders (only for perpetuals)
* @param {object|undefined} params.stopLoss for setting a stop-loss attached to an order, set the value of the stopLoss key 'price' (only for perpetuals)
* @param {object|undefined} params.takeProfit for setting a take-profit attached to an order, set the value of the takeProfit key 'price' (only for perpetuals)
* @param {int|undefined} params.trigger_price_type 1: mark-price, 2: last-price. (only for perpetuals)
* @param {int|undefined} params.stop_loss_type 1: mark-price, 2: last-price (only for perpetuals)
* @param {int|undefined} params.take_profit_type 1: mark-price, 2: last-price (only for perpetuals)
* @param {bool|undefined} params.market_amount_order if set to true，then the amount field means USDT value (only for perpetuals)
* @param {string|undefined} params.condition_type 'NORMAL', 'STOP', 'TRAILING', 'IF_TOUCHED'
* @param {string|undefined} params.position_side 'BOTH', for one-way mode 'LONG' or 'SHORT', for hedge-mode
* @param {string|undefined} params.timeInForce 'GTC', 'IOC', 'FOK'
* @param {bool|undefined} params.postOnly
* @param {bool|undefined} params.reduceOnly
* @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
*/
await this.signIn();
await this.loadMarkets();
const market = this.market(symbol);
const request = {
'instrument_name': market['id'],
'type': type,
};
if (side === 'sell' || type === 'limit') {
request['amount'] = this.amountToPrecision(symbol, amount);
}
if (type === 'limit') {
request['price'] = this.priceToPrecision(symbol, price);
}
else {
const costParam = this.safeNumber(params, 'cost');
const amountString = this.numberToString(amount);
const priceString = this.numberToString(price);
const cost = this.parseNumber(Precise["default"].stringMul(amountString, priceString), costParam);
if (market['swap']) {
if (cost !== undefined) {
request['amount'] = this.priceToPrecision(symbol, cost);
request['market_amount_order'] = true;
}
else {
request['market_amount_order'] = false;
request['amount'] = this.amountToPrecision(symbol, amount);
}
}
else {
if (side === 'buy') {
const createMarketBuyOrderRequiresPrice = this.safeValue(this.options, 'createMarketBuyOrderRequiresPrice', true);
if (createMarketBuyOrderRequiresPrice) {
if (cost === undefined) {
throw new errors.InvalidOrder(this.id + ' createOrder() requires a price argument for market buy orders on spot markets to calculate the total amount to spend (amount * price), alternatively set the createMarketBuyOrderRequiresPrice option to false and pass in the cost to spend into the amount parameter');
}
else {
request['amount'] = this.priceToPrecision(symbol, cost);
}
}
else {
request['amount'] = this.priceToPrecision(symbol, amount);
}
}
}
params = this.omit(params, 'cost');
}
if (market['swap']) {
const timeInForce = this.safeStringUpper(params, 'timeInForce');
if (timeInForce === 'GTC') {
request['time_in_force'] = 'good_till_cancelled';
}
else if (timeInForce === 'FOK') {
request['time_in_force'] = 'fill_or_kill';
}
else if (timeInForce === 'IOC') {
request['time_in_force'] = 'immediate_or_cancel';
}
const isMarketOrder = type === 'market';
const exchangeSpecificParam = this.safeValue(params, 'post_only', false);
const postOnly = this.isPostOnly(isMarketOrder, exchangeSpecificParam, params);
if (postOnly) {
request['post_only'] = true;
}
const reduceOnly = this.safeValue(params, 'reduceOnly', false);
if (reduceOnly) {
request['reduce_only'] = true;
}
if (side === 'buy') {
const requestType = (reduceOnly) ? 'SHORT' : 'LONG';
request['position_side'] = requestType;
}
else {
const requestType = (reduceOnly) ? 'LONG' : 'SHORT';
request['position_side'] = requestType;
}
const stopPrice = this.safeNumber2(params, 'triggerPrice', 'stopPrice');
let stopLossPrice = this.safeNumber(params, 'stopLossPrice');
let takeProfitPrice = this.safeNumber(params, 'takeProfitPrice');
const isStopLoss = this.safeValue(params, 'stopLoss');
const isTakeProfit = this.safeValue(params, 'takeProfit');
if (stopPrice) {
request['condition_type'] = 'STOP';
request['trigger_price'] = this.priceToPrecision(symbol, stopPrice);
request['trigger_price_type'] = 1;
}
else if (stopLossPrice || takeProfitPrice) {
request['condition_type'] = 'STOP';
if (stopLossPrice) {
request['trigger_price'] = this.priceToPrecision(symbol, stopLossPrice);
}
else {
request['trigger_price'] = this.priceToPrecision(symbol, takeProfitPrice);
}
request['reduce_only'] = true;
request['trigger_price_type'] = 1;
}
else if (isStopLoss || isTakeProfit) {
if (isStopLoss) {
stopLossPrice = this.safeNumber(isStopLoss, 'price');
request['stop_loss_price'] = this.priceToPrecision(symbol, stopLossPrice);
request['stop_loss_type'] = 1;
}
else {
takeProfitPrice = this.safeNumber(isTakeProfit, 'price');
request['take_profit_price'] = this.priceToPrecision(symbol, takeProfitPrice);
request['take_profit_type'] = 1;
}
}
params = this.omit(params, ['timeInForce', 'postOnly', 'reduceOnly', 'stopPrice', 'triggerPrice', 'stopLossPrice', 'takeProfitPrice', 'stopLoss', 'takeProfit']);
}
const method = 'privatePost' + this.capitalize(side);
const response = await this[method](this.extend(request, params));
const result = this.safeValue(response, 'result', {});
//
// {
// "id":"1647686073",
// "jsonrpc":"2.0",
// "usIn":1647686073252,
// "usOut":1647686073264,
// "usDiff":12,
// "result":{
// "order":{
// "order_id":"251052889774161920",
// "custom_order_id":"-"
// }
// }
// }
//
const order = this.safeValue(result, 'order');
return this.parseOrder(order, market);
}
async cancelOrder(id, symbol = undefined, params = {}) {
await this.signIn();
await this.loadMarkets();
const request = {
'order_id': id,
};
const response = await this.privatePostCancel(this.extend(request, params));
const result = this.safeValue(response, 'result', {});
//
// {
// "id":"1647675007",
// "jsonrpc":"2.0",
// "usIn":1647675007485,
// "usOut":1647675007494,
// "usDiff":9,
// "result":{
// "order_id":"250979354159153152"
// }
// }
//
return this.parseOrder(result);
}
async cancelAllOrders(symbol = undefined, params = {}) {
if (symbol === undefined) {
throw new errors.ArgumentsRequired(this.id + ' cancelAllOrders() requires a symbol argument');
}
await this.signIn();
await this.loadMarkets();
const market = this.market(symbol);
const request = {
'instrument_name': market['id'],
};
const response = await this.privatePostCancelAllByInstrument(this.extend(request, params));
//
// {
// "id":"1647686580",
// "jsonrpc":"2.0",
// "usIn":1647686581216,
// "usOut":1647686581224,
// "usDiff":8,
// "result":2
// }
//
return response;
}
async fetchOpenOrders(symbol = undefined, since = undefined, limit = undefined, params = {}) {
if (symbol === undefined) {
throw new errors.ArgumentsRequired(this.id + ' fetchOpenOrders() requires a symbol argument');
}
await this.signIn();
await this.loadMarkets();
const market = this.market(symbol);
const request = {
'instrument_name': market['id'],
};
const response = await this.privateGetGetOpenOrdersByInstrument(this.extend(request, params));
const result = this.safeValue(response, 'result', []);
//
// {
// "jsonrpc":"2.0",
// "usIn":1647667026285,
// "usOut":1647667026291,
// "usDiff":6,
// "result":[{
// "kind":"spot",
// "direction":"sell",
// "amount":"0.02",
// "price":"900",
// "advanced":"usdt",
// "source":"api",
// "mmp":false,
// "version":1,
// "order_id":"250971492850401280",
// "order_state":"open",
// "instrument_name":"BNB-USDT-SPOT",
// "filled_amount":"0",
// "average_price":"0",
// "order_type":"limit",
// "time_in_force":"GTC",
// "post_only":false,
// "reduce_only":false,
// "creation_timestamp":1647666666723,
// "last_update_timestamp":1647666666725
// }]
// }
//
return this.parseOrders(result, market, since, limit);
}
async fetchClosedOrders(symbol = undefined, since = undefined, limit = undefined, params = {}) {
if (symbol === undefined) {
throw new errors.ArgumentsRequired(this.id + ' fetchClosedOrders() requires a symbol argument');
}
await this.signIn();
await this.loadMarkets();
const market = this.market(symbol);
const request = {
'instrument_name': market['id'],
};
if (limit !== undefined) {
request['count'] = limit;
}
const response = await this.privateGetGetOrderHistoryByInstrument(this.extend(request, params));
const result = this.safeValue(response, 'result', []);
//
// {
// "jsonrpc":"2.0",
// "usIn":1647671721716,
// "usOut":1647671721730,
// "usDiff":14,
// "result":[{
// "currency":"SPOT",
// "kind":"spot",
// "direction":"sell",
// "amount":"0.03",
// "price":"-1",
// "advanced":"usdt",
// "source":"api",
// "mmp":false,
// "version":1,
// "order_id":"250979478947823616",
// "order_state":"filled",
// "instrument_name":"BNB-USDT-SPOT",
// "filled_amount":"0.03",
// "average_price":"397.8",
// "order_type":"market",
// "time_in_force":"GTC",
// "post_only":false,
// "reduce_only":false,
// "creation_timestamp":1647668570759,
// "last_update_timestamp":1647668570761
// }]
// }
//
return this.parseOrders(result, market, since, limit);
}
async fetchOrderTrades(id, symbol = undefined, since = undefined, limit = undefined, params = {}) {
if (id === undefined) {
throw new errors.ArgumentsRequired(this.id + ' fetchOrderTrades() requires a id argument');
}
await this.loadMarkets();
const request = {
'order_id': id,
// 'start_id': 0, // The ID number of the first trade to be returned
// 'end_id': 0, // The ID number of the last trade to be returned
// 'sorting': '', // Direction of results sorting,default: desc
};
if (limit !== undefined) {
request['count'] = limit; // default 20
}
const response = await this.privateGetGetUserTradesByOrder(this.extend(request, params));
const result = this.safeValue(response, 'result', {});
//
// {
// "jsonrpc":"2.0",
// "usIn":1647671425457,
// "usOut":1647671425470,
// "usDiff":13,
// "result":{
// "count":1,
// "trades":[{
// "direction":"sell",
// "amount":"0.03",
// "price":"397.8",
// "fee":"0.011934",
// "timestamp":1647668570759,
// "role":"taker",
// "trade_id":"58319385",
// "order_id":"250979478947823616",
// "instrument_name":"BNB-USDT-SPOT",
// "order_type":"market",
// "fee_use_coupon":false,
// "fee_coin_type":"USDT",
// "index_price":"",
// "self_trade":false
// }],
// "has_more":false
// }
// }
//
const trades = this.safeValue(result, 'trades', []);
return this.parseTrades(trades, undefined, since, limit);
}
async fetchMyTrades(symbol = undefined, since = undefined, limit = undefined, params = {}) {
if (symbol === undefined) {
throw new errors.ArgumentsRequired(this.id + ' fetchMyTrades() requires a id argument');
}
await this.signIn();
await this.loadMarkets();
const request = {
// 'kind': '', // The order kind, eg. margin, spot, option, future, perpetual. only used when call privateGetGetUserTradesByCurrency
// 'start_id': 0, // The ID number of the first trade to be returned
// 'end_id': 0, // The ID number of the last trade to be returned
// 'sorting': '', // Direction of results sorting,default: desc
// 'self_trade': false, // If not set, query all
// 'start_timestamp': false // The trade time of the first trade to be returned
// 'end_timestamp': false // The trade time of the last trade to be returned
};
const market = this.market(symbol);
request['instrument_name'] = market['id'];
if (limit !== undefined) {
request['count'] = limit; // default 20
}
if (since !== undefined) {
request['start_timestamp'] = since;
}
const response = await this.privateGetGetUserTradesByInstrument(this.extend(request, params));
const result = this.safeValue(response, 'result', {});
//
// {
// "jsonrpc":"2.0",
// "usIn":1647668582167,
// "usOut":1647668582187,
// "usDiff":20,
// "result":{
// "count":1,
// "trades":[{
// "direction":"sell",
// "amount":"0.03",
// "price":"397.8",
// "fee":"0.011934",
// "timestamp":1647668570759,
// "role":"taker",
// "trade_id":"58319385",
// "order_id":"250979478947823616",
// "instrument_name":"BNB-USDT-SPOT",
// "order_type":"market",
// "fee_use_coupon":false,
// "fee_coin_type":"USDT",
// "index_price":"",
// "self_trade":false
// }],
// "has_more":false
// }
// }
//
const trades = this.safeValue(result, 'trades', []);
return this.parseTrades(trades, market, since, limit);
}
parsePosition(position, market = undefined) {
//
// {
// "currency":"PERPETUAL",
// "kind":"perpetual",
// "size":"-0.08",
// "direction":"sell",
// "leverage":"3",
// "margin":"10.7724",
// "version":"553",
// "roe":"-0.000483",
// "traceType":0,
// "pos_id":"0",
// "instrument_name":"BNB-USDT-PERPETUAL",
// "average_price":"403.9",
// "mark_price":"403.965",
// "initial_margin":"10.77066668",
// "maintenance_margin":"0.2100618",
// "floating_profit_loss":"-0.0052",
// "liquid_price":"549.15437158",
// "margin_type":"cross",
// "risk_level":"0.017651",
// "available_withdraw_funds":"1.13004332",
// "order_id":"251085320510201856",
// "stop_loss_price":"0",
// "stop_loss_type":1,
// "take_profit_price":"0",
// "take_profit_type":1
// }
//
const contract = this.safeString(position, 'instrument_name');
market = this.safeMarket(contract, market);
const size = this.safeString(position, 'size');
let side = this.safeString(position, 'direction');
side = (side === 'buy') ? 'long' : 'short';
const maintenanceMarginString = this.safeString(position, 'maintenance_margin');
const riskLevel = this.safeString(position, 'risk_level');
// maint_margin / collateral = risk_level
// collateral = maint_margin / risk_level
const collateral = Precise["default"].stringDiv(maintenanceMarginString, riskLevel);
const markPrice = this.safeString(position, 'mark_price');
const notionalString = Precise["default"].stringMul(markPrice, size);
const unrealisedPnl = this.safeString(position, 'floating_profit_loss');
const initialMarginString = this.safeString(position, 'initial_margin');
const marginType = this.safeString(position, 'margin_type');
return this.safePosition({
'info': position,
'id': undefined,
'symbol': this.safeString(market, 'symbol'),
'timestamp': undefined,
'datetime': undefined,
'lastUpdateTimestamp': undefined,
'initialMargin': this.parseNumber(initialMarginString),
'initialMarginPercentage': this.parseNumber(Precise["default"].stringDiv(initialMarginString, notionalString)),
'maintenanceMargin': this.parseNumber(maintenanceMarginString),
'maintenanceMarginPercentage': this.parseNumber(Precise["default"].stringDiv(maintenanceMarginString, notionalString)),
'entryPrice': this.safeNumber(position, 'average_price'),
'notional': this.parseNumber(notionalString),
'leverage': this.safeNumber(position, 'leverage'),
'unrealizedPnl': this.parseNumber(unrealisedPnl),
'contracts': this.parseNumber(size),
'contractSize': this.safeValue(market, 'contractSize'),
'marginRatio': this.parseNumber(riskLevel),
'liquidationPrice': this.safeNumber(position, 'liquid_price'),
'markPrice': this.parseNumber(markPrice),
'lastPrice': undefined,
'collateral': this.parseNumber(collateral),
'marginType': marginType,
'side': side,
'percentage': undefined,
});
}
async fetchPosition(symbol, params = {}) {
await this.signIn();
await this.loadMarkets();
const market = this.market(symbol);
const request = {
'instrument_name': market['id'],
};
const response = await this.privateGetGetPosition(this.extend(request, params));
const result = this.safeValue(response, 'result');
//
// {
// "jsonrpc":"2.0",
// "usIn":1647693832273,
// "usOut":1647693832282,
// "usDiff":9,
// "result":{
// "currency":"PERPETUAL",
// "kind":"perpetual",
// "size":"-0.08",
// "direction":"sell",
// "leverage":"3",
// "margin":"10.7724",
// "version":"553",
// "roe":"-0.000483",
// "traceType":0,
// "pos_id":"0",
// "instrument_name":"BNB-USDT-PERPETUAL",
// "average_price":"403.9",
// "mark_price":"403.965",
// "initial_margin":"10.77066668",
// "maintenance_margin":"0.2100618",
// "floating_profit_loss":"-0.0052",
// "liquid_price":"549.15437158",
// "margin_type":"cross",
// "risk_level":"0.017651",
// "available_withdraw_funds":"1.13004332",
// "order_id":"251085320510201856",
// "stop_loss_price":"0",
// "stop_loss_type":1,
// "take_profit_price":"0",
// "take_profit_type":1
// }
// }
//
return this.parsePosition(result);
}
async fetchPositions(symbols = undefined, params = {}) {
await this.signIn();
await this.loadMarkets();
const request = {
'currency': 'PERPETUAL',
// 'kind' : '', // option, future, spot, margin,perpetual The order kind
};
const response = await this.privateGetGetPositions(this.extend(request, params));
const result = this.safeValue(response, 'result');
//
// {
// "jsonrpc":"2.0",
// "usIn":1647694531356,
// "usOut":1647694531364,
// "usDiff":8,
// "result":[{
// "currency":"PERPETUAL",
// "kind":"perpetual",
// "size":"-0.08",
// "direction":"sell",
// "leverage":"3",
// "margin":"10.7836",
// "version":"1251",
// "roe":"-0.003602",
// "traceType":0,
// "pos_id":"0",
// "instrument_name":"BNB-USDT-PERPETUAL",
// "average_price":"403.9",
// "mark_price":"404.385",
// "initial_margin":"10.77066668",
// "maintenance_margin":"0.2102802",
// "floating_profit_loss":"-0.0388",
// "liquid_price":"549.15437158",
// "margin_type":"cross",
// "risk_level":"0.01772",
// "available_withdraw_funds":"1.09644332",
// "order_id":"251085320510201856",
// "stop_loss_price":"0",
// "stop_loss_type":1,
// "take_profit_price":"0",
// "take_profit_type":1
// }]
// }
//
return this.parsePositions(result, symbols);
}
parseTransactionStatus(status) {
const states = {
'deposit_confirmed': 'ok',
'deposit_waiting_confirm': 'pending',
'withdraw_init': 'pending',
'withdraw_noticed_block_chain': 'pending',
'withdraw_waiting_confirm': 'pending',
'withdraw_confirmed': 'ok',
'withdraw_failed': 'failed',
'withdraw_auditing': 'pending',
'withdraw_audit_reject': 'failed',
};
return this.safeString(states, status, status);
}
parseTransaction(transaction, currency = undefined) {
//
// fetchDeposits
// {
// "id":"250325458128736256",
// "amount":"0.04",
// "state":"deposit_confirmed",
// "coin_type":"BNB",
// "token_code":"BNB",
// "create_time":"1647512640040",
// "update_time":"1647512640053",
// "tx_hash":"",
// "full_name":"Binance Coin"
// }
//
// fetchWithdrawals || fetchWithdraw
// {
// "id":"251076247882829824",
// "address":"",
// "amount":"0.01",
// "state":"withdraw_auditing",
// "coin_type":"BNB",
// "create_time":"1647691642267",
// "update_time":"1647691650090",
// "full_name":"Binance Coin",
// "token_code":"BNB"
// }
//
const currencyId = this.safeString(transaction, 'coin_type');
const code = this.safeCurrencyCode(currencyId, currency);
const id = this.safeString(transaction, 'id');
const txId = this.safeString(transaction, 'tx_hash');
const timestamp = this.safeInteger(transaction, 'create_time');
const updated = this.safeInteger(transaction, 'update_time');
const amount = this.safeNumber(transaction, 'amount');
const status = this.safeString(transaction, 'state');
return {
'info': transaction,
'id': id,
'txid': txId,
'timestamp': timestamp,
'datetime': this.iso8601(timestamp),
'network': undefined,
'addressFrom': undefined,
'address': undefined,
'addressTo': undefined,
'tagFrom': undefined,
'tag': undefined,
'tagTo': undefined,
'type': undefined,
'amount': amount,
'currency': code,
'status': this.parseTransactionStatus(status),
'updated': updated,
'fee': undefined,
};
}
async fetchDeposits(code = undefined, since = undefined, limit = undefined, params = {}) {
if (code === undefined) {
throw new errors.ArgumentsRequired(this.id + ' fetchDeposits() requires the code argument');
}
await this.signIn();
await this.loadMarkets();
const currency = this.safeCurrency(code);
const request = {
'coin_type': currency['id'],
};
const response = await this.privateGetGetDepositRecord(this.extend(request, params));
const result = this.safeValue(response, 'result', []);
//
// {
// "jsonrpc":"2.0",
// "usIn":1647606752447,
// "usOut":1647606752457,
// "usDiff":10,
// "result":[{
// "id":"250325458128736256",
// "amount":"0.04",
// "state":"deposit_confirmed",
// "coin_type":"BNB",
// "token_code":"BNB",
// "create_time":"1647512640040",
// "update_time":"1647512640053",
// "tx_hash":"",
// "full_name":"Binance Coin"
// }]
// }
// }
//
return this.parseTransactions(result, currency, since, limit, { 'type': 'deposit' });
}
async fetchWithdrawals(code = undefined, since = undefined, limit = undefined, params = {}) {
if (code === undefined) {
throw new errors.ArgumentsRequired(this.id + ' fetchWithdrawals() requires the code argument');
}
await this.signIn();
await this.loadMarkets();
const currency = this.safeCurrency(code);
const request = {
'coin_type': currency['id'],
// 'withdraw_id': 0,
};
const response = await this.privateGetGetWithdrawRecord(this.extend(request, params));
const result = this.safeValue(response, 'result', []);
//
// {
// "jsonrpc":"2.0",
// "usIn":1647691750112,
// "usOut":1647691750125,
// "usDiff":13,
// "result":[{
// "id":"251076247882829824",
// "address":"",
// "amount":"0.01",
// "state":"withdraw_auditing",
// "coin_type":"BNB",
// "create_time":"1647691642267",
// "update_time":"1647691650090",
// "full_name":"Binance Coin",
// "token_code":"BNB"
// }]
// }
//
return this.parseTransactions(result, currency, since, limit, { 'type': 'withdrawal' });
}
async fetchWithdrawal(id, code = undefined, params = {}) {
if (code === undefined) {
throw new errors.ArgumentsRequired(this.id + ' fetchWithdrawal() requires the code argument');
}
await this.signIn();
await this.loadMarkets();
const currency = this.safeCurrency(code);
const request = {
'coin_type': currency['id'],
'withdraw_id': id,
};
const response = await this.privateGetGetWithdrawRecord(this.extend(request, params));
const result = this.safeValue(response, 'result', []);
//
// {
// "jsonrpc":"2.0",
// "usIn":1647691750112,
// "usOut":1647691750125,
// "usDiff":13,
// "result":[{
// "id":"251076247882829824",
// "address":"",
// "amount":"0.01",
// "state":"withdraw_auditing",
// "coin_type":"BNB",
// "create_time":"1647691642267",
// "update_time":"1647691650090",
// "full_name":"Binance Coin",
// "token_code":"BNB"
// }]
// }
//
const records = this.filterBy(result, 'id', id);
const record = this.safeValue(records, 0);
return this.parseTransaction(record, currency);
}
async fetchLeverage(symbol, params = {}) {
/**
* @method
* @name btcex#fetchLeverage
* @see https://docs.btcex.com/#get-perpetual-instrument-config
* @description fetch the set leverage for a market
* @param {string} symbol unified market symbol
* @param {object} params extra parameters specific to the btcex api endpoint
* @returns {object} a [leverage structure]{@link https://docs.ccxt.com/#/?id=leverage-structure}
*/
await this.signIn();
await this.loadMarkets();
const market = this.market(symbol);
const request = {
'instrument_name': market['id'],
};
const response = await this.privateGetGetPerpetualUserConfig(this.extend(request, params));
//
// {
// "jsonrpc": "2.0",
// "usIn": 1674182494283,
// "usOut": 1674182494294,
// "usDiff": 11,
// "result": {
// "margin_type": "cross",
// "leverage": "20",
// "instrument_name": "BTC-USDT-PERPETUAL",
// "time": "1674182494293"
// }
// }
//
const data = this.safeValue(response, 'result', {});
return this.safeNumber(data, 'leverage');
}
async fetchMarketLeverageTiers(symbol, params = {}) {
/**
* @method
* @name btcex#fetchMarketLeverageTiers
* @see https://docs.btcex.com/#get-perpetual-instrument-leverage-config
* @description retrieve information on the maximum leverage, for different trade sizes for a single market
* @param {string} symbol unified market symbol
* @param {object} params extra parameters specific to the btcex api endpoint
* @returns {object} a [leverage tiers structure]{@link https://docs.ccxt.com/#/?id=leverage-tiers-structure}
*/
await this.loadMarkets();
const market = this.market(symbol);
if (!market['swap']) {
throw new errors.BadRequest(this.id + ' fetchMarketLeverageTiers() supports swap markets only');
}
const request = {
'instrument_name': market['id'],
};
const response = await this.publicGetGetPerpetualLeverageBracket(this.extend(request, params));
//
// {
// "jsonrpc": "2.0",
// "usIn": 1674184074454,
// "usOut": 1674184074457,
// "usDiff": 3,
// "result": [
// {
// "bracket": 1,
// "initialLeverage": 125,
// "maintenanceMarginRate": "0.004",
// "notionalCap": "50000",
// "notionalFloor": "0",
// "cum": "0"
// },
// ...
// ]
// }
//
const data = this.safeValue(response, 'result', []);
return this.parseMarketLeverageTiers(data, market);
}
parseMarketLeverageTiers(info, market = undefined) {
//
// [
// {
// "bracket": 1,
// "initialLeverage": 125,
// "maintenanceMarginRate": "0.004",
// "notionalCap": "50000",
// "notionalFloor": "0",
// "cum": "0"
// },
// ...
// ]
//
const tiers = [];
const brackets = info;
for (let i = 0; i < brackets.length; i++) {
const tier = brackets[i];
tiers.push({
'tier': this.safeInteger(tier, 'bracket'),
'currency': market['settle'],
'minNotional': this.safeNumber(tier, 'notionalFloor'),
'maxNotional': this.safeNumber(tier, 'notionalCap'),
'maintenanceMarginRate': this.safeNumber(tier, 'maintenanceMarginRate'),
'maxLeverage': this.safeNumber(tier, 'initialLeverage'),
'info': tier,
});
}
return tiers;
}
async fetchLeverageTiers(symbols = undefined, params = {}) {
/**
* @method
* @name btcex#fetchLeverageTiers
* @see https://docs.btcex.com/#get-all-perpetual-instrument-leverage-config
* @description retrieve information on the maximum leverage, for different trade sizes
* @param {[string]|undefined} symbols a list of unified market symbols
* @param {object} params extra parameters specific to the btcex api endpoint
* @returns {object} a dictionary of [leverage tiers structures]{@link https://docs.ccxt.com/#/?id=leverage-tiers-structure}, indexed by market symbols
*/
await this.loadMarkets();
const response = await this.publicGetGetPerpetualLeverageBracketAll(params);
//
// {
// "jsonrpc": "2.0",
// "usIn": 1674183578745,
// "usOut": 1674183578752,
// "usDiff": 7,
// "result": {
// "WAVES-USDT-PERPETUAL": [
// {
// "bracket": 1,
// "initialLeverage": 50,
// "maintenanceMarginRate": "0.01",
// "notionalCap": "50000",
// "notionalFloor": "0",
// "cum": "0"
// },
// ...
// ]
// }
// }
//
const data = this.safeValue(response, 'result', {});
symbols = this.marketSymbols(symbols);
return this.parseLeverageTiers(data, symbols, 'symbol');
}
parseLeverageTiers(response, symbols = undefined, marketIdKey = undefined) {
const result = {};
const marketIds = Object.keys(response);
for (let i = 0; i < marketIds.length; i++) {
const marketId = marketIds[i];
const entry = response[marketId];
const market = this.safeMarket(marketId);
const symbol = this.safeSymbol(marketId, market);
let symbolsLength = 0;
this.parseMarketLeverageTiers(entry, market);
if (symbols !== undefined) {
symbolsLength = symbols.length;
if (this.inArray(symbol, symbols)) {
result[symbol] = this.parseMarketLeverageTiers(entry, market);
}
}
if (symbol !== undefined && (symbolsLength === 0 || this.inArray(symbol, symbols))) {
result[symbol] = this.parseMarketLeverageTiers(entry, market);
}
}
return result;
}
async setMarginMode(marginMode, symbol = undefined, params = {}) {
/**
* @method
* @name btcex#setMarginMode
* @description set margin mode to 'cross' or 'isolated'
* @see https://docs.btcex.com/#modify-perpetual-instrument-margin-type
* @param {string} marginMode 'cross' or 'isolated'
* @param {string|undefined} symbol unified market symbol
* @param {object} params extra parameters specific to the btcex api endpoint
* @returns {object} response from the exchange
*/
this.checkRequiredSymbol('setMarginMode', symbol);
await this.signIn();
await this.loadMarkets();
const market = this.market(symbol);
if (!market['swap']) {
throw new errors.BadRequest(this.id + ' setMarginMode() supports swap contracts only');
}
if ((marginMode !== 'isolated') && (marginMode !== 'isolate') && (marginMode !== 'cross')) {
throw new errors.BadRequest(this.id + ' marginMode must be either isolated or cross');
}
marginMode = (marginMode === 'isolated') ? 'isolate' : 'cross';
const request = {
'instrument_name': market['id'],
'margin_type': marginMode,
};
const result = await this.privatePostAdjustPerpetualMarginType(this.extend(request, params));
//
// {
// "id": "1674857919",
// "jsonrpc": "2.0",
// "usIn": 1674857920070,
// "usOut": 1674857920079,
// "usDiff": 9,
// "result": "ok"
// }
//
return result;
}
async setLeverage(leverage, symbol = undefined, params = {}) {
/**
* @method
* @name btcex#setLeverage
* @description set the leverage amount for a market
* @see https://docs.btcex.com/#modify-perpetual-instrument-leverage
* @param {float} leverage the rate of leverage
* @param {string} symbol unified market symbol
* @param {object} params extra parameters specific to the btcex api endpoint
* @returns {object} response from the exchange
*/
if (symbol === undefined) {
throw new errors.ArgumentsRequired(this.id + ' setLeverage() requires a symbol argument');
}
await this.signIn();
await this.loadMarkets();
this.checkRequiredSymbol('setLeverage', symbol);
const market = this.market(symbol);
if (!market['swap']) {
throw new errors.BadRequest(this.id + ' setLeverage() supports swap contracts only');
}
if ((leverage < 1) || (leverage > 125)) {
throw new errors.BadRequest(this.id + ' leverage should be between 1 and 125');
}
const request = {
'instrument_name': market['id'],
'leverage': leverage,
};
const response = await this.privatePostAdjustPerpetualLeverage(this.extend(request, params));
//
// {
// "id": "1674856410",
// "jsonrpc": "2.0",
// "usIn": 1674856410930,
// "usOut": 1674856410988,
// "usDiff": 58,
// "result": "ok"
// }
//
return response;
}
async fetchFundingRates(symbols = undefined, params = {}) {
/**
* @method
* @name btcex#fetchFundingRates
* @description fetch the current funding rates
* @see https://docs.btcex.com/#contracts
* @param {[string]} symbols unified market symbols
* @param {object} params extra parameters specific to the btcex api endpoint
* @returns {[object]} an array of [funding rate structures]{@link https://docs.ccxt.com/#/?id=funding-rate-structure}
*/
await this.loadMarkets();
symbols = this.marketSymbols(symbols);
const response = await this.publicGetCoinGeckoContracts(params);
//
// {
// "jsonrpc": "2.0",
// "usIn": 1674803585896,
// "usOut": 1674803585943,
// "usDiff": 47,
// "result": [
// {
// "ticker_id": "BTC-USDT-PERPETUAL",
// "base_currency": "BTC",
// "target_currency": "USDT",
// "last_price": "23685",
// "base_volume": "167011.37199999999999989",
// "target_volume": "3837763191.33800288010388613",
// "bid": "23684.5",
// "ask": "23685",
// "high": "23971.5",
// "low": "23156",
// "product_type": "perpetual",
// "open_interest": "24242.36",
// "index_price": "23686.4",
// "index_name": "BTC-USDT",
// "index_currency": "BTC",
// "start_timestamp": 1631004005882,
// "funding_rate": "0.000187",
// "next_funding_rate_timestamp": 1675065600000,
// "contract_type": "Quanto",
// "contract_price": "23685",
// "contract_price_currency": "USDT"
// },
// ]
// }
//
const data = this.safeValue(response, 'result', []);
const result = {};
for (let i = 0; i < data.length; i++) {
const entry = data[i];
const marketId = this.safeString(entry, 'ticker_id');
const market = this.safeMarket(marketId);
const symbol = market['symbol'];
if (symbols !== undefined) {
if (this.inArray(symbol, symbols)) {
result[symbol] = this.parseFundingRate(entry, market);
}
}
else {
result[symbol] = this.parseFundingRate(entry, market);
}
}
return this.filterByArray(result, 'symbol', symbols);
}
async fetchFundingRate(symbol, params = {}) {
/**
* @method
* @name btcex#fetchFundingRate
* @description fetch the current funding rate
* @see https://docs.btcex.com/#contracts
* @param {string} symbol unified market symbol
* @param {object} params extra parameters specific to the btcex api endpoint
* @returns {object} a [funding rate structure]{@link https://docs.ccxt.com/#/?id=funding-rate-structure}
*/
await this.loadMarkets();
const market = this.market(symbol);
const response = await this.publicGetCoinGeckoContracts(params);
//
// {
// "jsonrpc": "2.0",
// "usIn": 1674803585896,
// "usOut": 1674803585943,
// "usDiff": 47,
// "result": [
// {
// "ticker_id": "BTC-USDT-PERPETUAL",
// "base_currency": "BTC",
// "target_currency": "USDT",
// "last_price": "23685",
// "base_volume": "167011.37199999999999989",
// "target_volume": "3837763191.33800288010388613",
// "bid": "23684.5",
// "ask": "23685",
// "high": "23971.5",
// "low": "23156",
// "product_type": "perpetual",
// "open_interest": "24242.36",
// "index_price": "23686.4",
// "index_name": "BTC-USDT",
// "index_currency": "BTC",
// "start_timestamp": 1631004005882,
// "funding_rate": "0.000187",
// "next_funding_rate_timestamp": 1675065600000,
// "contract_type": "Quanto",
// "contract_price": "23685",
// "contract_price_currency": "USDT"
// },
// ]
// }
//
const data = this.safeValue(response, 'result', []);
for (let i = 0; i < data.length; i++) {
const entry = data[i];
const marketId = this.safeString(entry, 'ticker_id');
if (marketId === market['id']) {
return this.parseFundingRate(entry, market);
}
}
return this.parseFundingRate(data, market);
}
parseFundingRate(contract, market = undefined) {
//
// {
// "ticker_id": "BTC-USDT-PERPETUAL",
// "base_currency": "BTC",
// "target_currency": "USDT",
// "last_price": "23685",
// "base_volume": "167011.37199999999999989",
// "target_volume": "3837763191.33800288010388613",
// "bid": "23684.5",
// "ask": "23685",
// "high": "23971.5",
// "low": "23156",
// "product_type": "perpetual",
// "open_interest": "24242.36",
// "index_price": "23686.4",
// "index_name": "BTC-USDT",
// "index_currency": "BTC",
// "start_timestamp": 1631004005882,
// "funding_rate": "0.000187",
// "next_funding_rate_timestamp": 1675065600000,
// "contract_type": "Quanto",
// "contract_price": "23685",
// "contract_price_currency": "USDT"
// }
//
const marketId = this.safeString(contract, 'ticker_id');
const fundingTimestamp = this.safeInteger(contract, 'next_funding_rate_timestamp');
return {
'info': contract,
'symbol': this.safeSymbol(marketId, market),
'markPrice': undefined,
'indexPrice': this.safeNumber(contract, 'index_price'),
'interestRate': undefined,
'estimatedSettlePrice': undefined,
'timestamp': undefined,
'datetime': undefined,
'fundingRate': this.safeNumber(contract, 'funding_rate'),
'fundingTimestamp': fundingTimestamp,
'fundingDatetime': this.iso8601(fundingTimestamp),
'nextFundingRate': undefined,
'nextFundingTimestamp': undefined,
'nextFundingDatetime': undefined,
'previousFundingRate': undefined,
'previousFundingTimestamp': undefined,
'previousFundingDatetime': undefined,
};
}
async transfer(code, amount, fromAccount, toAccount, params = {}) {
/**
* @method
* @name btcex#transfer
* @description transfer currency internally between wallets on the same account
* @see https://docs.btcex.com/#asset-transfer
* @param {string} code unified currency code
* @param {float} amount amount to transfer
* @param {string} fromAccount account to transfer from
* @param {string} toAccount account to transfer to
* @param {object} params extra parameters specific to the btcex api endpoint
* @returns {object} a [transfer structure]{@link https://docs.ccxt.com/#/?id=transfer-structure}
*/
await this.signIn();
await this.loadMarkets();
const currency = this.currency(code);
const accountsByType = this.safeValue(this.options, 'accountsByType', {});
const fromId = this.safeString(accountsByType, fromAccount, fromAccount);
const toId = this.safeString(accountsByType, toAccount, toAccount);
const request = {
'coin_type': currency['id'],
'amount': this.currencyToPrecision(code, amount),
'from': fromId,
'to': toId, // WALLET, SPOT, PERPETUAL
};
const response = await this.privatePostSubmitTransfer(this.extend(request, params));
//
// {
// "id": "1674937273",
// "jsonrpc": "2.0",
// "usIn": 1674937274762,
// "usOut": 1674937274774,
// "usDiff": 12,
// "result": "ok"
// }
//
return this.parseTransfer(response, currency);
}
parseTransfer(transfer, currency = undefined) {
//
// {
// "id": "1674937273",
// "jsonrpc": "2.0",
// "usIn": 1674937274762,
// "usOut": 1674937274774,
// "usDiff": 12,
// "result": "ok"
// }
//
return {
'info': transfer,
'id': this.safeString(transfer, 'id'),
'timestamp': undefined,
'datetime': undefined,
'currency': undefined,
'amount': undefined,
'fromAccount': undefined,
'toAccount': undefined,
'status': undefined,
};
}
async fetchOpenInterest(symbol, params = {}) {
/**
* @method
* @name btcex#fetchOpenInterest
* @description fetch the open interest of a market
* @see https://docs.btcex.com/#contracts
* @param {string} symbol unified CCXT market symbol
* @param {object} params extra parameters specific to the btcex api endpoint
* @returns {object} an open interest structure{@link https://docs.ccxt.com/#/?id=interest-history-structure}
*/
await this.loadMarkets();
const market = this.market(symbol);
if (!market['contract']) {
throw new errors.BadRequest(this.id + ' fetchOpenInterest() supports contract markets only');
}
const response = await this.publicGetCoinGeckoContracts(params);
//
// {
// "jsonrpc": "2.0",
// "usIn": 1674803585896,
// "usOut": 1674803585943,
// "usDiff": 47,
// "result": [
// {
// "ticker_id": "BTC-USDT-PERPETUAL",
// "base_currency": "BTC",
// "target_currency": "USDT",
// "last_price": "23685",
// "base_volume": "167011.37199999999999989",
// "target_volume": "3837763191.33800288010388613",
// "bid": "23684.5",
// "ask": "23685",
// "high": "23971.5",
// "low": "23156",
// "product_type": "perpetual",
// "open_interest": "24242.36",
// "index_price": "23686.4",
// "index_name": "BTC-USDT",
// "index_currency": "BTC",
// "start_timestamp": 1631004005882,
// "funding_rate": "0.000187",
// "next_funding_rate_timestamp": 1675065600000,
// "contract_type": "Quanto",
// "contract_price": "23685",
// "contract_price_currency": "USDT"
// },
// ]
// }
//
const data = this.safeValue(response, 'result', []);
for (let i = 0; i < data.length; i++) {
const entry = data[i];
const marketId = this.safeString(entry, 'ticker_id');
if (marketId === market['id']) {
return this.parseOpenInterest(entry, market);
}
}
return this.parseOpenInterest(data, market);
}
parseOpenInterest(interest, market = undefined) {
//
// {
// "ticker_id": "BTC-USDT-PERPETUAL",
// "base_currency": "BTC",
// "target_currency": "USDT",
// "last_price": "23685",
// "base_volume": "167011.37199999999999989",
// "target_volume": "3837763191.33800288010388613",
// "bid": "23684.5",
// "ask": "23685",
// "high": "23971.5",
// "low": "23156",
// "product_type": "perpetual",
// "open_interest": "24242.36",
// "index_price": "23686.4",
// "index_name": "BTC-USDT",
// "index_currency": "BTC",
// "start_timestamp": 1631004005882,
// "funding_rate": "0.000187",
// "next_funding_rate_timestamp": 1675065600000,
// "contract_type": "Quanto",
// "contract_price": "23685",
// "contract_price_currency": "USDT"
// }
//
const marketId = this.safeString(interest, 'ticker_id');
market = this.safeMarket(marketId, market);
const openInterest = this.safeNumber(interest, 'open_interest');
return {
'info': interest,
'symbol': market['symbol'],
'baseVolume': openInterest,
'quoteVolume': undefined,
'openInterestAmount': openInterest,
'openInterestValue': undefined,
'timestamp': undefined,
'datetime': undefined,
};
}
sign(path, api = 'public', method = 'GET', params = {}, headers = undefined, body = undefined) {
let request = '/' + 'api/' + this.version + '/' + api + '/' + path;
if (api === 'public') {
if (Object.keys(params).length) {
request += '?' + this.urlencode(params);
}
}
if (api === 'private') {
this.checkRequiredCredentials();
if (method === 'GET') {
if (Object.keys(params).length) {
request += '?' + this.urlencode(params);
}
}
const sessionToken = this.safeString(this.options, 'accessToken');
if (sessionToken === undefined) {
throw new errors.AuthenticationError(this.id + ' sign() requires access token');
}
headers = {
'Authorization': 'bearer ' + sessionToken,
};
if (method === 'POST') {
headers['Content-Type'] = 'application/json';
if (Object.keys(params).length) {
const rpcPayload = {
'jsonrpc': '2.0',
'id': this.nonce(),
'method': '/' + api + '/' + path,
'params': params,
};
body = this.json(rpcPayload);
}
}
}
const url = this.urls['api']['rest'] + request;
return { 'url': url, 'method': method, 'body': body, 'headers': headers };
}
handleErrors(code, reason, url, method, headers, body, response, requestHeaders, requestBody) {
if (response === undefined) {
return undefined; // fallback to the default error handler
}
const error = this.safeValue(response, 'error');
if (error) {
const feedback = this.id + ' ' + body;
const codeInner = this.safeString(error, 'code');
const message = this.safeString(error, 'message');
this.throwExactlyMatchedException(this.exceptions['exact'], codeInner, feedback);
this.throwBroadlyMatchedException(this.exceptions['broad'], message, feedback);
throw new errors.ExchangeError(feedback); // unknown message
}
return undefined;
}
}
module.exports = btcex;