ccxt 4.2.46 → 4.2.48

package/js/src/idex.js

@@ -84,8 +84,10 @@ export default class idex extends Exchange {
                 'fetchPositions': false,
                 'fetchPositionsRisk': false,
                 'fetchPremiumIndexOHLCV': false,
+                'fetchStatus': true,
                 'fetchTicker': true,
                 'fetchTickers': true,
+                'fetchTime': true,
                 'fetchTrades': true,
                 'fetchTradingFee': false,
                 'fetchTradingFees': true,
@@ -199,6 +201,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#fetchMarkets
          * @description retrieves data on all markets for idex
+         * @see https://api-docs-v3.idex.io/#get-markets
          * @param {object} [params] extra parameters specific to the exchange API endpoint
          * @returns {object[]} an array of objects representing market data
          */
@@ -329,6 +332,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#fetchTicker
          * @description fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
+         * @see https://api-docs-v3.idex.io/#get-tickers
          * @param {string} symbol unified symbol of the market to fetch the ticker for
          * @param {object} [params] extra parameters specific to the exchange API endpoint
          * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
@@ -365,6 +369,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#fetchTickers
          * @description fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
+         * @see https://api-docs-v3.idex.io/#get-tickers
          * @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}
@@ -441,6 +446,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#fetchOHLCV
          * @description fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
+         * @see https://api-docs-v3.idex.io/#get-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
@@ -503,6 +509,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#fetchTrades
          * @description get the list of most recent trades for a particular symbol
+         * @see https://api-docs-v3.idex.io/#get-trades
          * @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
@@ -616,6 +623,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#fetchTradingFees
          * @description fetch the trading fees for multiple markets
+         * @see https://api-docs-v3.idex.io/#get-api-account
          * @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
          */
@@ -661,6 +669,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#fetchOrderBook
          * @description fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
+         * @see https://api-docs-v3.idex.io/#get-order-books
          * @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
@@ -724,6 +733,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#fetchCurrencies
          * @description fetches all available currencies on an exchange
+         * @see https://api-docs-v3.idex.io/#get-assets
          * @param {object} [params] extra parameters specific to the exchange API endpoint
          * @returns {object} an associative dictionary of currencies
          */
@@ -789,6 +799,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#fetchBalance
          * @description query for balance and get the amount of funds available for trading or funds locked in orders
+         * @see https://api-docs-v3.idex.io/#get-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}
          */
@@ -833,6 +844,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#fetchMyTrades
          * @description fetch all trades made by the user
+         * @see https://api-docs-v3.idex.io/#get-fills
          * @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
@@ -901,6 +913,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#fetchOrder
          * @description fetches information on an order made by the user
+         * @see https://api-docs-v3.idex.io/#get-orders
          * @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}
@@ -915,6 +928,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#fetchOpenOrders
          * @description fetch all unfilled currently open orders
+         * @see https://api-docs-v3.idex.io/#get-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
@@ -931,6 +945,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#fetchClosedOrders
          * @description fetches information on multiple closed orders made by the user
+         * @see https://api-docs-v3.idex.io/#get-orders
          * @param {string} symbol unified market symbol of the market orders were made in
          * @param {int} [since] the earliest time in ms to fetch orders for
          * @param {int} [limit] the maximum number of order structures to retrieve
@@ -1142,16 +1157,20 @@ export default class idex extends Exchange {
          * @method
          * @name idex#createOrder
          * @description create a trade order, https://docs.idex.io/#create-order
+         * @see https://api-docs-v3.idex.io/#create-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 base currency
          * @param {float} [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 exchange API endpoint
+         * @param {bool} [params.test] set to true to test an order, no order will be created but the request will be validated
          * @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
          */
         this.checkRequiredCredentials();
         await this.loadMarkets();
+        const testOrder = this.safeBool(params, 'test', false);
+        params = this.omit(params, 'test');
         const market = this.market(symbol);
         const nonce = this.uuidv1();
         let typeEnum = undefined;
@@ -1332,7 +1351,13 @@ export default class idex extends Exchange {
         //   "avgExecutionPrice": "0.09905990"
         // }
         // we don't use extend here because it is a signed endpoint
-        const response = await this.privatePostOrders(request);
+        let response = undefined;
+        if (testOrder) {
+            response = await this.privatePostOrdersTest(request);
+        }
+        else {
+            response = await this.privatePostOrders(request);
+        }
         return this.parseOrder(response, market);
     }
     async withdraw(code, amount, address, tag = undefined, params = {}) {
@@ -1340,6 +1365,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#withdraw
          * @description make a withdrawal
+         * @see https://api-docs-v3.idex.io/#withdraw-funds
          * @param {string} code unified currency code
          * @param {float} amount the amount to withdraw
          * @param {string} address the address to withdraw to
@@ -1393,6 +1419,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#cancelAllOrders
          * @description cancel all open orders
+         * @see https://api-docs-v3.idex.io/#cancel-order
          * @param {string} symbol unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
          * @param {object} [params] extra parameters specific to the exchange API endpoint
          * @returns {object[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
@@ -1432,6 +1459,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#cancelOrder
          * @description cancels an open order
+         * @see https://api-docs-v3.idex.io/#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
@@ -1483,6 +1511,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#fetchDeposit
          * @description fetch information on a deposit
+         * @see https://api-docs-v3.idex.io/#get-deposits
          * @param {string} id deposit id
          * @param {string} code not used by idex fetchDeposit ()
          * @param {object} [params] extra parameters specific to the exchange API endpoint
@@ -1503,6 +1532,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#fetchDeposits
          * @description fetch all deposits made to an account
+         * @see https://api-docs-v3.idex.io/#get-deposits
          * @param {string} code unified currency code
          * @param {int} [since] the earliest time in ms to fetch deposits for
          * @param {int} [limit] the maximum number of deposits structures to retrieve
@@ -1514,11 +1544,30 @@ export default class idex extends Exchange {
         }, params);
         return await this.fetchTransactionsHelper(code, since, limit, params);
     }
+    async fetchStatus(params = {}) {
+        /**
+         * @method
+         * @name idex#fetchStatus
+         * @description the latest known information on the availability of the exchange API
+         * @see https://api-docs-v3.idex.io/#get-ping
+         * @param {object} [params] extra parameters specific to the exchange API endpoint
+         * @returns {object} a [status structure]{@link https://docs.ccxt.com/#/?id=exchange-status-structure}
+         */
+        const response = await this.publicGetPing(params);
+        return {
+            'status': 'ok',
+            'updated': undefined,
+            'eta': undefined,
+            'url': undefined,
+            'info': response,
+        };
+    }
     async fetchTime(params = {}) {
         /**
          * @method
          * @name idex#fetchTime
          * @description fetches the current integer timestamp in milliseconds from the exchange server
+         * @see https://api-docs-v3.idex.io/#get-time
          * @param {object} [params] extra parameters specific to the exchange API endpoint
          * @returns {int} the current integer timestamp in milliseconds from the exchange server
          */
@@ -1533,6 +1582,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#fetchWithdrawal
          * @description fetch data on a currency withdrawal via the withdrawal id
+         * @see https://api-docs-v3.idex.io/#get-withdrawals
          * @param {string} id withdrawal id
          * @param {string} code not used by idex.fetchWithdrawal
          * @param {object} [params] extra parameters specific to the exchange API endpoint
@@ -1553,6 +1603,7 @@ export default class idex extends Exchange {
          * @method
          * @name idex#fetchWithdrawals
          * @description fetch all withdrawals made from an account
+         * @see https://api-docs-v3.idex.io/#get-withdrawals
          * @param {string} code unified currency code
          * @param {int} [since] the earliest time in ms to fetch withdrawals for
          * @param {int} [limit] the maximum number of withdrawals structures to retrieve

package/js/src/indodax.d.ts

@@ -1,5 +1,5 @@
 import Exchange from './abstract/indodax.js';
-import type { Balances, Currency, Int, Market, Order, OrderBook, OrderSide, OrderType, Str, Strings, Ticker, Tickers, Trade, Transaction } from './base/types.js';
+import type { Balances, Currency, Int, Market, OHLCV, Order, OrderBook, OrderSide, OrderType, Str, Strings, Ticker, Tickers, Trade, Transaction } from './base/types.js';
 /**
  * @class indodax
  * @augments Exchange
@@ -17,6 +17,8 @@ export default class indodax extends Exchange {
     fetchTickers(symbols?: Strings, params?: {}): Promise<Tickers>;
     parseTrade(trade: any, market?: Market): Trade;
     fetchTrades(symbol: string, since?: Int, limit?: Int, params?: {}): Promise<Trade[]>;
+    parseOHLCV(ohlcv: any, market?: Market): OHLCV;
+    fetchOHLCV(symbol: string, timeframe?: string, since?: Int, limit?: Int, params?: {}): Promise<OHLCV[]>;
     parseOrderStatus(status: any): string;
     parseOrder(order: any, market?: Market): Order;
     fetchOrder(id: string, symbol?: Str, params?: {}): Promise<Order>;
@@ -33,6 +35,9 @@ export default class indodax extends Exchange {
     withdraw(code: string, amount: number, address: any, tag?: any, params?: {}): Promise<Transaction>;
     parseTransaction(transaction: any, currency?: Currency): Transaction;
     parseTransactionStatus(status: any): string;
+    fetchDepositAddresses(codes?: string[], params?: {}): Promise<{
+        info: import("./base/types.js").Dictionary<any>;
+    }>;
     sign(path: any, api?: string, method?: string, params?: {}, headers?: any, body?: any): {
         url: any;
         method: string;