19 KiB
novadax{docsify-ignore}
Kind: global class
Extends: Exchange
- fetchTime
- fetchMarkets
- fetchTicker
- fetchTickers
- fetchOrderBook
- fetchTrades
- fetchOHLCV
- fetchBalance
- createOrder
- cancelOrder
- fetchOrder
- fetchOrders
- fetchOpenOrders
- fetchClosedOrders
- fetchOrderTrades
- transfer
- withdraw
- fetchAccounts
- fetchDeposits
- fetchWithdrawals
- fetchDepositsWithdrawals
- fetchMyTrades
fetchTime{docsify-ignore}
fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of novadax
Returns: int - the current integer timestamp in milliseconds from the exchange server
See: https://doc.novadax.com/en-US/#get-current-system-time
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
novadax.fetchTime ([params])
fetchMarkets{docsify-ignore}
retrieves data on all markets for novadax
Kind: instance method of novadax
Returns: Array<object> - an array of objects representing market data
See: https://doc.novadax.com/en-US/#get-all-supported-trading-symbol
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
novadax.fetchMarkets ([params])
fetchTicker{docsify-ignore}
fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of novadax
Returns: object - a ticker structure
See: https://doc.novadax.com/en-US/#get-latest-ticker-for-specific-pair
| 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 |
novadax.fetchTicker (symbol[, params])
fetchTickers{docsify-ignore}
fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
Kind: instance method of novadax
Returns: object - a dictionary of ticker structures
See: https://doc.novadax.com/en-US/#get-latest-tickers-for-all-trading-pairs
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string>, undefined |
Yes | unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
No | extra parameters specific to the exchange API endpoint |
novadax.fetchTickers (symbols[, params])
fetchOrderBook{docsify-ignore}
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of novadax
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://doc.novadax.com/en-US/#get-market-depth
| 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 |
novadax.fetchOrderBook (symbol[, limit, params])
fetchTrades{docsify-ignore}
get the list of most recent trades for a particular symbol
Kind: instance method of novadax
Returns: Array<Trade> - a list of trade structures
See: https://doc.novadax.com/en-US/#get-recent-trades
| 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 |
novadax.fetchTrades (symbol[, since, limit, params])
fetchOHLCV{docsify-ignore}
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of novadax
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://doc.novadax.com/en-US/#get-kline-data
| 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 |
novadax.fetchOHLCV (symbol, timeframe[, since, limit, params])
fetchBalance{docsify-ignore}
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of novadax
Returns: object - a balance structure
See: https://doc.novadax.com/en-US/#get-account-balance
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
novadax.fetchBalance ([params])
createOrder{docsify-ignore}
create a trade order
Kind: instance method of novadax
Returns: object - an order structure
See: https://doc.novadax.com/en-US/#order-introduction
| 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 you want to trade in units of the 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.cost | float |
No | for spot market buy orders, the quote quantity that can be used as an alternative for the amount |
novadax.createOrder (symbol, type, side, amount[, price, params])
cancelOrder{docsify-ignore}
cancels an open order
Kind: instance method of novadax
Returns: object - An order structure
See: https://doc.novadax.com/en-US/#cancel-an-order
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | order id |
| symbol | string |
Yes | not used by novadax cancelOrder () |
| params | object |
No | extra parameters specific to the exchange API endpoint |
novadax.cancelOrder (id, symbol[, params])
fetchOrder{docsify-ignore}
fetches information on an order made by the user
Kind: instance method of novadax
Returns: object - An order structure
See: https://doc.novadax.com/en-US/#get-order-details
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | order id |
| symbol | string |
Yes | not used by novadax fetchOrder |
| params | object |
No | extra parameters specific to the exchange API endpoint |
novadax.fetchOrder (id, symbol[, params])
fetchOrders{docsify-ignore}
fetches information on multiple orders made by the user
Kind: instance method of novadax
Returns: Array<Order> - a list of order structures
See: https://doc.novadax.com/en-US/#get-order-history
| 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 |
novadax.fetchOrders (symbol[, since, limit, params])
fetchOpenOrders{docsify-ignore}
fetch all unfilled currently open orders
Kind: instance method of novadax
Returns: Array<Order> - a list of order structures
See: https://doc.novadax.com/en-US/#get-order-history
| 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 |
novadax.fetchOpenOrders (symbol[, since, limit, params])
fetchClosedOrders{docsify-ignore}
fetches information on multiple closed orders made by the user
Kind: instance method of novadax
Returns: Array<Order> - a list of order structures
See: https://doc.novadax.com/en-US/#get-order-history
| 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 |
novadax.fetchClosedOrders (symbol[, since, limit, params])
fetchOrderTrades{docsify-ignore}
fetch all the trades made from a single order
Kind: instance method of novadax
Returns: Array<object> - a list of trade structures
See: https://doc.novadax.com/en-US/#get-order-match-details
| 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 |
novadax.fetchOrderTrades (id, symbol[, since, limit, params])
transfer{docsify-ignore}
transfer currency internally between wallets on the same account
Kind: instance method of novadax
Returns: object - a transfer structure
See: https://doc.novadax.com/en-US/#get-sub-account-transfer
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| amount | float |
Yes | amount to transfer |
| fromAccount | string |
Yes | account to transfer from |
| toAccount | string |
Yes | account to transfer to |
| params | object |
No | extra parameters specific to the exchange API endpoint |
novadax.transfer (code, amount, fromAccount, toAccount[, params])
withdraw{docsify-ignore}
make a withdrawal
Kind: instance method of novadax
Returns: object - a transaction structure
See: https://doc.novadax.com/en-US/#send-cryptocurrencies
| 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 |
novadax.withdraw (code, amount, address, tag[, params])
fetchAccounts{docsify-ignore}
fetch all the accounts associated with a profile
Kind: instance method of novadax
Returns: object - a dictionary of account structures indexed by the account type
See: https://doc.novadax.com/en-US/#get-sub-account-list
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
novadax.fetchAccounts ([params])
fetchDeposits{docsify-ignore}
fetch all deposits made to an account
Kind: instance method of novadax
Returns: Array<object> - a list of transaction structures
See: https://doc.novadax.com/en-US/#wallet-records-of-deposits-and-withdraws
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| since | int |
No | the earliest time in ms to fetch deposits for |
| limit | int |
No | the maximum number of deposits structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
novadax.fetchDeposits (code[, since, limit, params])
fetchWithdrawals{docsify-ignore}
fetch all withdrawals made from an account
Kind: instance method of novadax
Returns: Array<object> - a list of transaction structures
See: https://doc.novadax.com/en-US/#wallet-records-of-deposits-and-withdraws
| 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 |
novadax.fetchWithdrawals (code[, since, limit, params])
fetchDepositsWithdrawals{docsify-ignore}
fetch history of deposits and withdrawals
Kind: instance method of novadax
Returns: object - a list of transaction structure
See: https://doc.novadax.com/en-US/#wallet-records-of-deposits-and-withdraws
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
No | unified currency code for the currency of the deposit/withdrawals, default is undefined |
| since | int |
No | timestamp in ms of the earliest deposit/withdrawal, default is undefined |
| limit | int |
No | max number of deposit/withdrawals to return, default is undefined |
| params | object |
No | extra parameters specific to the exchange API endpoint |
novadax.fetchDepositsWithdrawals ([code, since, limit, params])
fetchMyTrades{docsify-ignore}
fetch all trades made by the user
Kind: instance method of novadax
Returns: Array<Trade> - a list of trade structures
See: https://doc.novadax.com/en-US/#get-order-history
| 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 |
novadax.fetchMyTrades (symbol[, since, limit, params])