wiki/exchanges/onetrading.md
<a name="onetrading" id="onetrading"></a>
Kind: global class
Extends: <code>Exchange</code>
<a name="fetchTime" id="fetchtime"></a>
fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of <code>onetrading</code>
Returns: <code>int</code> - the current integer timestamp in milliseconds from the exchange server
See: https://docs.onetrading.com/rest/public/time
| Param | Type | Required | Description |
|---|---|---|---|
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.fetchTime ([params])
<a name="fetchCurrencies" id="fetchcurrencies"></a>
fetches all available currencies on an exchange
Kind: instance method of <code>onetrading</code>
Returns: <code>object</code> - an associative dictionary of currencies
See: https://docs.onetrading.com/rest/public/currencies
| Param | Type | Required | Description |
|---|---|---|---|
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.fetchCurrencies ([params])
<a name="fetchMarkets" id="fetchmarkets"></a>
retrieves data on all markets for onetrading
Kind: instance method of <code>onetrading</code>
Returns: <code>Array<object></code> - an array of objects representing market data
See: https://docs.onetrading.com/rest/public/instruments
| Param | Type | Required | Description |
|---|---|---|---|
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.fetchMarkets ([params])
<a name="fetchTradingFees" id="fetchtradingfees"></a>
fetch the trading fees for multiple markets
Kind: instance method of <code>onetrading</code>
Returns: <code>object</code> - a dictionary of fee structures indexed by market symbols
See
| Param | Type | Required | Description |
|---|---|---|---|
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
| params.method | <code>string</code> | No | fetchPrivateTradingFees or fetchPublicTradingFees |
onetrading.fetchTradingFees ([params])
<a name="fetchTicker" id="fetchticker"></a>
fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of <code>onetrading</code>
Returns: <code>object</code> - a ticker structure
See: https://docs.onetrading.com/rest/public/market-ticker-instrument
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | <code>string</code> | Yes | unified symbol of the market to fetch the ticker for |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.fetchTicker (symbol[, params])
<a name="fetchTickers" id="fetchtickers"></a>
fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
Kind: instance method of <code>onetrading</code>
Returns: <code>object</code> - a dictionary of ticker structures
See: https://docs.onetrading.com/rest/public/market-ticker
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | <code>Array<string></code> | No | unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.fetchTickers ([symbols, params])
<a name="fetchOrderBook" id="fetchorderbook"></a>
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of <code>onetrading</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols
See: https://docs.onetrading.com/rest/public/orderbook
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | <code>string</code> | Yes | unified symbol of the market to fetch the order book for |
| limit | <code>int</code> | No | the maximum amount of order book entries to return |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.fetchOrderBook (symbol[, limit, params])
<a name="fetchOHLCV" id="fetchohlcv"></a>
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of <code>onetrading</code>
Returns: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://docs.onetrading.com/rest/public/candlesticks
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | <code>string</code> | Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | <code>string</code> | Yes | the length of time each candle represents |
| since | <code>int</code> | No | timestamp in ms of the earliest candle to fetch |
| limit | <code>int</code> | No | the maximum amount of candles to fetch |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.fetchOHLCV (symbol, timeframe[, since, limit, params])
<a name="fetchBalance" id="fetchbalance"></a>
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of <code>onetrading</code>
Returns: <code>object</code> - a balance structure
See: https://docs.onetrading.com/rest/trading/balances
| Param | Type | Required | Description |
|---|---|---|---|
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.fetchBalance ([params])
<a name="createOrder" id="createorder"></a>
create a trade order
Kind: instance method of <code>onetrading</code>
Returns: <code>object</code> - an order structure
See: https://docs.onetrading.com/rest/trading/create-order
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | <code>string</code> | Yes | unified symbol of the market to create an order in |
| type | <code>string</code> | Yes | 'limit' |
| side | <code>string</code> | Yes | 'buy' or 'sell' |
| amount | <code>float</code> | Yes | how much of currency you want to trade in units of base currency |
| price | <code>float</code> | No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
| params.triggerPrice | <code>float</code> | No | onetrading only does stop limit orders and does not do stop market |
onetrading.createOrder (symbol, type, side, amount[, price, params])
<a name="cancelOrder" id="cancelorder"></a>
cancels an open order
Kind: instance method of <code>onetrading</code>
Returns: <code>object</code> - An order structure
See
| Param | Type | Required | Description |
|---|---|---|---|
| id | <code>string</code> | Yes | order id |
| symbol | <code>string</code> | Yes | not used by bitmex cancelOrder () |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.cancelOrder (id, symbol[, params])
<a name="cancelAllOrders" id="cancelallorders"></a>
cancel all open orders
Kind: instance method of <code>onetrading</code>
Returns: <code>Array<object></code> - a list of order structures
See: https://docs.onetrading.com/rest/trading/cancel-all-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | <code>string</code> | Yes | unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.cancelAllOrders (symbol[, params])
<a name="cancelOrders" id="cancelorders"></a>
cancel multiple orders
Kind: instance method of <code>onetrading</code>
Returns: <code>object</code> - an list of order structures
See: https://docs.onetrading.com/rest/trading/cancel-all-orders
| Param | Type | Required | Description |
|---|---|---|---|
| ids | <code>Array<string></code> | Yes | order ids |
| symbol | <code>string</code> | Yes | unified market symbol, default is undefined |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.cancelOrders (ids, symbol[, params])
<a name="fetchOrder" id="fetchorder"></a>
fetches information on an order made by the user
Kind: instance method of <code>onetrading</code>
Returns: <code>object</code> - An order structure
See: https://docs.onetrading.com/rest/trading/get-order-order-id
| Param | Type | Required | Description |
|---|---|---|---|
| id | <code>string</code> | Yes | the order id |
| symbol | <code>string</code> | Yes | not used by onetrading fetchOrder |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.fetchOrder (id, symbol[, params])
<a name="fetchOpenOrders" id="fetchopenorders"></a>
fetch all unfilled currently open orders
Kind: instance method of <code>onetrading</code>
Returns: <code>Array<Order></code> - a list of order structures
See: https://docs.onetrading.com/rest/trading/get-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | <code>string</code> | Yes | unified market symbol |
| since | <code>int</code> | No | the earliest time in ms to fetch open orders for |
| limit | <code>int</code> | No | the maximum number of open orders structures to retrieve |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.fetchOpenOrders (symbol[, since, limit, params])
<a name="fetchClosedOrders" id="fetchclosedorders"></a>
fetches information on multiple closed orders made by the user
Kind: instance method of <code>onetrading</code>
Returns: <code>Array<Order></code> - a list of order structures
See: https://docs.onetrading.com/rest/trading/get-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | <code>string</code> | Yes | unified market symbol of the market orders were made in |
| since | <code>int</code> | No | the earliest time in ms to fetch orders for |
| limit | <code>int</code> | No | the maximum number of order structures to retrieve |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.fetchClosedOrders (symbol[, since, limit, params])
<a name="fetchOrderTrades" id="fetchordertrades"></a>
fetch all the trades made from a single order
Kind: instance method of <code>onetrading</code>
Returns: <code>Array<object></code> - a list of trade structures
See: https://docs.onetrading.com/rest/trading/get-trades-for-order
| Param | Type | Required | Description |
|---|---|---|---|
| id | <code>string</code> | Yes | order id |
| symbol | <code>string</code> | Yes | unified market symbol |
| since | <code>int</code> | No | the earliest time in ms to fetch trades for |
| limit | <code>int</code> | No | the maximum number of trades to retrieve |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.fetchOrderTrades (id, symbol[, since, limit, params])
<a name="fetchMyTrades" id="fetchmytrades"></a>
fetch all trades made by the user
Kind: instance method of <code>onetrading</code>
Returns: <code>Array<Trade></code> - a list of trade structures
See: https://docs.onetrading.com/rest/trading/get-trades
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | <code>string</code> | Yes | unified market symbol |
| since | <code>int</code> | No | the earliest time in ms to fetch trades for |
| limit | <code>int</code> | No | the maximum number of trades structures to retrieve |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.fetchMyTrades (symbol[, since, limit, params])
<a name="watchBalance" id="watchbalance"></a>
watch balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of <code>onetrading</code>
Returns: <code>object</code> - a balance structure
See: https://developers.bitpanda.com/exchange/#account-history-channel
| Param | Type | Required | Description |
|---|---|---|---|
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.watchBalance ([params])
<a name="watchTicker" id="watchticker"></a>
watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of <code>onetrading</code>
Returns: <code>object</code> - a ticker structure
See: https://developers.bitpanda.com/exchange/#market-ticker-channel
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | <code>string</code> | Yes | unified symbol of the market to fetch the ticker for |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.watchTicker (symbol[, params])
<a name="watchTickers" id="watchtickers"></a>
watches price tickers, a statistical calculation with the information for all markets or those specified.
Kind: instance method of <code>onetrading</code>
Returns: <code>object</code> - an array of ticker structure
See: https://developers.bitpanda.com/exchange/#market-ticker-channel
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | <code>string</code> | Yes | unified symbols of the markets to fetch the ticker for |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.watchTickers (symbols[, params])
<a name="watchMyTrades" id="watchmytrades"></a>
get the list of trades associated with the user
Kind: instance method of <code>onetrading</code>
Returns: <code>Array<object></code> - a list of trade structures
See: https://developers.bitpanda.com/exchange/#account-history-channel
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | <code>string</code> | Yes | unified symbol of the market to fetch trades for. Use 'any' to watch all trades |
| since | <code>int</code> | No | timestamp in ms of the earliest trade to fetch |
| limit | <code>int</code> | No | the maximum amount of trades to fetch |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.watchMyTrades (symbol[, since, limit, params])
<a name="watchOrderBook" id="watchorderbook"></a>
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of <code>onetrading</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols
See: https://developers.bitpanda.com/exchange/#market-ticker-channel
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | <code>string</code> | Yes | unified symbol of the market to fetch the order book for |
| limit | <code>int</code> | No | the maximum amount of order book entries to return |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.watchOrderBook (symbol[, limit, params])
<a name="watchOrders" id="watchorders"></a>
watches information on multiple orders made by the user
Kind: instance method of <code>onetrading</code>
Returns: <code>Array<object></code> - a list of order structures
See: https://developers.bitpanda.com/exchange/#account-history-channel
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | <code>string</code> | Yes | unified market symbol of the market orders were made in |
| since | <code>int</code> | No | the earliest time in ms to fetch orders for |
| limit | <code>int</code> | No | the maximum number of order structures to retrieve |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
| params.channel | <code>string</code> | No | can listen to orders using ACCOUNT_HISTORY or TRADING |
onetrading.watchOrders (symbol[, since, limit, params])
<a name="watchOHLCV" id="watchohlcv"></a>
watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of <code>onetrading</code>
Returns: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://developers.bitpanda.com/exchange/#candlesticks-channel
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | <code>string</code> | Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | <code>string</code> | Yes | the length of time each candle represents |
| since | <code>int</code> | No | timestamp in ms of the earliest candle to fetch |
| limit | <code>int</code> | No | the maximum amount of candles to fetch |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
onetrading.watchOHLCV (symbol, timeframe[, since, limit, params])