astro-perp-ccxt-dev
Version:
2,006 lines • 87.7 kB
JavaScript
'use strict';
var gemini$1 = require('./abstract/gemini.js');
var errors = require('./base/errors.js');
var Precise = require('./base/Precise.js');
var number = require('./base/functions/number.js');
var sha512 = require('./static_dependencies/noble-hashes/sha512.js');
// ----------------------------------------------------------------------------
// ---------------------------------------------------------------------------
/**
* @class gemini
* @augments Exchange
*/
class gemini extends gemini$1 {
describe() {
return this.deepExtend(super.describe(), {
'id': 'gemini',
'name': 'Gemini',
'countries': ['US'],
// 600 requests a minute = 10 requests per second => 1000ms / 10 = 100ms between requests (private endpoints)
// 120 requests a minute = 2 requests per second => ( 1000ms / rateLimit ) / 2 = 5 (public endpoints)
'rateLimit': 100,
'version': 'v1',
'pro': true,
'has': {
'CORS': undefined,
'spot': true,
'margin': false,
'swap': true,
'future': false,
'option': false,
'addMargin': false,
'cancelOrder': true,
'closeAllPositions': false,
'closePosition': false,
'createDepositAddress': true,
'createMarketOrder': false,
'createOrder': true,
'createReduceOnlyOrder': false,
'fetchBalance': true,
'fetchBidsAsks': false,
'fetchBorrowRateHistories': false,
'fetchBorrowRateHistory': false,
'fetchClosedOrders': false,
'fetchCrossBorrowRate': false,
'fetchCrossBorrowRates': false,
'fetchCurrencies': true,
'fetchDepositAddress': true,
'fetchDepositAddresses': false,
'fetchDepositAddressesByNetwork': true,
'fetchDepositsWithdrawals': true,
'fetchFundingHistory': false,
'fetchFundingRate': false,
'fetchFundingRateHistory': false,
'fetchFundingRates': false,
'fetchIndexOHLCV': false,
'fetchIsolatedBorrowRate': false,
'fetchIsolatedBorrowRates': false,
'fetchLeverage': false,
'fetchLeverageTiers': false,
'fetchMarginMode': false,
'fetchMarkets': true,
'fetchMarkOHLCV': false,
'fetchMyTrades': true,
'fetchOHLCV': true,
'fetchOpenInterestHistory': false,
'fetchOpenOrders': true,
'fetchOrder': true,
'fetchOrderBook': true,
'fetchOrders': false,
'fetchPosition': false,
'fetchPositionMode': false,
'fetchPositions': false,
'fetchPositionsRisk': false,
'fetchPremiumIndexOHLCV': false,
'fetchTicker': true,
'fetchTickers': true,
'fetchTrades': true,
'fetchTradingFee': false,
'fetchTradingFees': true,
'fetchTransactions': 'emulated',
'postOnly': true,
'reduceMargin': false,
'sandbox': true,
'setLeverage': false,
'setMarginMode': false,
'setPositionMode': false,
'withdraw': true,
},
'urls': {
'logo': 'https://user-images.githubusercontent.com/1294454/27816857-ce7be644-6096-11e7-82d6-3c257263229c.jpg',
'api': {
'public': 'https://api.gemini.com',
'private': 'https://api.gemini.com',
'web': 'https://docs.gemini.com',
'webExchange': 'https://exchange.gemini.com',
},
'www': 'https://gemini.com/',
'doc': [
'https://docs.gemini.com/rest-api',
'https://docs.sandbox.gemini.com',
],
'test': {
'public': 'https://api.sandbox.gemini.com',
'private': 'https://api.sandbox.gemini.com',
// use the true doc instead of the sandbox doc
// since they differ in parsing
// https://github.com/ccxt/ccxt/issues/7874
// https://github.com/ccxt/ccxt/issues/7894
'web': 'https://docs.gemini.com',
'webExchange': 'https://exchange.gemini.com',
},
'fees': [
'https://gemini.com/api-fee-schedule',
'https://gemini.com/trading-fees',
'https://gemini.com/transfer-fees',
],
},
'api': {
'webExchange': {
'get': [
'',
],
},
'web': {
'get': [
'rest-api',
],
},
'public': {
'get': {
'v1/symbols': 5,
'v1/symbols/details/{symbol}': 5,
'v1/staking/rates': 5,
'v1/pubticker/{symbol}': 5,
'v2/ticker/{symbol}': 5,
'v2/candles/{symbol}/{timeframe}': 5,
'v1/trades/{symbol}': 5,
'v1/auction/{symbol}': 5,
'v1/auction/{symbol}/history': 5,
'v1/pricefeed': 5,
'v1/book/{symbol}': 5,
'v1/earn/rates': 5,
},
},
'private': {
'post': {
'v1/staking/unstake': 1,
'v1/staking/stake': 1,
'v1/staking/rewards': 1,
'v1/staking/history': 1,
'v1/order/new': 1,
'v1/order/cancel': 1,
'v1/wrap/{symbol}': 1,
'v1/order/cancel/session': 1,
'v1/order/cancel/all': 1,
'v1/order/status': 1,
'v1/orders': 1,
'v1/mytrades': 1,
'v1/notionalvolume': 1,
'v1/tradevolume': 1,
'v1/clearing/new': 1,
'v1/clearing/status': 1,
'v1/clearing/cancel': 1,
'v1/clearing/confirm': 1,
'v1/balances': 1,
'v1/balances/staking': 1,
'v1/notionalbalances/{currency}': 1,
'v1/transfers': 1,
'v1/addresses/{network}': 1,
'v1/deposit/{network}/newAddress': 1,
'v1/deposit/{currency}/newAddress': 1,
'v1/withdraw/{currency}': 1,
'v1/account/transfer/{currency}': 1,
'v1/payments/addbank': 1,
'v1/payments/methods': 1,
'v1/payments/sen/withdraw': 1,
'v1/balances/earn': 1,
'v1/earn/interest': 1,
'v1/earn/history': 1,
'v1/approvedAddresses/{network}/request': 1,
'v1/approvedAddresses/account/{network}': 1,
'v1/approvedAddresses/{network}/remove': 1,
'v1/account': 1,
'v1/account/create': 1,
'v1/account/list': 1,
'v1/heartbeat': 1,
'v1/roles': 1,
},
},
},
'precisionMode': number.TICK_SIZE,
'fees': {
'trading': {
'taker': 0.004,
'maker': 0.002,
},
},
'httpExceptions': {
'400': errors.BadRequest,
'403': errors.PermissionDenied,
'404': errors.OrderNotFound,
'406': errors.InsufficientFunds,
'429': errors.RateLimitExceeded,
'500': errors.ExchangeError,
'502': errors.ExchangeNotAvailable,
'503': errors.OnMaintenance, // The exchange is down for maintenance
},
'timeframes': {
'1m': '1m',
'5m': '5m',
'15m': '15m',
'30m': '30m',
'1h': '1hr',
'6h': '6hr',
'1d': '1day',
},
'exceptions': {
'exact': {
'AuctionNotOpen': errors.BadRequest,
'ClientOrderIdTooLong': errors.BadRequest,
'ClientOrderIdMustBeString': errors.BadRequest,
'ConflictingOptions': errors.BadRequest,
'EndpointMismatch': errors.BadRequest,
'EndpointNotFound': errors.BadRequest,
'IneligibleTiming': errors.BadRequest,
'InsufficientFunds': errors.InsufficientFunds,
'InvalidJson': errors.BadRequest,
'InvalidNonce': errors.InvalidNonce,
'InvalidApiKey': errors.AuthenticationError,
'InvalidOrderType': errors.InvalidOrder,
'InvalidPrice': errors.InvalidOrder,
'InvalidQuantity': errors.InvalidOrder,
'InvalidSide': errors.InvalidOrder,
'InvalidSignature': errors.AuthenticationError,
'InvalidSymbol': errors.BadRequest,
'InvalidTimestampInPayload': errors.BadRequest,
'Maintenance': errors.OnMaintenance,
'MarketNotOpen': errors.InvalidOrder,
'MissingApikeyHeader': errors.AuthenticationError,
'MissingOrderField': errors.InvalidOrder,
'MissingRole': errors.AuthenticationError,
'MissingPayloadHeader': errors.AuthenticationError,
'MissingSignatureHeader': errors.AuthenticationError,
'NoSSL': errors.AuthenticationError,
'OptionsMustBeArray': errors.BadRequest,
'OrderNotFound': errors.OrderNotFound,
'RateLimit': errors.RateLimitExceeded,
'System': errors.ExchangeError,
'UnsupportedOption': errors.BadRequest, // This order execution option is not supported.
},
'broad': {
'The Gemini Exchange is currently undergoing maintenance.': errors.OnMaintenance,
'We are investigating technical issues with the Gemini Exchange.': errors.ExchangeNotAvailable,
'Internal Server Error': errors.ExchangeNotAvailable,
},
},
'options': {
'fetchMarketsMethod': 'fetch_markets_from_api',
'fetchMarketFromWebRetries': 10,
'fetchMarketsFromAPI': {
'fetchDetailsForAllSymbols': false,
'quoteCurrencies': ['USDT', 'GUSD', 'USD', 'DAI', 'EUR', 'GBP', 'SGD', 'BTC', 'ETH', 'LTC', 'BCH', 'SOL'],
},
'fetchMarkets': {
'webApiEnable': true,
'webApiRetries': 10,
},
'fetchUsdtMarkets': ['btcusdt', 'ethusdt'],
'fetchCurrencies': {
'webApiEnable': true,
'webApiRetries': 5,
'webApiMuteFailure': true,
},
'fetchTickerMethod': 'fetchTickerV1',
'networks': {
'BTC': 'bitcoin',
'ERC20': 'ethereum',
'BCH': 'bitcoincash',
'LTC': 'litecoin',
'ZEC': 'zcash',
'FIL': 'filecoin',
'DOGE': 'dogecoin',
'XTZ': 'tezos',
'AVAXX': 'avalanche',
'SOL': 'solana',
'ATOM': 'cosmos',
'DOT': 'polkadot',
},
'nonce': 'milliseconds',
'conflictingMarkets': {
'paxgusd': {
'base': 'PAXG',
'quote': 'USD',
},
},
},
'features': {
'default': {
'sandbox': true,
'createOrder': {
'marginMode': false,
'triggerPrice': true,
'triggerPriceType': undefined,
'triggerDirection': false,
'stopLossPrice': false,
'takeProfitPrice': false,
'attachedStopLossTakeProfit': undefined,
'timeInForce': {
'IOC': true,
'FOK': true,
'PO': true,
'GTD': false,
},
'hedged': false,
'trailing': false,
'leverage': false,
'marketBuyByCost': true,
'marketBuyRequiresPrice': false,
'selfTradePrevention': false,
'iceberg': false,
},
'createOrders': undefined,
'fetchMyTrades': {
'marginMode': false,
'limit': 500,
'daysBack': undefined,
'untilDays': undefined,
'symbolRequired': true,
},
'fetchOrder': {
'marginMode': false,
'trigger': false,
'trailing': false,
'symbolRequired': false,
},
'fetchOpenOrders': {
'marginMode': false,
'limit': undefined,
'trigger': false,
'trailing': false,
'symbolRequired': false,
},
'fetchOrders': undefined,
'fetchClosedOrders': undefined,
'fetchOHLCV': {
'limit': undefined,
},
},
'spot': {
'extends': 'default',
},
'swap': {
'linear': {
'extends': 'default',
},
'inverse': undefined,
},
'future': {
'linear': undefined,
'inverse': undefined,
},
},
});
}
/**
* @method
* @name gemini#fetchCurrencies
* @description fetches all available currencies on an exchange
* @param {object} [params] extra parameters specific to the endpoint
* @returns {object} an associative dictionary of currencies
*/
async fetchCurrencies(params = {}) {
return await this.fetchCurrenciesFromWeb(params);
}
/**
* @method
* @name gemini#fetchCurrenciesFromWeb
* @ignore
* @description fetches all available currencies on an exchange
* @param {object} [params] extra parameters specific to the endpoint
* @returns {object} an associative dictionary of currencies
*/
async fetchCurrenciesFromWeb(params = {}) {
const data = await this.fetchWebEndpoint('fetchCurrencies', 'webExchangeGet', true, '="currencyData">', '</script>');
if (data === undefined) {
return undefined;
}
//
// {
// "tradingPairs": [ [ 'BTCUSD', 2, 8, '0.00001', 10, true ], ... ],
// "currencies": [
// [ "ORCA", "Orca", 204, 6, 0, 6, 8, false, null, "solana" ], // as confirmed, precisions seem to be the 5th index
// [ "ATOM", "Cosmos", 44, 6, 0, 6, 8, false, null, "cosmos" ],
// [ "ETH", "Ether", 2, 6, 0, 18, 8, false, null, "ethereum" ],
// [ "GBP", "Pound Sterling", 22, 2, 2, 2, 2, true, "£", null ],
// ...
// ],
// "networks": [
// [ "solana", "SOL", "Solana" ],
// [ "zcash", "ZEC", "Zcash" ],
// [ "tezos", "XTZ", "Tezos" ],
// [ "cosmos", "ATOM", "Cosmos" ],
// [ "ethereum", "ETH", "Ethereum" ],
// ...
// ]
// }
//
const result = {};
this.options['tradingPairs'] = this.safeList(data, 'tradingPairs');
const currenciesArray = this.safeValue(data, 'currencies', []);
for (let i = 0; i < currenciesArray.length; i++) {
const currency = currenciesArray[i];
const id = this.safeString(currency, 0);
const code = this.safeCurrencyCode(id);
const type = this.safeString(currency, 7) ? 'fiat' : 'crypto';
const precision = this.parseNumber(this.parsePrecision(this.safeString(currency, 5)));
const networks = {};
const networkId = this.safeString(currency, 9);
let networkCode = undefined;
if (networkId !== undefined) {
networkCode = this.networkIdToCode(networkId);
networks[networkCode] = {
'info': currency,
'id': networkId,
'network': networkCode,
'active': undefined,
'deposit': undefined,
'withdraw': undefined,
'fee': undefined,
'precision': precision,
'limits': {
'deposit': {
'min': undefined,
'max': undefined,
},
'withdraw': {
'min': undefined,
'max': undefined,
},
},
};
}
result[code] = this.safeCurrencyStructure({
'info': currency,
'id': id,
'code': code,
'name': this.safeString(currency, 1),
'active': undefined,
'deposit': undefined,
'withdraw': undefined,
'fee': undefined,
'type': type,
'precision': precision,
'limits': {
'deposit': {
'min': undefined,
'max': undefined,
},
'withdraw': {
'min': undefined,
'max': undefined,
},
},
'networks': networks,
});
}
return result;
}
/**
* @method
* @name gemini#fetchMarkets
* @description retrieves data on all markets for gemini
* @see https://docs.gemini.com/rest-api/#symbols
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @returns {object[]} an array of objects representing market data
*/
async fetchMarkets(params = {}) {
const method = this.safeValue(this.options, 'fetchMarketsMethod', 'fetch_markets_from_api');
if (method === 'fetch_markets_from_web') {
const promises = [];
promises.push(this.fetchMarketsFromWeb(params)); // get usd markets
promises.push(this.fetchUSDTMarkets(params)); // get usdt markets
const promisesResult = await Promise.all(promises);
return this.arrayConcat(promisesResult[0], promisesResult[1]);
}
return await this.fetchMarketsFromAPI(params);
}
async fetchMarketsFromWeb(params = {}) {
const data = await this.fetchWebEndpoint('fetchMarkets', 'webGetRestApi', false, '<h1 id="symbols-and-minimums">Symbols and minimums</h1>');
const error = this.id + ' fetchMarketsFromWeb() the API doc HTML markup has changed, breaking the parser of order limits and precision info for markets.';
const tables = data.split('tbody>');
const numTables = tables.length;
if (numTables < 2) {
throw new errors.NotSupported(error);
}
const rows = tables[1].split("\n<tr>\n"); // eslint-disable-line quotes
const numRows = rows.length;
if (numRows < 2) {
throw new errors.NotSupported(error);
}
const result = [];
// skip the first element (empty string)
for (let i = 1; i < numRows; i++) {
const row = rows[i];
const cells = row.split("</td>\n"); // eslint-disable-line quotes
const numCells = cells.length;
if (numCells < 5) {
throw new errors.NotSupported(error);
}
// [
// '<td>btcusd', // currency
// '<td>0.00001 BTC (1e-5)', // min order size
// '<td>0.00000001 BTC (1e-8)', // tick size
// '<td>0.01 USD', // quote currency price increment
// '</tr>'
// ]
let marketId = cells[0].replace('<td>', '');
marketId = marketId.replace('*', '');
// const base = this.safeCurrencyCode (baseId);
const minAmountString = cells[1].replace('<td>', '');
const minAmountParts = minAmountString.split(' ');
const minAmount = this.safeNumber(minAmountParts, 0);
const amountPrecisionString = cells[2].replace('<td>', '');
const amountPrecisionParts = amountPrecisionString.split(' ');
const idLength = marketId.length - 0;
const startingIndex = idLength - 3;
const pricePrecisionString = cells[3].replace('<td>', '');
const pricePrecisionParts = pricePrecisionString.split(' ');
const quoteId = this.safeStringLower(pricePrecisionParts, 1, marketId.slice(startingIndex, idLength));
const baseId = this.safeStringLower(amountPrecisionParts, 1, marketId.replace(quoteId, ''));
const base = this.safeCurrencyCode(baseId);
const quote = this.safeCurrencyCode(quoteId);
result.push({
'id': marketId,
'symbol': base + '/' + quote,
'base': base,
'quote': quote,
'settle': undefined,
'baseId': baseId,
'quoteId': quoteId,
'settleId': undefined,
'type': 'spot',
'spot': true,
'margin': false,
'swap': false,
'future': false,
'option': false,
'active': undefined,
'contract': false,
'linear': undefined,
'inverse': undefined,
'contractSize': undefined,
'expiry': undefined,
'expiryDatetime': undefined,
'strike': undefined,
'optionType': undefined,
'precision': {
'amount': this.safeNumber(amountPrecisionParts, 0),
'price': this.safeNumber(pricePrecisionParts, 0),
},
'limits': {
'leverage': {
'min': undefined,
'max': undefined,
},
'amount': {
'min': minAmount,
'max': undefined,
},
'price': {
'min': undefined,
'max': undefined,
},
'cost': {
'min': undefined,
'max': undefined,
},
},
'created': undefined,
'info': row,
});
}
return result;
}
parseMarketActive(status) {
const statuses = {
'open': true,
'closed': false,
'cancel_only': true,
'post_only': true,
'limit_only': true,
};
if (status === undefined) {
return true; // as defaulted below
}
return this.safeBool(statuses, status, true);
}
async fetchUSDTMarkets(params = {}) {
// these markets can't be scrapped and fetchMarketsFrom api does an extra call
// to load market ids which we don't need here
if ('test' in this.urls) {
return []; // sandbox does not have usdt markets
}
const fetchUsdtMarkets = this.safeValue(this.options, 'fetchUsdtMarkets', []);
const result = [];
for (let i = 0; i < fetchUsdtMarkets.length; i++) {
const marketId = fetchUsdtMarkets[i];
const request = {
'symbol': marketId,
};
// don't use Promise.all here, for some reason the exchange can't handle it and crashes
const rawResponse = await this.publicGetV1SymbolsDetailsSymbol(this.extend(request, params));
result.push(this.parseMarket(rawResponse));
}
return result;
}
async fetchMarketsFromAPI(params = {}) {
const marketIdsRaw = await this.publicGetV1Symbols(params);
//
// [
// "btcusd",
// "linkusd",
// ...
// ]
//
const result = [];
const options = this.safeDict(this.options, 'fetchMarketsFromAPI', {});
const bugSymbol = 'efilfil'; // we skip this inexistent test symbol, which bugs other functions
const marketIds = [];
for (let i = 0; i < marketIdsRaw.length; i++) {
if (marketIdsRaw[i] !== bugSymbol) {
marketIds.push(marketIdsRaw[i]);
}
}
if (this.safeBool(options, 'fetchDetailsForAllSymbols', false)) {
const promises = [];
for (let i = 0; i < marketIds.length; i++) {
const marketId = marketIds[i];
const request = {
'symbol': marketId,
};
promises.push(this.publicGetV1SymbolsDetailsSymbol(this.extend(request, params)));
//
// {
// "symbol": "BTCUSD",
// "base_currency": "BTC",
// "quote_currency": "USD",
// "tick_size": 1E-8,
// "quote_increment": 0.01,
// "min_order_size": "0.00001",
// "status": "open",
// "wrap_enabled": false
// }
//
}
const responses = await Promise.all(promises);
for (let i = 0; i < responses.length; i++) {
result.push(this.parseMarket(responses[i]));
}
}
else {
// use trading-pairs info, if it was fetched
const tradingPairs = this.safeList(this.options, 'tradingPairs');
if (tradingPairs !== undefined) {
const indexedTradingPairs = this.indexBy(tradingPairs, 0);
for (let i = 0; i < marketIds.length; i++) {
const marketId = marketIds[i];
const tradingPair = this.safeList(indexedTradingPairs, marketId.toUpperCase());
if (tradingPair !== undefined) {
result.push(this.parseMarket(tradingPair));
}
}
}
else {
for (let i = 0; i < marketIds.length; i++) {
result.push(this.parseMarket(marketIds[i]));
}
}
}
return result;
}
parseMarket(response) {
//
// response might be:
//
// btcusd
//
// or
//
// [
// 'BTCUSD', // symbol
// 2, // priceTickDecimalPlaces
// 8, // quantityTickDecimalPlaces
// '0.00001', // quantityMinimum
// 10, // quantityRoundDecimalPlaces
// true // minimumsAreInclusive
// ],
//
// or
//
// {
// "symbol": "BTCUSD", // perpetuals have 'PERP' suffix, i.e. DOGEUSDPERP
// "base_currency": "BTC",
// "quote_currency": "USD",
// "tick_size": 1E-8,
// "quote_increment": 0.01,
// "min_order_size": "0.00001",
// "status": "open",
// "wrap_enabled": false
// "product_type": "swap", // only in perps
// "contract_type": "linear", // only in perps
// "contract_price_currency": "GUSD" // only in perps
// }
//
let marketId = undefined;
let baseId = undefined;
let quoteId = undefined;
let settleId = undefined;
let tickSize = undefined;
let amountPrecision = undefined;
let minSize = undefined;
let status = undefined;
let swap = false;
let contractSize = undefined;
let linear = undefined;
let inverse = undefined;
const isString = (typeof response === 'string');
const isArray = (Array.isArray(response));
if (!isString && !isArray) {
marketId = this.safeStringLower(response, 'symbol');
amountPrecision = this.safeNumber(response, 'tick_size'); // right, exchange has an imperfect naming and this turns out to be an amount-precision
tickSize = this.safeNumber(response, 'quote_increment'); // this is tick-size actually
minSize = this.safeNumber(response, 'min_order_size');
status = this.parseMarketActive(this.safeString(response, 'status'));
baseId = this.safeString(response, 'base_currency');
quoteId = this.safeString(response, 'quote_currency');
settleId = this.safeString(response, 'contract_price_currency');
}
else {
// if no detailed API was called, then parse either string or array
if (isString) {
marketId = response;
}
else {
marketId = this.safeStringLower(response, 0);
tickSize = this.parseNumber(this.parsePrecision(this.safeString(response, 1))); // priceTickDecimalPlaces
amountPrecision = this.parseNumber(this.parsePrecision(this.safeString(response, 2))); // quantityTickDecimalPlaces
minSize = this.safeNumber(response, 3); // quantityMinimum
}
const marketIdUpper = marketId.toUpperCase();
const isPerp = (marketIdUpper.indexOf('PERP') >= 0);
const marketIdWithoutPerp = marketIdUpper.replace('PERP', '');
const conflictingMarkets = this.safeDict(this.options, 'conflictingMarkets', {});
const lowerCaseId = marketIdWithoutPerp.toLowerCase();
if (lowerCaseId in conflictingMarkets) {
const conflictingMarket = conflictingMarkets[lowerCaseId];
baseId = conflictingMarket['base'];
quoteId = conflictingMarket['quote'];
if (isPerp) {
settleId = conflictingMarket['quote'];
}
}
else {
const quoteCurrencies = this.handleOption('fetchMarketsFromAPI', 'quoteCurrencies', []);
for (let i = 0; i < quoteCurrencies.length; i++) {
const quoteCurrency = quoteCurrencies[i];
if (marketIdWithoutPerp.endsWith(quoteCurrency)) {
const quoteLength = this.parseToInt(-1 * quoteCurrency.length);
baseId = marketIdWithoutPerp.slice(0, quoteLength);
quoteId = quoteCurrency;
if (isPerp) {
settleId = quoteCurrency; // always same
}
break;
}
}
}
}
const base = this.safeCurrencyCode(baseId);
const quote = this.safeCurrencyCode(quoteId);
const settle = this.safeCurrencyCode(settleId);
let symbol = base + '/' + quote;
if (settleId !== undefined) {
symbol = symbol + ':' + settle;
swap = true;
contractSize = tickSize; // always same
linear = true; // always linear
inverse = false;
}
const type = swap ? 'swap' : 'spot';
return {
'id': marketId,
'symbol': symbol,
'base': base,
'quote': quote,
'settle': settle,
'baseId': baseId,
'quoteId': quoteId,
'settleId': settleId,
'type': type,
'spot': !swap,
'margin': false,
'swap': swap,
'future': false,
'option': false,
'active': status,
'contract': swap,
'linear': linear,
'inverse': inverse,
'contractSize': contractSize,
'expiry': undefined,
'expiryDatetime': undefined,
'strike': undefined,
'optionType': undefined,
'precision': {
'price': tickSize,
'amount': amountPrecision,
},
'limits': {
'leverage': {
'min': undefined,
'max': undefined,
},
'amount': {
'min': minSize,
'max': undefined,
},
'price': {
'min': undefined,
'max': undefined,
},
'cost': {
'min': undefined,
'max': undefined,
},
},
'created': undefined,
'info': response,
};
}
/**
* @method
* @name gemini#fetchOrderBook
* @description fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
* @see https://docs.gemini.com/rest-api/#current-order-book
* @param {string} symbol unified symbol of the market to fetch the order book for
* @param {int} [limit] the maximum amount of order book entries to return
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
*/
async fetchOrderBook(symbol, limit = undefined, params = {}) {
await this.loadMarkets();
const market = this.market(symbol);
const request = {
'symbol': market['id'],
};
if (limit !== undefined) {
request['limit_bids'] = limit;
request['limit_asks'] = limit;
}
const response = await this.publicGetV1BookSymbol(this.extend(request, params));
return this.parseOrderBook(response, market['symbol'], undefined, 'bids', 'asks', 'price', 'amount');
}
async fetchTickerV1(symbol, params = {}) {
await this.loadMarkets();
const market = this.market(symbol);
const request = {
'symbol': market['id'],
};
const response = await this.publicGetV1PubtickerSymbol(this.extend(request, params));
//
// {
// "bid":"9117.95",
// "ask":"9117.96",
// "volume":{
// "BTC":"1615.46861748",
// "USD":"14727307.57545006088",
// "timestamp":1594982700000
// },
// "last":"9115.23"
// }
//
return this.parseTicker(response, market);
}
async fetchTickerV2(symbol, params = {}) {
await this.loadMarkets();
const market = this.market(symbol);
const request = {
'symbol': market['id'],
};
const response = await this.publicGetV2TickerSymbol(this.extend(request, params));
//
// {
// "symbol":"BTCUSD",
// "open":"9080.58",
// "high":"9184.53",
// "low":"9063.56",
// "close":"9116.08",
// // Hourly prices descending for past 24 hours
// "changes":["9117.33","9105.69","9106.23","9120.35","9098.57","9114.53","9113.55","9128.01","9113.63","9133.49","9133.49","9137.75","9126.73","9103.91","9119.33","9123.04","9124.44","9117.57","9114.22","9102.33","9076.67","9074.72","9074.97","9092.05"],
// "bid":"9115.86",
// "ask":"9115.87"
// }
//
return this.parseTicker(response, market);
}
async fetchTickerV1AndV2(symbol, params = {}) {
const tickerPromiseA = this.fetchTickerV1(symbol, params);
const tickerPromiseB = this.fetchTickerV2(symbol, params);
const [tickerA, tickerB] = await Promise.all([tickerPromiseA, tickerPromiseB]);
return this.deepExtend(tickerA, {
'open': tickerB['open'],
'high': tickerB['high'],
'low': tickerB['low'],
'change': tickerB['change'],
'percentage': tickerB['percentage'],
'average': tickerB['average'],
'info': tickerB['info'],
});
}
/**
* @method
* @name gemini#fetchTicker
* @description fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
* @see https://docs.gemini.com/rest-api/#ticker
* @see https://docs.gemini.com/rest-api/#ticker-v2
* @param {string} symbol unified symbol of the market to fetch the ticker for
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @param {object} [params.fetchTickerMethod] 'fetchTickerV2', 'fetchTickerV1' or 'fetchTickerV1AndV2' - 'fetchTickerV1' for original ccxt.gemini.fetchTicker - 'fetchTickerV1AndV2' for 2 api calls to get the result of both fetchTicker methods - default = 'fetchTickerV1'
* @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
*/
async fetchTicker(symbol, params = {}) {
const method = this.safeValue(this.options, 'fetchTickerMethod', 'fetchTickerV1');
if (method === 'fetchTickerV1') {
return await this.fetchTickerV1(symbol, params);
}
if (method === 'fetchTickerV2') {
return await this.fetchTickerV2(symbol, params);
}
return await this.fetchTickerV1AndV2(symbol, params);
}
parseTicker(ticker, market = undefined) {
//
// fetchTickers
//
// {
// "pair": "BATUSD",
// "price": "0.20687",
// "percentChange24h": "0.0146"
// }
//
// fetchTickerV1
//
// {
// "bid":"9117.95",
// "ask":"9117.96",
// "volume":{
// "BTC":"1615.46861748",
// "USD":"14727307.57545006088",
// "timestamp":1594982700000
// },
// "last":"9115.23"
// }
//
// fetchTickerV2
//
// {
// "symbol":"BTCUSD",
// "open":"9080.58",
// "high":"9184.53",
// "low":"9063.56",
// "close":"9116.08",
// // Hourly prices descending for past 24 hours
// "changes":["9117.33","9105.69","9106.23","9120.35","9098.57","9114.53","9113.55","9128.01","9113.63","9133.49","9133.49","9137.75","9126.73","9103.91","9119.33","9123.04","9124.44","9117.57","9114.22","9102.33","9076.67","9074.72","9074.97","9092.05"],
// "bid":"9115.86",
// "ask":"9115.87"
// }
//
const volume = this.safeValue(ticker, 'volume', {});
const timestamp = this.safeInteger(volume, 'timestamp');
let symbol = undefined;
const marketId = this.safeStringLower(ticker, 'pair');
market = this.safeMarket(marketId, market);
let baseId = undefined;
let quoteId = undefined;
let base = undefined;
let quote = undefined;
if ((marketId !== undefined) && (market === undefined)) {
const idLength = marketId.length - 0;
if (idLength === 7) {
baseId = marketId.slice(0, 4);
quoteId = marketId.slice(4, 7);
}
else {
baseId = marketId.slice(0, 3);
quoteId = marketId.slice(3, 6);
}
base = this.safeCurrencyCode(baseId);
quote = this.safeCurrencyCode(quoteId);
symbol = base + '/' + quote;
}
if ((symbol === undefined) && (market !== undefined)) {
symbol = market['symbol'];
baseId = this.safeStringUpper(market, 'baseId');
quoteId = this.safeStringUpper(market, 'quoteId');
}
const price = this.safeString(ticker, 'price');
const last = this.safeString2(ticker, 'last', 'close', price);
const percentage = this.safeString(ticker, 'percentChange24h');
const open = this.safeString(ticker, 'open');
const baseVolume = this.safeString(volume, baseId);
const quoteVolume = this.safeString(volume, quoteId);
return this.safeTicker({
'symbol': symbol,
'timestamp': timestamp,
'datetime': this.iso8601(timestamp),
'high': this.safeString(ticker, 'high'),
'low': this.safeString(ticker, 'low'),
'bid': this.safeString(ticker, 'bid'),
'bidVolume': undefined,
'ask': this.safeString(ticker, 'ask'),
'askVolume': undefined,
'vwap': undefined,
'open': open,
'close': last,
'last': last,
'previousClose': undefined,
'change': undefined,
'percentage': percentage,
'average': undefined,
'baseVolume': baseVolume,
'quoteVolume': quoteVolume,
'info': ticker,
}, market);
}
/**
* @method
* @name gemini#fetchTickers
* @description fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
* @see https://docs.gemini.com/rest-api/#price-feed
* @param {string[]|undefined} symbols unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @returns {object} a dictionary of [ticker structures]{@link https://docs.ccxt.com/#/?id=ticker-structure}
*/
async fetchTickers(symbols = undefined, params = {}) {
await this.loadMarkets();
const response = await this.publicGetV1Pricefeed(params);
//
// [
// {
// "pair": "BATUSD",
// "price": "0.20687",
// "percentChange24h": "0.0146"
// },
// {
// "pair": "LINKETH",
// "price": "0.018",
// "percentChange24h": "0.0000"
// },
// ]
//
return this.parseTickers(response, symbols);
}
parseTrade(trade, market = undefined) {
//
// public fetchTrades
//
// {
// "timestamp":1601617445,
// "timestampms":1601617445144,
// "tid":14122489752,
// "price":"0.46476",
// "amount":"28.407209",
// "exchange":"gemini",
// "type":"buy"
// }
//
// private fetchTrades
//
// {
// "price":"3900.00",
// "amount":"0.00996",
// "timestamp":1638891173,
// "timestampms":1638891173518,
// "type":"Sell",
// "aggressor":false,
// "fee_currency":"EUR",
// "fee_amount":"0.00",
// "tid":73621746145,
// "order_id":"73621746059",
// "exchange":"gemini",
// "is_auction_fill":false,
// "is_clearing_fill":false,
// "symbol":"ETHEUR",
// "client_order_id":"1638891171610"
// }
//
const timestamp = this.safeInteger(trade, 'timestampms');
const id = this.safeString(trade, 'tid');
const orderId = this.safeString(trade, 'order_id');
const feeCurrencyId = this.safeString(trade, 'fee_currency');
const feeCurrencyCode = this.safeCurrencyCode(feeCurrencyId);
const fee = {
'cost': this.safeString(trade, 'fee_amount'),
'currency': feeCurrencyCode,
};
const priceString = this.safeString(trade, 'price');
const amountString = this.safeString(trade, 'amount');
const side = this.safeStringLower(trade, 'type');
const symbol = this.safeSymbol(undefined, market);
return this.safeTrade({
'id': id,
'order': orderId,
'info': trade,
'timestamp': timestamp,
'datetime': this.iso8601(timestamp),
'symbol': symbol,
'type': undefined,
'side': side,
'takerOrMaker': undefined,
'price': priceString,
'cost': undefined,
'amount': amountString,
'fee': fee,
}, market);
}
/**
* @method
* @name gemini#fetchTrades
* @description get the list of most recent trades for a particular symbol
* @see https://docs.gemini.com/rest-api/#trade-history
* @param {string} symbol unified symbol of the market to fetch trades for
* @param {int} [since] timestamp in ms of the earliest trade to fetch
* @param {int} [limit] the maximum amount of trades to fetch
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
*/
async fetchTrades(symbol, since = undefined, limit = undefined, params = {}) {
await this.loadMarkets();
const market = this.market(symbol);
const request = {
'symbol': market['id'],
};
if (limit !== undefined) {
request['limit_trades'] = Math.min(limit, 500);
}
if (since !== undefined) {
request['timestamp'] = since;
}
const response = await this.publicGetV1TradesSymbol(this.extend(request, params));
//
// [
// {
// "timestamp":1601617445,
// "timestampms":1601617445144,
// "tid":14122489752,
// "price":"0.46476",
// "amount":"28.407209",
// "exchange":"gemini",
// "type":"buy"
// },
// ]
//
return this.parseTrades(response, market, since, limit);
}
parseBalance(response) {
const result = { 'info': response };
for (let i = 0; i < response.length; i++) {
const balance = response[i];
const currencyId = this.safeString(balance, 'currency');
const code = this.safeCurrencyCode(currencyId);
const account = this.account();
account['free'] = this.safeString(balance, 'available');
account['total'] = this.safeString(balance, 'amount');
result[code] = account;
}
return this.safeBalance(result);
}
/**
* @method
* @name gemini#fetchTradingFees
* @description fetch the trading fees for multiple markets
* @see https://docs.gemini.com/rest-api/#get-notional-volume
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @returns {object} a dictionary of [fee structures]{@link https://docs.ccxt.com/#/?id=fee-structure} indexed by market symbols
*/
async fetchTradingFees(params = {}) {
await this.loadMarkets();
const response = await this.privatePostV1Notionalvolume(params);
//
// {
// "web_maker_fee_bps": 25,
// "web_taker_fee_bps": 35,
// "web_auction_fee_bps": 25,
// "api_maker_fee_bps": 10,
// "api_taker_fee_bps": 35,
// "api_auction_fee_bps": 20,
// "fix_maker_fee_bps": 10,
// "fix_taker_fee_bps": 35,
// "fix_auction_fee_bps": 20,
// "block_maker_fee_bps": 0,
// "block_taker_fee_bps": 50,
// "notional_30d_volume": 150.00,
// "last_updated_ms": 1551371446000,
// "date": "2019-02-28",
// "notional_1d_volume": [
// {
// "date": "2019-02-22",
// "notional_volume": 75.00
// },
// {
// "date": "2019-02-14",
// "notional_volume": 75.00
// }
// ]
// }
//
const makerBps = this.safeString(response, 'api_maker_fee_bps');
const takerBps = this.safeString(response, 'api_taker_fee_bps');
const makerString = Precise["default"].stringDiv(makerBps, '10000');
const takerString = Precise["default"].stringDiv(takerBps, '10000');
const maker = this.parseNumber(makerString);
const taker = this.parseNumber(takerString);
const result = {};
for (let i = 0; i < this.symbols.length; i++) {
const symbol = this.symbols[i];
result[symbol] = {
'info': response,
'symbol': symbol,
'maker': maker,
'taker': taker,
'percentage': true,
'tierBased': true,
};
}
return result;
}
/**
* @method
* @name gemini#fetchBalance
* @description query for balance and get the amount of funds available for trading or funds locked in orders
* @see https://docs.gemini.com/rest-api/#get-available-balances
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @returns {object} a [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
*/
async fetchBalance(params = {}) {
await this.loadMarkets();
const response = await this.privatePostV1Balances(params);
return this.parseBalance(response);
}
parseOrder(order, market = undefined) {
//
// createOrder (private)
//
// {
// "order_id":"106027397702",
// "id":"106027397702",
// "symbol":"etheur",
// "exchange":"gemini",
// "avg_execution_price":"2877.48",
// "side":"sell",
// "type":"exchange limit",
// "timestamp":"1650398122",
// "timestampms":1650398122308,
// "is_live":false,
// "is_cancelled":false,
// "is_hidden":false,
// "was_forced":false,
// "executed_amount":"0.014434",
// "client_order_id":"1650398121695",
// "options":[],
// "price":"2800.00",
// "original_amount":"0.014434",
// "remaining_amount":"0"
// }
//
// fetchOrder (private)
//
// {
// "order_id":"106028543717",
// "id":"106028543717",
// "symbol":"etheur",
// "exchange":"gemini",
// "avg_execution_price":"0.00",
// "side":"buy",
// "type":"exchange limit",
// "timestamp":"1650398446",
// "timestampms":1650398446375,
// "is_live":true,
// "is_cancelled":false,
// "is_hidden":false,
// "was_forced":false,
// "executed_amount":"0",
// "client_order_id":"1650398445709",
// "options":[],
// "price":"2000.00",
// "original_amount":"0.01",
// "remaining_amount":"0.01"
// }
//
// fetchOpenOrders (private)
//
// {
// "order_id":"106028543717",
// "id":"106028543717",
// "symbol":"etheur",
// "exchange":"gemini",
// "avg_execution_price":"0.00",
// "side":"buy",
// "type":"exchange limit",
// "timestamp":"1650398446",
// "timestampms":1650398446375,
// "is_live":true,
// "is_cancelled":false,
// "is_hidden":false,
// "was_forced":false,
// "executed_amount":"0",
// "client_order_id":"1650398445709",
// "options":[],
// "price":"2000.00",
// "original_amount":"0.01",
// "remaining_amount":"0.01"
// }
//
// cancelOrder (private)
//
// {
// "order_id":"106028543717",
// "id":"106028543717",
// "symbol":"etheur",
// "exchange":"gemini",
// "avg_execution_price":"0.00",
// "side":"buy",
// "type":"exchange limit",
// "timestamp":"1650398446",
// "timestampms":1650398446375,
// "is_live":false,
// "is_cancelled":true,
// "is_hidden":false,
// "was_forced":false,
// "executed_amount":"0",
// "client_order_id":"1650398445709",
// "reason":"Requested",
// "options":[],
// "price":"2000.00",
// "original_amount":"0.01",
// "remaining_amount":"0.01"
// }
//
const timestamp = this.safeInteger(order, 'timestampms');
const amount = this.safeString(order, 'original_amount');
const remaining = this.safeString(order, 'remaining_amount');
const filled = this.safeString(order, 'executed_amount');
let status = 'closed';
if (order['is_live']) {
status = 'open';
}
if (order['is_cancelled']) {
status = 'canceled';
}
const price = this.safeString(order, 'price');
const average = this.safeString(order, 'avg_execution_price');
let type = this.safeString(order, 'type');
if (type === 'exchange limit') {
type = 'limit';
}
else if (type === 'market buy' || type === 'market sell') {
type = 'market';
}
else {
type = order['type'];
}
const fee = undefined;
const marketId = this.safeString(order, 'symbol');
const symbol = this.safeSymbol(marketId, market);
const id = this.safeString(order, 'order_id');
const side = this.safeStringLower(order, 'side');
const clientOrderId = this.safeString(order, 'client_order_id');
const optionsArray = this.safeValue(order, 'options', []);
const option = this.safeString(optionsArray, 0);
let timeInForce = 'GTC';
let postOnly = false;
if (option !== undefined) {
if (option === 'immediate-or-cancel') {
timeInForce = 'IOC';
}
else if (option === 'fill-or-kill') {
timeInForce = 'FOK';
}
else if (option === 'maker-or-cancel') {
timeInForce = 'PO';
postOnly = true;
}
}
return this.safeOrder({
'id': id,
'clientOrderId': clientOrderId,
'info': order,
'timestamp': timestamp,
'datetime': this.iso8601(timestamp),
'lastTradeTimestamp': undefined,
'status': status,
'symbol': symbol,
'type': type,
'timeInForce': timeInForce,
'postOnly': postOnly,
'side': side,
'price': price,
'triggerPrice': undefined,
'average': average,
'cost': undefined,
'amount': amount,
'filled': filled,
'remaining': remaining,
'fee': fee,
'trades': undefined,
}, market);
}
/**
* @method
* @name gemini#fetchOrder
* @description fetches information on an order made by the user
* @see https://docs.gemini.com/rest-api/#order-status
* @param {string} id order id
* @param {string} symbol unified symbol of the market the order was made in
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
*/
async fetchOrder(id, symbol = undefined, params = {}) {
await this.loadMarkets();
const request = {
'order_id': id,
};
const response = await this.privatePostV1OrderStatus(this.extend(request, params));
//
// {
// "order_id":"106028543717",
// "id":"106028543717",
// "symbol":"etheur",
// "exchange":"gemini",
// "avg_execution_price":"0.00",
// "side":"buy",
// "type":"exchange limit",
// "timestamp":"1650398446",
// "timestampms":1650398446375,
// "is_live":true,
// "is_cancelled":false,
// "is_hidden":false,
// "was_forced":false,
// "executed_amount":"0",
// "client_order_id":"1650398445709",
// "options":[],
// "price":"2000.00",
// "original_amount":"0.01",
// "remaining_amount":"0.01"
// }
//
return this.parseOrder(response);
}
/**
* @method
* @name gemini#fetchOpenOrders
* @description fetch all unfilled currently open orders
* @see https://docs.gemini.com/rest-api/#get-active-orders
* @param {string} symbol unified market symbol
* @param {int} [since] the earliest time in ms to fetch open orders for
* @param {int} [limit] the maximum number of open orders structures to retrieve
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
*/
async fetchOpenOrders(symbol = undefined, since = undefined, limit = undefined, params = {}) {
await this.loadMarkets();
const response = await this.privatePostV1Orders(params);
//
// [
// {
// "order_id":"106028543717",
// "id":"106028543717",
// "symbol":"etheur",
// "exchange":"gemini",
// "avg_execution_price":"0.00",
// "side":"buy",
// "type":"exchange limit",
// "timestamp":"1650398446",
// "timestampms":1650398446375,
// "is_live":true,
// "is_cancelled":false,
// "is_hidden":false,
// "was_forced":false,
// "executed_amount":"0",
// "client_order_id":"1650398445709",
// "options":[],
// "price":"2000.00",
// "original_amount":"0.01",
// "remaining_amount":"0.01"
// }
// ]
//
let market = undefined;
if (symbol !== undefined) {
market = this.market(symbol); // throws on non-existent symbol
}
return this.parseOrders(response, market, since, limit);
}
/**
* @method
* @name gemini#createOrder
* @description create a trade order
* @see https://docs.gemini.com/rest-api/#new-order
* @param {string} symbol unified symbol of the market to create an order in
* @param {string} type must be 'limit'
* @param {string} side 'buy' or 'sell'
* @param {float} amount how much of currency you want to trade in units of base currency
* @param {float} [price] the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
*/
async createOrder(symbol, type, side, amount, price = undefined, params = {}) {
await this.loadMarkets();
if (type !== 'limit') {
throw new errors.ExchangeError(this.id + ' createOrder() allows limit orders only');
}
let clientOrderId = this.safeString2(params, 'clientOrderId', 'client_order_id');
params = this.omit(params, ['clientOrderId', 'client_order_id']);
if (clientOrderId === undefined) {
clientOrderId = this.milliseconds().toString();
}
const market = this.market(symbol);
const amountString = this.amountToPrecision(symbol, amount);
const priceString = this.priceToPrecision(symbol, price);
const request = {
'client_order_id': clientOrderId,
'symbol': market['id'],
'amount': amountString,
'price': priceString,
'side': side,
'type': 'exchange limit', // gemini allows limit orders only
// 'options': [], one of: maker-or-cancel, immediate-or-cancel, fill-or-kill, auction-only, indication-of-interest
};
type = this.safeString(params, 'type', type);
params = this.omit(params, 'type');
const triggerPrice = this.safeStringN(params, ['triggerPrice', 'stop_price', 'stopPrice']);
params = this.omit(params, ['triggerPrice', 'stop_price', 'stopPrice', 'type']);
if (type === 'stopLimit') {
throw new errors.ArgumentsRequired(this.id + ' createOrder() requires a triggerPrice parameter or a stop_price parameter for ' + type + ' orders');
}
if (triggerPrice !== undefined) {
request['stop_price'] = this.priceToPrecision(symbol, triggerPrice);
request['type'] = 'exchange stop limit';
}
else {
// No options can be applied to stop-limit orders at this time.
const timeInForce = this.safeString(params, 'timeInForce');
params = this.omit(params, 'timeInForce');
if (timeInForce !== undefined) {
if ((timeInForce === 'IOC') || (timeInForce === 'immediate-or-cancel')) {
request['options'] = ['immediate-or-cancel'];
}
else if ((timeInForce === 'FOK') || (timeInForce === 'fill-or-kill')) {
request['options'] = ['fill-or-kill'];
}
else if (timeInForce === 'PO') {
request['options'] = ['maker-or-cancel'];
}
}
const postOnly = this.safeBool(params, 'postOnly', false);
params = this.omit(params, 'postOnly');
if (postOnly) {
request['options'] = ['maker-or-cancel'];
}
// allowing override for auction-only and indication-of-interest order options
const options = this.safeString(params, 'options');
if (options !== undefined) {
request['options'] = [options];
}
}
const response = await this.privatePostV1OrderNew(this.extend(request, params));
//
// {
// "order_id":"106027397702",
// "id":"106027397702",
// "symbol":"etheur",
// "exchange":"gemini",
// "avg_execution_price":"2877.48",
// "side":"sell",
// "type":"exchange limit",
// "timestamp":"1650398122",
// "timestampms":1650398122308,
// "is_live":false,
// "is_cancelled":false,
// "is_hidden":false,
// "was_forced":false,
// "executed_amount":"0.014434",
// "client_order_id":"1650398121695",
// "options":[],
// "price":"2800.00",
// "original_amount":"0.014434",
// "remaining_amount":"0"
// }
//
return this.parseOrder(response);
}
/**
* @method
* @name gemini#cancelOrder
* @description cancels an open order
* @see https://docs.gemini.com/rest-api/#cancel-order
* @param {string} id order id
* @param {string} symbol unified symbol of the market the order was made in
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
*/
async cancelOrder(id, symbol = undefined, params = {}) {
await this.loadMarkets();
const request = {
'order_id': id,
};
const response = await this.privatePostV1OrderCancel(this.extend(request, params));
//
// {
// "order_id":"106028543717",
// "id":"106028543717",
// "symbol":"etheur",
// "exchange":"gemini",
// "avg_execution_price":"0.00",
// "side":"buy",
// "type":"exchange limit",
// "timestamp":"1650398446",
// "timestampms":1650398446375,
// "is_live":false,
// "is_cancelled":true,
// "is_hidden":false,
// "was_forced":false,
// "executed_amount":"0",
// "client_order_id":"1650398445709",
// "reason":"Requested",
// "options":[],
// "price":"2000.00",
// "original_amount":"0.01",
// "remaining_amount":"0.01"
// }
//
return this.parseOrder(response);
}
/**
* @method
* @name gemini#fetchMyTrades
* @description fetch all trades made by the user
* @see https://docs.gemini.com/rest-api/#get-past-trades
* @param {string} symbol unified market symbol
* @param {int} [since] the earliest time in ms to fetch trades for
* @param {int} [limit] the maximum number of trades structures to retrieve
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
*/
async fetchMyTrades(symbol = undefined, since = undefined, limit = undefined, params = {}) {
if (symbol === undefined) {
throw new errors.ArgumentsRequired(this.id + ' fetchMyTrades() requires a symbol argument');
}
await this.loadMarkets();
const market = this.market(symbol);
const request = {
'symbol': market['id'],
};
if (limit !== undefined) {
request['limit_trades'] = limit;
}
if (since !== undefined) {
request['timestamp'] = this.parseToInt(since / 1000);
}
const response = await this.privatePostV1Mytrades(this.extend(request, params));
return this.parseTrades(response, market, since, limit);
}
/**
* @method
* @name gemini#withdraw
* @description make a withdrawal
* @see https://docs.gemini.com/rest-api/#withdraw-crypto-funds
* @param {string} code unified currency code
* @param {float} amount the amount to withdraw
* @param {string} address the address to withdraw to
* @param {string} tag
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @returns {object} a [transaction structure]{@link https://docs.ccxt.com/#/?id=transaction-structure}
*/
async withdraw(code, amount, address, tag = undefined, params = {}) {
[tag, params] = this.handleWithdrawTagAndParams(tag, params);
this.checkAddress(address);
await this.loadMarkets();
const currency = this.currency(code);
const request = {
'currency': currency['id'],
'amount': amount,
'address': address,
};
const response = await this.privatePostV1WithdrawCurrency(this.extend(request, params));
//
// for BTC
// {
// "address":"mi98Z9brJ3TgaKsmvXatuRahbFRUFKRUdR",
// "amount":"1",
// "withdrawalId":"02176a83-a6b1-4202-9b85-1c1c92dd25c4",
// "message":"You have requested a transfer of 1 BTC to mi98Z9brJ3TgaKsmvXatuRahbFRUFKRUdR. This withdrawal will be sent to the blockchain within the next 60 seconds."
// }
//
// for ETH
// {
// "address":"0xA63123350Acc8F5ee1b1fBd1A6717135e82dBd28",
// "amount":"2.34567",
// "txHash":"0x28267179f92926d85c5516bqc063b2631935573d8915258e95d9572eedcc8cc"
// }
//
// for error (other variations of error messages are also expected)
// {
// "result":"error",
// "reason":"CryptoAddressWhitelistsNotEnabled",
// "message":"Cryptocurrency withdrawal address whitelists are not enabled for account 24. Please contact support@gemini.com for information on setting up a withdrawal address whitelist."
// }
//
const result = this.safeString(response, 'result');
if (result === 'error') {
throw new errors.ExchangeError(this.id + ' withdraw() failed: ' + this.json(response));
}
return this.parseTransaction(response, currency);
}
nonce() {
const nonceMethod = this.safeString(this.options, 'nonce', 'milliseconds');
if (nonceMethod === 'milliseconds') {
return this.milliseconds();
}
return this.seconds();
}
/**
* @method
* @name gemini#fetchDepositsWithdrawals
* @description fetch history of deposits and withdrawals
* @see https://docs.gemini.com/rest-api/#transfers
* @param {string} [code] unified currency code for the currency of the deposit/withdrawals, default is undefined
* @param {int} [since] timestamp in ms of the earliest deposit/withdrawal, default is undefined
* @param {int} [limit] max number of deposit/withdrawals to return, default is undefined
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @returns {object} a list of [transaction structure]{@link https://docs.ccxt.com/#/?id=transaction-structure}
*/
async fetchDepositsWithdrawals(code = undefined, since = undefined, limit = undefined, params = {}) {
await this.loadMarkets();
const request = {};
if (limit !== undefined) {
request['limit_transfers'] = limit;
}
if (since !== undefined) {
request['timestamp'] = since;
}
const response = await this.privatePostV1Transfers(this.extend(request, params));
return this.parseTransactions(response);
}
parseTransaction(transaction, currency = undefined) {
//
// withdraw
//
// for BTC
// {
// "address":"mi98Z9brJ3TgaKsmvXatuRahbFRUFKRUdR",
// "amount":"1",
// "withdrawalId":"02176a83-a6b1-4202-9b85-1c1c92dd25c4",
// "message":"You have requested a transfer of 1 BTC to mi98Z9brJ3TgaKsmvXatuRahbFRUFKRUdR. This withdrawal will be sent to the blockchain within the next 60 seconds."
// }
//
// for ETH
// {
// "address":"0xA63123350Acc8F5ee1b1fBd1A6717135e82dBd28",
// "amount":"2.34567",
// "txHash":"0x28267179f92926d85c5516bqc063b2631935573d8915258e95d9572eedcc8cc"
// }
//
const timestamp = this.safeInteger(transaction, 'timestampms');
const currencyId = this.safeString(transaction, 'currency');
const code = this.safeCurrencyCode(currencyId, currency);
const address = this.safeString(transaction, 'destination');
const type = this.safeStringLower(transaction, 'type');
// if status field is available, then it's complete
const statusRaw = this.safeString(transaction, 'status');
let fee = undefined;
const feeAmount = this.safeNumber(transaction, 'feeAmount');
if (feeAmount !== undefined) {
fee = {
'cost': feeAmount,
'currency': code,
};
}
return {
'info': transaction,
'id': this.safeString2(transaction, 'eid', 'withdrawalId'),
'txid': this.safeString(transaction, 'txHash'),
'timestamp': timestamp,
'datetime': this.iso8601(timestamp),
'network': undefined,
'address': address,
'addressTo': undefined,
'addressFrom': undefined,
'tag': undefined,
'tagTo': undefined,
'tagFrom': undefined,
'type': type,
'amount': this.safeNumber(transaction, 'amount'),
'currency': code,
'status': this.parseTransactionStatus(statusRaw),
'updated': undefined,
'internal': undefined,
'comment': this.safeString(transaction, 'message'),
'fee': fee,
};
}
parseTransactionStatus(status) {
const statuses = {
'Advanced': 'ok',
'Complete': 'ok',
};
return this.safeString(statuses, status, status);
}
parseDepositAddress(depositAddress, currency = undefined) {
//
// {
// "address": "0xed6494Fe7c1E56d1bd6136e89268C51E32d9708B",
// "timestamp": "1636813923098",
// "addressVersion": "eV1" }
// }
//
const address = this.safeString(depositAddress, 'address');
const code = this.safeCurrencyCode(undefined, currency);
return {
'currency': code,
'network': undefined,
'address': address,
'tag': undefined,
'info': depositAddress,
};
}
/**
* @method
* @name gemini#fetchDepositAddress
* @see https://docs.gemini.com/rest-api/#get-deposit-addresses
* @description fetch the deposit address for a currency associated with this account
* @param {string} code unified currency code
* @param {object} [params] extra parameters specific to the endpoint
* @param {string} [params.network] *required* The chain of currency
* @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
*/
async fetchDepositAddress(code, params = {}) {
await this.loadMarkets();
const groupedByNetwork = await this.fetchDepositAddressesByNetwork(code, params);
let networkCode = undefined;
[networkCode, params] = this.handleNetworkCodeAndParams(params);
const networkGroup = this.indexBy(this.safeValue(groupedByNetwork, networkCode), 'currency');
return this.safeValue(networkGroup, code);
}
/**
* @method
* @name gemini#fetchDepositAddressesByNetwork
* @description fetch a dictionary of addresses for a currency, indexed by network
* @see https://docs.gemini.com/rest-api/#get-deposit-addresses
* @param {string} code unified currency code of the currency for the deposit address
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @param {string} [params.network] *required* The chain of currency
* @returns {object} a dictionary of [address structures]{@link https://docs.ccxt.com/#/?id=address-structure} indexed by the network
*/
async fetchDepositAddressesByNetwork(code, params = {}) {
await this.loadMarkets();
const currency = this.currency(code);
code = currency['code'];
let networkCode = undefined;
[networkCode, params] = this.handleNetworkCodeAndParams(params);
if (networkCode === undefined) {
throw new errors.ArgumentsRequired(this.id + ' fetchDepositAddresses() requires a network parameter');
}
const networkId = this.networkCodeToId(networkCode);
const request = {
'network': networkId,
};
const response = await this.privatePostV1AddressesNetwork(this.extend(request, params));
const results = this.parseDepositAddresses(response, [code], false, { 'network': networkCode, 'currency': code });
return this.groupBy(results, 'network');
}
sign(path, api = 'public', method = 'GET', params = {}, headers = undefined, body = undefined) {
let url = '/' + this.implodeParams(path, params);
const query = this.omit(params, this.extractParams(path));
if (api === 'private') {
this.checkRequiredCredentials();
const apiKey = this.apiKey;
if (apiKey.indexOf('account') < 0) {
throw new errors.AuthenticationError(this.id + ' sign() requires an account-key, master-keys are not-supported');
}
const nonce = this.nonce().toString();
const request = this.extend({
'request': url,
'nonce': nonce,
}, query);
let payload = this.json(request);
payload = this.stringToBase64(payload);
const signature = this.hmac(this.encode(payload), this.encode(this.secret), sha512.sha384);
headers = {
'Content-Type': 'text/plain',
'X-GEMINI-APIKEY': this.apiKey,
'X-GEMINI-PAYLOAD': payload,
'X-GEMINI-SIGNATURE': signature,
};
}
else {
if (Object.keys(query).length) {
url += '?' + this.urlencode(query);
}
}
url = this.urls['api'][api] + url;
if ((method === 'POST') || (method === 'DELETE')) {
body = this.json(query);
}
return { 'url': url, 'method': method, 'body': body, 'headers': headers };
}
handleErrors(httpCode, reason, url, method, headers, body, response, requestHeaders, requestBody) {
if (response === undefined) {
if (typeof body === 'string') {
const feedback = this.id + ' ' + body;
this.throwBroadlyMatchedException(this.exceptions['broad'], body, feedback);
}
return undefined; // fallback to default error handler
}
//
// {
// "result": "error",
// "reason": "BadNonce",
// "message": "Out-of-sequence nonce <1234> precedes previously used nonce <2345>"
// }
//
const result = this.safeString(response, 'result');
if (result === 'error') {
const reasonInner = this.safeString(response, 'reason');
const message = this.safeString(response, 'message');
const feedback = this.id + ' ' + message;
this.throwExactlyMatchedException(this.exceptions['exact'], reasonInner, feedback);
this.throwExactlyMatchedException(this.exceptions['exact'], message, feedback);
this.throwBroadlyMatchedException(this.exceptions['broad'], message, feedback);
throw new errors.ExchangeError(feedback); // unknown message
}
return undefined;
}
/**
* @method
* @name gemini#createDepositAddress
* @description create a currency deposit address
* @see https://docs.gemini.com/rest-api/#new-deposit-address
* @param {string} code unified currency code of the currency for the deposit address
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
*/
async createDepositAddress(code, params = {}) {
await this.loadMarkets();
const currency = this.currency(code);
const request = {
'currency': currency['id'],
};
const response = await this.privatePostV1DepositCurrencyNewAddress(this.extend(request, params));
const address = this.safeString(response, 'address');
this.checkAddress(address);
return {
'currency': code,
'address': address,
'tag': undefined,
'network': undefined,
'info': response,
};
}
/**
* @method
* @name gemini#fetchOHLCV
* @description fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
* @see https://docs.gemini.com/rest-api/#candles
* @param {string} symbol unified symbol of the market to fetch OHLCV data for
* @param {string} timeframe the length of time each candle represents
* @param {int} [since] timestamp in ms of the earliest candle to fetch
* @param {int} [limit] the maximum amount of candles to fetch
* @param {object} [params] extra parameters specific to the exchange API endpoint
* @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
*/
async fetchOHLCV(symbol, timeframe = '1m', since = undefined, limit = undefined, params = {}) {
await this.loadMarkets();
const market = this.market(symbol);
const timeframeId = this.safeString(this.timeframes, timeframe, timeframe);
const request = {
'timeframe': timeframeId,
'symbol': market['id'],
};
const response = await this.publicGetV2CandlesSymbolTimeframe(this.extend(request, params));
//
// [
// [1591515000000,0.02509,0.02509,0.02509,0.02509,0],
// [1591514700000,0.02503,0.02509,0.02503,0.02509,44.6405],
// [1591514400000,0.02503,0.02503,0.02503,0.02503,0],
// ]
//
return this.parseOHLCVs(response, market, timeframe, since, limit);
}
}
module.exports = gemini;