## oceanex{docsify-ignore} **Kind**: global class **Extends**: Exchange * [fetchMarkets](#fetchmarkets) * [fetchTicker](#fetchticker) * [fetchTickers](#fetchtickers) * [fetchOrderBook](#fetchorderbook) * [fetchOrderBooks](#fetchorderbooks) * [fetchTrades](#fetchtrades) * [fetchTime](#fetchtime) * [fetchTradingFees](#fetchtradingfees) * [fetchBalance](#fetchbalance) * [createOrder](#createorder) * [fetchOrder](#fetchorder) * [fetchOpenOrders](#fetchopenorders) * [fetchClosedOrders](#fetchclosedorders) * [fetchOrders](#fetchorders) * [fetchOHLCV](#fetchohlcv) * [cancelOrder](#cancelorder) * [cancelOrders](#cancelorders) * [cancelAllOrders](#cancelallorders) ### fetchMarkets{docsify-ignore} retrieves data on all markets for oceanex **Kind**: instance method of [oceanex](#oceanex) **Returns**: Array<object> - an array of objects representing market data **See**: https://api.oceanex.pro/doc/v1/#markets-post | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript oceanex.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 [oceanex](#oceanex) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://api.oceanex.pro/doc/v1/#ticker-post | 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 | ```javascript oceanex.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 [oceanex](#oceanex) **Returns**: object - a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://api.oceanex.pro/doc/v1/#multiple-tickers-post | 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 | ```javascript oceanex.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 [oceanex](#oceanex) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See**: https://api.oceanex.pro/doc/v1/#order-book-post | 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 | ```javascript oceanex.fetchOrderBook (symbol[, limit, params]) ``` ### fetchOrderBooks{docsify-ignore} fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data for multiple markets **Kind**: instance method of [oceanex](#oceanex) **Returns**: object - a dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbol **See**: https://api.oceanex.pro/doc/v1/#multiple-order-books-post | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string>, undefined | Yes | list of unified market symbols, all symbols fetched if undefined, default is undefined | | limit | int | No | max number of entries per orderbook to return, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript oceanex.fetchOrderBooks (symbols[, limit, params]) ``` ### fetchTrades{docsify-ignore} get the list of most recent trades for a particular symbol **Kind**: instance method of [oceanex](#oceanex) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See**: https://api.oceanex.pro/doc/v1/#trades-post | 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 | ```javascript oceanex.fetchTrades (symbol[, since, limit, params]) ``` ### fetchTime{docsify-ignore} fetches the current integer timestamp in milliseconds from the exchange server **Kind**: instance method of [oceanex](#oceanex) **Returns**: int - the current integer timestamp in milliseconds from the exchange server **See**: https://api.oceanex.pro/doc/v1/#api-server-time-post | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript oceanex.fetchTime ([params]) ``` ### fetchTradingFees{docsify-ignore} fetch the trading fees for multiple markets **Kind**: instance method of [oceanex](#oceanex) **Returns**: object - a dictionary of [fee structures](https://docs.ccxt.com/#/?id=fee-structure) indexed by market symbols **See**: https://api.oceanex.pro/doc/v1/#trading-fees-post | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript oceanex.fetchTradingFees ([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 [oceanex](#oceanex) **Returns**: object - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure) **See**: https://api.oceanex.pro/doc/v1/#account-info-post | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript oceanex.fetchBalance ([params]) ``` ### createOrder{docsify-ignore} create a trade order **Kind**: instance method of [oceanex](#oceanex) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://api.oceanex.pro/doc/v1/#new-order-post | 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 | ```javascript oceanex.createOrder (symbol, type, side, amount[, price, params]) ``` ### fetchOrder{docsify-ignore} fetches information on an order made by the user **Kind**: instance method of [oceanex](#oceanex) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://api.oceanex.pro/doc/v1/#order-status-get | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market the order was made in | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript oceanex.fetchOrder (symbol[, params]) ``` ### fetchOpenOrders{docsify-ignore} fetch all unfilled currently open orders **Kind**: instance method of [oceanex](#oceanex) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://api.oceanex.pro/doc/v1/#order-status-get | 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 | ```javascript oceanex.fetchOpenOrders (symbol[, since, limit, params]) ``` ### fetchClosedOrders{docsify-ignore} fetches information on multiple closed orders made by the user **Kind**: instance method of [oceanex](#oceanex) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://api.oceanex.pro/doc/v1/#order-status-get | 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 | ```javascript oceanex.fetchClosedOrders (symbol[, since, limit, params]) ``` ### fetchOrders{docsify-ignore} fetches information on multiple orders made by the user **Kind**: instance method of [oceanex](#oceanex) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://api.oceanex.pro/doc/v1/#order-status-with-filters-post | 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 | ```javascript oceanex.fetchOrders (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 [oceanex](#oceanex) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See**: https://api.oceanex.pro/doc/v1/#k-line-post | 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 | ```javascript oceanex.fetchOHLCV (symbol, timeframe[, since, limit, params]) ``` ### cancelOrder{docsify-ignore} cancels an open order **Kind**: instance method of [oceanex](#oceanex) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://api.oceanex.pro/doc/v1/#cancel-order-post | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | order id | | symbol | string | Yes | not used by oceanex cancelOrder () | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript oceanex.cancelOrder (id, symbol[, params]) ``` ### cancelOrders{docsify-ignore} cancel multiple orders **Kind**: instance method of [oceanex](#oceanex) **Returns**: object - an list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://api.oceanex.pro/doc/v1/#cancel-multiple-orders-post | Param | Type | Required | Description | | --- | --- | --- | --- | | ids | Array<string> | Yes | order ids | | symbol | string | Yes | not used by oceanex cancelOrders () | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript oceanex.cancelOrders (ids, symbol[, params]) ``` ### cancelAllOrders{docsify-ignore} cancel all open orders **Kind**: instance method of [oceanex](#oceanex) **Returns**: Array<object> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://api.oceanex.pro/doc/v1/#cancel-all-orders-post | 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 | ```javascript oceanex.cancelAllOrders (symbol[, params]) ```