nado
nado cryptocurrency exchange — CCXT unified API: methods, parameters and endpoints.
🔌 Looking for raw exchange endpoints? See the nado implicit API — every endpoint in this exchange's API exposed as an implicit method.
nado
Kind: global class
Extends: Exchange
- createOrder
- editOrder
- cancelOrder
- cancelAllOrders
- cancelOrders
- fetchOrder
- fetchOrders
- fetchOpenOrders
- fetchClosedOrders
- fetchCanceledOrders
- fetchCanceledAndClosedOrders
- fetchMyTrades
- fetchBalance
- fetchDeposits
- fetchWithdrawals
- fetchPositions
- fetchTime
- fetchStatus
- fetchMarkets
- fetchCurrencies
- fetchTickers
- fetchTicker
- fetchFundingRate
- fetchFundingHistory
- fetchFundingRates
- fetchOpenInterest
- fetchOpenInterests
- fetchOrderBook
- fetchTrades
- fetchOHLCV
- watchTrades
- unWatchTrades
- watchTradesForSymbols
- unWatchTradesForSymbols
- watchOrderBook
- unWatchOrderBook
- watchOrderBookForSymbols
- unWatchOrderBookForSymbols
- watchOHLCV
- watchOHLCVForSymbols
- unWatchOHLCV
- unWatchOHLCVForSymbols
- watchTicker
- unWatchTicker
- watchTickers
- unWatchTickers
- watchBidsAsks
- unWatchBidsAsks
- watchOrders
- unWatchOrders
- watchMyTrades
- unWatchMyTrades
- watchPositions
- unWatchPositions
createOrder
create a trade order
Kind: instance method of nado
Returns: object - an order structure
See
- https://docs.nado.xyz/developer-resources/api/gateway/executes/place-order
- https://docs.nado.xyz/developer-resources/api/trigger/executes/place-order
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to create an order in |
| type | string | Yes | must be '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 |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.subaccount | string | No | the 12-byte subaccount identifier, defaults to 'default' |
| params.expiration | string, int | No | order expiration timestamp in seconds, defaults to 4294967295 |
| params.appendix | string, int | No | pre-encoded order appendix |
| params.reduceOnly | boolean | No | true if the order should only reduce position |
| params.postOnly | boolean | No | true to create a post-only order |
| params.timeInForce | string | No | 'GTC', 'IOC', 'FOK', or 'PO' |
| params.spotLeverage | boolean | No | whether leverage should be used for spot, defaults to true, exchange-specific alias params.spot_leverage |
| params.triggerPrice | float | No | swap only The price at which a trigger order is triggered at |
| params.stopLossPrice | float | No | swap only The price at which a stop loss order is triggered at |
| params.takeProfitPrice | float | No | swap only The price at which a take profit order is triggered at |
| params.triggerDirection | string | No | trigger direction, above, below |
| params.id | int | No | client-provided request id, returned by the exchange in the response |
nado.createOrder (symbol, type, side, amount, price?, params?)editOrder
edit a trade order
Kind: instance method of nado
Returns: object - an order structure
See: https://docs.nado.xyz/developer-resources/api/gateway/executes/cancel-and-place
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | order id |
| symbol | string | Yes | unified symbol of the market to edit an order in |
| type | string | Yes | must be '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 |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.subaccount | string | No | the 12-byte subaccount identifier, defaults to 'default' |
| params.expiration | string, int | No | order expiration timestamp in seconds, defaults to 4294967295 |
| params.appendix | string, int | No | pre-encoded order appendix |
| params.reduceOnly | boolean | No | true if the order should only reduce position |
| params.postOnly | boolean | No | true to create a post-only order |
| params.timeInForce | string | No | 'GTC', 'IOC', 'FOK', or 'PO' |
| params.spotLeverage | boolean | No | whether leverage should be used for spot, defaults to true, exchange-specific alias params.spot_leverage |
| params.placeRequiresUnfilled | boolean | No | when true, aborts the new order if the canceled order had partial fills or the cancel failed, exchange-specific alias params.place_requires_unfilled, defaults to true |
| params.id | int | No | client-provided request id, returned by the exchange in the response |
nado.editOrder (id, symbol, type, side, amount, price?, params?)cancelOrder
cancels an open order
Kind: instance method of nado
Returns: object - An order structure
See: https://docs.nado.xyz/developer-resources/api/gateway/executes/cancel-orders
| 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.subaccount | string | No | the 12-byte subaccount identifier, defaults to 'default' |
| params.requiredUnfilledAmount | string | No | cancel only if the order's absolute remaining unfilled amount matches this amount, exchange-specific raw x18 alias params.required_unfilled_amount |
| params.id | int | No | client-provided request id, returned by the exchange in the response |
nado.cancelOrder (id, symbol, params?)cancelAllOrders
cancel all open orders
Kind: instance method of nado
Returns: Array<object> - a list of order structures
See: https://docs.nado.xyz/developer-resources/api/gateway/executes/cancel-product-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | unified market symbol, when undefined all orders for all products are canceled |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.subaccount | string | No | the 12-byte subaccount identifier, defaults to 'default' |
| params.id | int | No | client-provided request id, returned by the exchange in the response |
| params.trigger | boolean | No | set to true if you would like to fetch portfolio margin account trigger or conditional orders |
nado.cancelAllOrders (symbol?, params?)cancelOrders
cancel multiple orders
Kind: instance method of nado
Returns: Array<object> - a list of order structures
See: https://docs.nado.xyz/developer-resources/api/gateway/executes/cancel-orders
| Param | Type | Required | Description |
|---|---|---|---|
| ids | Array<string> | Yes | order ids |
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.subaccount | string | No | the 12-byte subaccount identifier, defaults to 'default' |
| params.requiredUnfilledAmount | string | No | cancel only if the order's absolute remaining unfilled amount matches this amount, exchange-specific raw x18 alias params.required_unfilled_amount |
| params.id | int | No | client-provided request id, returned by the exchange in the response |
| params.trigger | boolean | No | set to true if you would like to fetch portfolio margin account trigger or conditional orders |
nado.cancelOrders (ids, symbol, params?)fetchOrder
fetches information on an order made by the user
Kind: instance method of nado
Returns: object - An order structure
See: https://docs.nado.xyz/developer-resources/api/gateway/queries/order
| 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 |
nado.fetchOrder (id, symbol, params?)fetchOrders
fetches information on multiple orders made by the user
Kind: instance method of nado
Returns: Array<Order> - a list of order structures
See
- https://docs.nado.xyz/developer-resources/api/archive-indexer/orders
- https://docs.nado.xyz/developer-resources/api/trigger/queries/list-trigger-orders
| 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 |
| params.trigger | boolean | No | set to true if you would like to fetch portfolio margin account trigger or conditional orders |
nado.fetchOrders (symbol, since?, limit?, params?)fetchOpenOrders
fetch all unfilled currently open orders
Kind: instance method of nado
Returns: Array<Order> - a list of order structures
See
- https://docs.nado.xyz/developer-resources/api/gateway/queries/orders
- https://docs.nado.xyz/developer-resources/api/trigger/queries/list-trigger-orders
| 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 order structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.subaccount | string | No | the 12-byte subaccount identifier, defaults to 'default' |
| params.trigger | boolean | No | whether the order is a trigger order |
nado.fetchOpenOrders (symbol, since?, limit?, params?)fetchClosedOrders
fetches information on multiple closed orders made by the user
Kind: instance method of nado
Returns: Array<Order> - a list of order structures
See
- https://docs.nado.xyz/developer-resources/api/archive-indexer/orders
- https://docs.nado.xyz/developer-resources/api/trigger/queries/list-trigger-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | unified market symbol of the market orders were made in |
| since | int | No | timestamp in ms of the earliest order |
| limit | int | No | the maximum number of orders structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.subaccount | string | No | the 12-byte subaccount identifier, defaults to 'default' |
| params.until | int | No | timestamp in ms of the latest order to fetch |
| params.trigger | boolean | No | whether the order is a trigger order |
nado.fetchClosedOrders (symbol?, since?, limit?, params?)fetchCanceledOrders
fetches information on multiple canceled orders made by the user
Kind: instance method of nado
Returns: Array<object> - a list of order structures
See: https://docs.nado.xyz/developer-resources/api/trigger/queries/list-trigger-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol of the market the 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 |
| params.trigger | boolean | No | set to true if you would like to fetch portfolio margin account trigger or conditional orders |
nado.fetchCanceledOrders (symbol, since?, limit?, params?)fetchCanceledAndClosedOrders
fetches information on multiple canceled orders made by the user
Kind: instance method of nado
Returns: Array<object> - a list of order structures
See: https://docs.nado.xyz/developer-resources/api/trigger/queries/list-trigger-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol of the market the 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 |
| params.trigger | boolean | No | set to true if you would like to fetch portfolio margin account trigger or conditional orders |
nado.fetchCanceledAndClosedOrders (symbol, since?, limit?, params?)fetchMyTrades
fetch all trades made by the user
Kind: instance method of nado
Returns: Array<Trade> - a list of trade structures
See: https://docs.nado.xyz/developer-resources/api/archive-indexer/matches
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | unified market symbol |
| since | int | No | timestamp in ms of the earliest trade |
| limit | int | No | the maximum number of trades to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.subaccount | string | No | the 12-byte subaccount identifier, defaults to 'default' |
| params.until | int | No | timestamp in ms of the latest trade to fetch |
nado.fetchMyTrades (symbol?, since?, limit?, params?)fetchBalance
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of nado
Returns: object - a balance structure
See: https://docs.nado.xyz/developer-resources/api/gateway/queries/subaccount-info
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.subaccount | string | No | the 12-byte subaccount identifier, defaults to 'default' |
nado.fetchBalance (params?)fetchDeposits
fetch all deposits made to an account
Kind: instance method of nado
Returns: Array<object> - a list of transaction structures
See: https://docs.nado.xyz/developer-resources/api/archive-indexer/events
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | No | 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 |
| params.subaccount | string | No | the 12-byte subaccount identifier, defaults to 'default' |
| params.until | int | No | timestamp in ms of the latest deposit to fetch |
nado.fetchDeposits (code?, since?, limit?, params?)fetchWithdrawals
fetch all withdrawals made from an account
Kind: instance method of nado
Returns: Array<object> - a list of transaction structures
See: https://docs.nado.xyz/developer-resources/api/archive-indexer/events
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | No | 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 |
| params.subaccount | string | No | the 12-byte subaccount identifier, defaults to 'default' |
| params.until | int | No | timestamp in ms of the latest withdrawal to fetch |
nado.fetchWithdrawals (code?, since?, limit?, params?)fetchPositions
fetch all open positions
Kind: instance method of nado
Returns: Array<Position> - a list of position structures
See: https://docs.nado.xyz/developer-resources/api/gateway/queries/subaccount-info
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | list of unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.subaccount | string | No | the 12-byte subaccount identifier, defaults to 'default' |
nado.fetchPositions (symbols?, params?)fetchTime
fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of nado
Returns: int - the current integer timestamp in milliseconds from the exchange server
See: https://docs.nado.xyz/developer-resources/api/gateway/edge#control-messages
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.fetchTime (params?)fetchStatus
the latest known information on the availability of the exchange API
Kind: instance method of nado
Returns: object - a status structure
See: https://docs.nado.xyz/developer-resources/api/gateway/queries/status
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.fetchStatus (params?)fetchMarkets
retrieves data on all markets for nado
Kind: instance method of nado
Returns: Array<object> - an array of objects representing market data
See
- https://docs.nado.xyz/developer-resources/api/gateway/queries/symbols
- https://docs.nado.xyz/developer-resources/api/v2/pairs
- https://docs.nado.xyz/developer-resources/api/v2/assets
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.fetchMarkets (params?)fetchCurrencies
fetches all available currencies on an exchange
Kind: instance method of nado
Returns: object - an associative dictionary of currencies
See: https://docs.nado.xyz/developer-resources/api/v2/assets
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.fetchCurrencies (params?)fetchTickers
fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
Kind: instance method of nado
Returns: object - a dictionary of ticker structures
See: https://docs.nado.xyz/developer-resources/api/v2/tickers
| 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 |
nado.fetchTickers (symbols, 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 nado
Returns: object - a ticker structure
See: https://docs.nado.xyz/developer-resources/api/v2/tickers
| 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 |
nado.fetchTicker (symbol, params?)fetchFundingRate
fetch the current funding rate
Kind: instance method of nado
Returns: object - a funding rate structure
See: https://docs.nado.xyz/developer-resources/api/v2/contracts
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.edge | boolean | No | whether to retrieve volume and open interest metrics for all chains, defaults to true |
nado.fetchFundingRate (symbol, params?)fetchFundingHistory
fetch the history of funding payments paid and received on this account
Kind: instance method of nado
Returns: Array<object> - a list of funding history structures
See: https://docs.nado.xyz/developer-resources/api/archive-indexer/interest-and-funding-payments
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| since | int | No | the earliest time in ms to fetch funding history for |
| limit | int | No | the maximum number of funding history structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.subaccount | string | No | the 12-byte subaccount identifier, defaults to 'default' |
nado.fetchFundingHistory (symbol, since?, limit?, params?)fetchFundingRates
fetch the funding rate for multiple markets
Kind: instance method of nado
Returns: object - a dictionary of funding rate structures, indexed by market symbols
See: https://docs.nado.xyz/developer-resources/api/v2/contracts
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | list of unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.edge | boolean | No | whether to retrieve volume and open interest metrics for all chains, defaults to true |
nado.fetchFundingRates (symbols?, params?)fetchOpenInterest
retrieves the open interest of a contract trading pair
Kind: instance method of nado
Returns: object - an open interest structure
See: https://docs.nado.xyz/developer-resources/api/v2/contracts
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified CCXT market symbol |
| params | object | No | exchange specific parameters |
| params.edge | boolean | No | whether to retrieve volume and open interest metrics for all chains, defaults to true |
nado.fetchOpenInterest (symbol, params?)fetchOpenInterests
retrieves the open interests of some currencies
Kind: instance method of nado
Returns: object - a dictionary of open interest structures
See: https://docs.nado.xyz/developer-resources/api/v2/contracts
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | unified CCXT market symbols |
| params | object | No | exchange specific parameters |
| params.edge | boolean | No | whether to retrieve volume and open interest metrics for all chains, defaults to true |
nado.fetchOpenInterests (symbols?, params?)fetchOrderBook
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of nado
Returns: object - A dictionary of order book structures
See: https://docs.nado.xyz/developer-resources/api/v2/orderbook
| 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 |
nado.fetchOrderBook (symbol, limit?, params?)fetchTrades
get the list of the most recent trades for a particular symbol
Kind: instance method of nado
Returns: Array<Trade> - a list of trade structures
See: https://docs.nado.xyz/developer-resources/api/v2/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 |
| params.max_trade_id | int | No | max trade id to include in the result for pagination |
nado.fetchTrades (symbol, since?, limit?, params?)fetchOHLCV
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of nado
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://docs.nado.xyz/developer-resources/api/archive-indexer/candlesticks
| 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 |
| params.until | int | No | timestamp in ms of the latest candle to fetch |
nado.fetchOHLCV (symbol, timeframe, since?, limit?, params?)watchTrades
watches information on multiple trades made in a market
Kind: instance method of nado
Returns: Array<Trade> - a list of trade structures
See: https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| 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 number of trades to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.watchTrades (symbol, since?, limit?, params?)unWatchTrades
unWatches information on multiple trades made in a market
Kind: instance method of nado
Returns: object - the exchange response
See: https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to unwatch trades for |
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.unWatchTrades (symbol, params?)watchTradesForSymbols
get the list of most recent trades for a list of symbols
Kind: instance method of nado
Returns: Array<Trade> - a list of trade structures
See: https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | unified symbols of the markets to fetch trades for |
| since | int | No | timestamp in ms of the earliest trade to fetch |
| limit | int | No | the maximum number of trades to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.watchTradesForSymbols (symbols, since?, limit?, params?)unWatchTradesForSymbols
unWatches information on multiple trades made in a list of markets
Kind: instance method of nado
Returns: object - the exchange response
See: https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | unified symbols of the markets to unwatch trades for |
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.unWatchTradesForSymbols (symbols, params?)watchOrderBook
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of nado
Returns: OrderBook - A dictionary of order book structures indexed by market symbols
See: https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| 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 |
nado.watchOrderBook (symbol, limit?, params?)unWatchOrderBook
unWatches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of nado
Returns: object - the exchange response
See: https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to unwatch the order book for |
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.unWatchOrderBook (symbol, params?)watchOrderBookForSymbols
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data for a list of symbols
Kind: instance method of nado
Returns: OrderBook - A dictionary of order book structures indexed by market symbols
See: https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | unified symbols of the markets 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 |
nado.watchOrderBookForSymbols (symbols, limit?, params?)unWatchOrderBookForSymbols
unWatches information on open orders with bid (buy) and ask (sell) prices, volumes and other data for a list of symbols
Kind: instance method of nado
Returns: object - the exchange response
See: https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | unified symbols of the markets to unwatch the order book for |
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.unWatchOrderBookForSymbols (symbols, params?)watchOHLCV
watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of nado
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| 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 |
nado.watchOHLCV (symbol, timeframe, since?, limit?, params?)watchOHLCVForSymbols
watches historical candlestick data containing the open, high, low, and close price, and the volume of multiple markets
Kind: instance method of nado
Returns: object - A dictionary of OHLCV structures indexed by market symbols
See: https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| Param | Type | Required | Description |
|---|---|---|---|
| symbolsAndTimeframes | Array<Array<string>> | Yes | array of arrays containing unified symbols and timeframes to watch OHLCV data for, example [['BTC/USDT0:USDT0', '1m'], ['ETH/USDT0:USDT0', '5m']] |
| 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 |
nado.watchOHLCVForSymbols (symbolsAndTimeframes, since?, limit?, params?)unWatchOHLCV
unWatches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of nado
Returns: object - the exchange response
See: https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to unwatch OHLCV data for |
| timeframe | string | Yes | the length of time each candle represents |
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.unWatchOHLCV (symbol, timeframe, params?)unWatchOHLCVForSymbols
unWatches historical candlestick data containing the open, high, low, and close price, and the volume of multiple markets
Kind: instance method of nado
Returns: object - the exchange response
See: https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| Param | Type | Required | Description |
|---|---|---|---|
| symbolsAndTimeframes | Array<Array<string>> | Yes | array of arrays containing unified symbols and timeframes to unwatch OHLCV data for, example [['BTC/USDT0:USDT0', '1m'], ['ETH/USDT0:USDT0', '5m']] |
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.unWatchOHLCVForSymbols (symbolsAndTimeframes, params?)watchTicker
watches a price ticker with the best bid and ask for a specific market
Kind: instance method of nado
Returns: object - a ticker structure
See: https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| 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 |
nado.watchTicker (symbol, params?)unWatchTicker
unWatches a price ticker with the best bid and ask for a specific market
Kind: instance method of nado
Returns: object - the exchange response
See: https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to unwatch the ticker for |
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.unWatchTicker (symbol, params?)watchTickers
watches price tickers with the best bid and ask for all markets of a specific list
Kind: instance method of nado
Returns: object - a dictionary of ticker structures
See: https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | unified symbols of the markets to fetch the ticker for |
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.watchTickers (symbols?, params?)unWatchTickers
unWatches price tickers with the best bid and ask for all markets of a specific list
Kind: instance method of nado
Returns: object - the exchange response
See: https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | unified symbols of the markets to unwatch the ticker for |
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.unWatchTickers (symbols?, params?)watchBidsAsks
watches best bid & ask for symbols
Kind: instance method of nado
Returns: object - a ticker structure
See: https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | unified symbols of the markets to fetch the bids and asks for |
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.watchBidsAsks (symbols, params?)unWatchBidsAsks
unWatches best bid & ask for symbols
Kind: instance method of nado
Returns: object - the exchange response
See: https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | unified symbols of the markets to unwatch the bids and asks for |
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.unWatchBidsAsks (symbols, params?)watchOrders
watches information on multiple orders made by the user
Kind: instance method of nado
Returns: Array<object> - a list of order structures
See
- https://docs.nado.xyz/developer-resources/api/subscriptions/authentication
- https://docs.nado.xyz/developer-resources/api/subscriptions/streams
- https://docs.nado.xyz/developer-resources/api/subscriptions/events
| 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 |
nado.watchOrders (symbol, since?, limit?, params?)unWatchOrders
unWatches information on multiple orders made by the user
Kind: instance method of nado
Returns: object - the exchange response
See
- https://docs.nado.xyz/developer-resources/api/subscriptions/authentication
- https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol of the market orders were made in |
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.unWatchOrders (symbol, params?)watchMyTrades
watches information on multiple trades made by the user
Kind: instance method of nado
Returns: Array<object> - a list of trade structures
See
- https://docs.nado.xyz/developer-resources/api/subscriptions/authentication
- https://docs.nado.xyz/developer-resources/api/subscriptions/streams
- https://docs.nado.xyz/developer-resources/api/subscriptions/events
| 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 trades for |
| limit | int | No | the maximum number of trade structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.watchMyTrades (symbol, since?, limit?, params?)unWatchMyTrades
unWatches information on multiple trades made by the user
Kind: instance method of nado
Returns: object - the exchange response
See
- https://docs.nado.xyz/developer-resources/api/subscriptions/authentication
- https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol of the market orders were made in |
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.unWatchMyTrades (symbol, params?)watchPositions
watches information on user positions
Kind: instance method of nado
Returns: Array<object> - a list of position structures
See
- https://docs.nado.xyz/developer-resources/api/subscriptions/authentication
- https://docs.nado.xyz/developer-resources/api/subscriptions/streams
- https://docs.nado.xyz/developer-resources/api/subscriptions/events
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | unified market symbols |
| since | int | No | the earliest time in ms to fetch positions for |
| limit | int | No | the maximum number of position structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.watchPositions (symbols?, since?, limit?, params?)unWatchPositions
unWatches information on user positions
Kind: instance method of nado
Returns: object - the exchange response
See
- https://docs.nado.xyz/developer-resources/api/subscriptions/authentication
- https://docs.nado.xyz/developer-resources/api/subscriptions/streams
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
nado.unWatchPositions (symbols?, params?)