ndax
ndax cryptocurrency exchange — CCXT unified API: methods, parameters and endpoints.
ndax
Kind: global class
Extends: Exchange
- signIn
- fetchCurrencies
- fetchMarkets
- fetchOrderBook
- fetchTicker
- fetchOHLCV
- fetchTrades
- fetchAccounts
- fetchBalance
- fetchLedger
- createOrder
- fetchMyTrades
- cancelAllOrders
- cancelOrder
- fetchOpenOrders
- fetchOrders
- fetchOrder
- fetchOrderTrades
- fetchDepositAddress
- createDepositAddress
- fetchDeposits
- fetchWithdrawals
- withdraw
- watchTicker
- watchTrades
- watchOHLCV
- watchOrderBook
signIn
sign in, must be called prior to using other authenticated methods
Kind: instance method of ndax
Returns: response from exchange
See: https://apidoc.ndax.io/#authenticate2fa
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.signIn (params?)fetchCurrencies
fetches all available currencies on an exchange
Kind: instance method of ndax
Returns: object - an associative dictionary of currencies
See: https://apidoc.ndax.io/#getproduct
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.fetchCurrencies (params?)fetchMarkets
retrieves data on all markets for ndax
Kind: instance method of ndax
Returns: Array<object> - an array of objects representing market data
See: https://apidoc.ndax.io/#getinstruments
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.fetchMarkets (params?)fetchOrderBook
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of ndax
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://apidoc.ndax.io/#getl2snapshot
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch the order book for |
| limit | int | No | the maximum amount of order book entries to return |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.fetchOrderBook (symbol, limit?, params?)fetchTicker
fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of ndax
Returns: object - a ticker structure
See: https://apidoc.ndax.io/#getlevel1
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch the ticker for |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.fetchTicker (symbol, params?)fetchOHLCV
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of ndax
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://apidoc.ndax.io/#gettickerhistory
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | string | Yes | the length of time each candle represents |
| since | int | No | timestamp in ms of the earliest candle to fetch |
| limit | int | No | the maximum amount of candles to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.fetchOHLCV (symbol, timeframe, since?, limit?, params?)fetchTrades
get the list of most recent trades for a particular symbol
Kind: instance method of ndax
Returns: Array<Trade> - a list of trade structures
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch trades for |
| since | int | No | timestamp in ms of the earliest trade to fetch |
| limit | int | No | the maximum amount of trades to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.fetchTrades (symbol, since?, limit?, params?)fetchAccounts
fetch all the accounts associated with a profile
Kind: instance method of ndax
Returns: object - a dictionary of account structures indexed by the account type
See: https://apidoc.ndax.io/#getuseraccounts
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.fetchAccounts (params?)fetchBalance
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of ndax
Returns: object - a balance structure
See: https://apidoc.ndax.io/#getaccountpositions
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.fetchBalance (params?)fetchLedger
fetch the history of changes, actions done by the user or operations that altered the balance of the user
Kind: instance method of ndax
Returns: object - a ledger structure
See: https://apidoc.ndax.io/#getaccounttransactions
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | No | unified currency code, default is undefined |
| since | int | No | timestamp in ms of the earliest ledger entry, default is undefined |
| limit | int | No | max number of ledger entries to return, default is undefined |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.fetchLedger (code?, since?, limit?, params?)createOrder
create a trade order
Kind: instance method of ndax
Returns: object - an order structure
See: https://apidoc.ndax.io/#sendorder
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to create an order in |
| type | string | Yes | 'market' or 'limit' |
| side | string | Yes | 'buy' or 'sell' |
| amount | float | Yes | how much of currency you want to trade in units of base currency |
| price | float | No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.triggerPrice | float | No | the price at which a trigger order would be triggered |
| params.clientOrderId | string | No | a unique id for the order |
ndax.createOrder (symbol, type, side, amount, price?, params?)fetchMyTrades
fetch all trades made by the user
Kind: instance method of ndax
Returns: Array<Trade> - a list of trade structures
See: https://apidoc.ndax.io/#gettradeshistory
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| since | int | No | the earliest time in ms to fetch trades for |
| limit | int | No | the maximum number of trades structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.fetchMyTrades (symbol, since?, limit?, params?)cancelAllOrders
cancel all open orders
Kind: instance method of ndax
Returns: Array<object> - a list of order structures
See: https://apidoc.ndax.io/#cancelallorders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.cancelAllOrders (symbol, params?)cancelOrder
cancels an open order
Kind: instance method of ndax
Returns: object - An order structure
See: https://apidoc.ndax.io/#cancelorder
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | order id |
| symbol | string | Yes | unified symbol of the market the order was made in |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.clientOrderId | string | No | a unique id for the order |
ndax.cancelOrder (id, symbol, params?)fetchOpenOrders
fetch all unfilled currently open orders
Kind: instance method of ndax
Returns: Array<Order> - a list of order structures
See: https://apidoc.ndax.io/#getopenorders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| since | int | No | the earliest time in ms to fetch open orders for |
| limit | int | No | the maximum number of open orders structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.fetchOpenOrders (symbol, since?, limit?, params?)fetchOrders
fetches information on multiple orders made by the user
Kind: instance method of ndax
Returns: Array<Order> - a list of order structures
See: https://apidoc.ndax.io/#getorderhistory
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol of the market orders were made in |
| since | int | No | the earliest time in ms to fetch orders for |
| limit | int | No | the maximum number of order structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.fetchOrders (symbol, since?, limit?, params?)fetchOrder
fetches information on an order made by the user
Kind: instance method of ndax
Returns: object - An order structure
See: https://apidoc.ndax.io/#getorderstatus
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | order id |
| symbol | string | Yes | unified symbol of the market the order was made in |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.fetchOrder (id, symbol, params?)fetchOrderTrades
fetch all the trades made from a single order
Kind: instance method of ndax
Returns: Array<object> - a list of trade structures
See: https://apidoc.ndax.io/#getorderhistorybyorderid
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | order id |
| symbol | string | Yes | unified market symbol |
| since | int | No | the earliest time in ms to fetch trades for |
| limit | int | No | the maximum number of trades to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.fetchOrderTrades (id, symbol, since?, limit?, params?)fetchDepositAddress
fetch the deposit address for a currency associated with this account
Kind: instance method of ndax
Returns: object - an address structure
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency code |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.fetchDepositAddress (code, params?)createDepositAddress
create a currency deposit address
Kind: instance method of ndax
Returns: object - an address structure
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency code of the currency for the deposit address |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.createDepositAddress (code, params?)fetchDeposits
fetch all deposits made to an account
Kind: instance method of ndax
Returns: Array<object> - a list of transaction structures
See: https://apidoc.ndax.io/#getdeposits
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency code |
| since | int | No | not used by ndax fetchDeposits |
| limit | int | No | the maximum number of deposits structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.fetchDeposits (code, since?, limit?, params?)fetchWithdrawals
fetch all withdrawals made from an account
Kind: instance method of ndax
Returns: Array<object> - a list of transaction structures
See: https://apidoc.ndax.io/#getwithdraws
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency code |
| since | int | No | the earliest time in ms to fetch withdrawals for |
| limit | int | No | the maximum number of withdrawals structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.fetchWithdrawals (code, since?, limit?, params?)withdraw
make a withdrawal
Kind: instance method of ndax
Returns: object - a transaction structure
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency code |
| amount | float | Yes | the amount to withdraw |
| address | string | Yes | the address to withdraw to |
| tag | string | Yes | |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.withdraw (code, amount, address, tag, params?)watchTicker
watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of ndax
Returns: object - a ticker structure
See: https://apidoc.ndax.io/#subscribelevel1
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch the ticker for |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.watchTicker (symbol, params?)watchTrades
get the list of most recent trades for a particular symbol
Kind: instance method of ndax
Returns: Array<object> - a list of trade structures
See: https://apidoc.ndax.io/#subscribetrades
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch trades for |
| since | int | No | timestamp in ms of the earliest trade to fetch |
| limit | int | No | the maximum amount of trades to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.watchTrades (symbol, since?, limit?, params?)watchOHLCV
watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of ndax
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://apidoc.ndax.io/#subscribeticker
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | string | Yes | the length of time each candle represents |
| since | int | No | timestamp in ms of the earliest candle to fetch |
| limit | int | No | the maximum amount of candles to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.watchOHLCV (symbol, timeframe, since?, limit?, params?)watchOrderBook
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of ndax
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://apidoc.ndax.io/#subscribelevel2
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch the order book for |
| limit | int | No | the maximum amount of order book entries to return |
| params | object | No | extra parameters specific to the exchange API endpoint |
ndax.watchOrderBook (symbol, limit?, params?)