deepcoin
deepcoin cryptocurrency exchange — CCXT unified API: methods, parameters and endpoints.
deepcoin
Kind: global class
Extends: Exchange
- fetchMarkets
- fetchOrderBook
- fetchOHLCV
- fetchTickers
- fetchTrades
- fetchBalance
- fetchDeposits
- fetchWithdrawals
- fetchDepositAddresses
- fetchDepositAddress
- fetchLedger
- transfer
- createOrder
- createMarketOrderWithCost
- createMarketBuyOrderWithCost
- createMarketSellOrderWithCost
- fetchClosedOrder
- fetchOpenOrder
- fetchCanceledAndClosedOrders
- fetchCanceledOrders
- fetchClosedOrders
- fetchOpenOrders
- cancelOrder
- cancelAllOrders
- editOrder
- cancelOrders
- fetchPositionsForSymbol
- fetchPositions
- setLeverage
- fetchFundingRates
- fetchFundingRate
- fetchFundingRateHistory
- fetchMyTrades
- fetchOrderTrades
- closePosition
- watchTicker
- unWatchTicker
- watchTrades
- unWatchTrades
- watchOHLCV
- unWatchOHLCV
- watchOrderBook
- unWatchOrderBook
- watchMyTrades
- watchOrders
- watchPositions
fetchMarkets
retrieves data on all markets for okcoin
Kind: instance method of deepcoin
Returns: Array<object> - an array of objects representing market data
See: https://www.deepcoin.com/docs/DeepCoinMarket/getBaseInfo
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
deepcoin.fetchMarkets (params?)fetchOrderBook
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of deepcoin
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://www.deepcoin.com/docs/DeepCoinMarket/marketBooks
| 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 |
deepcoin.fetchOrderBook (symbol, 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 deepcoin
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See
- https://www.deepcoin.com/docs/DeepCoinMarket/getKlineData
- https://www.deepcoin.com/docs/DeepCoinMarket/getIndexKlineData
- https://www.deepcoin.com/docs/DeepCoinMarket/getMarkKlineData
| 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 |
| params.price | string | No | "mark" or "index" for mark price and index price candles |
| params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
deepcoin.fetchOHLCV (symbol, timeframe, since?, limit?, params?)fetchTickers
fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
Kind: instance method of deepcoin
Returns: object - a dictionary of ticker structures
See: https://www.deepcoin.com/docs/DeepCoinMarket/getMarketTickers
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | 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 |
deepcoin.fetchTickers (symbols?, params?)fetchTrades
get the list of most recent trades for a particular symbol
Kind: instance method of deepcoin
Returns: Array<Trade> - a list of trade structures
See: https://www.deepcoin.com/docs/DeepCoinMarket/getTrades
| 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 (default 100, max 500) |
| params | object | No | extra parameters specific to the exchange API endpoint |
deepcoin.fetchTrades (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 deepcoin
Returns: object - a balance structure
See: https://www.deepcoin.com/docs/DeepCoinAccount/getAccountBalance
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.type | string | No | "spot" or "swap", the market type for the balance |
deepcoin.fetchBalance (params?)fetchDeposits
fetch all deposits made to an account
Kind: instance method of deepcoin
Returns: Array<object> - a list of transaction structures
See: https://www.deepcoin.com/docs/assets/deposit
| 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 |
| params.until | int | No | the latest time in ms to fetch entries for |
| params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
deepcoin.fetchDeposits (code, since?, limit?, params?)fetchWithdrawals
fetch all withdrawals made from an account
Kind: instance method of deepcoin
Returns: Array<object> - a list of transaction structures
See: https://www.deepcoin.com/docs/assets/withdraw
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency code of the currency transferred |
| since | int | No | the earliest time in ms to fetch transfers for (default 24 hours ago) |
| limit | int | No | the maximum number of transfer structures to retrieve (default 50, max 200) |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.until | int | No | the latest time in ms to fetch transfers for (default time now) |
| params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
deepcoin.fetchWithdrawals (code, since?, limit?, params?)fetchDepositAddresses
fetch deposit addresses for multiple currencies and chain types
Kind: instance method of deepcoin
Returns: object - a list of address structures
See: https://www.deepcoin.com/docs/assets/chainlist
| Param | Type | Required | Description |
|---|---|---|---|
| codes | Array<string>, undefined | Yes | list of unified currency codes, default is undefined |
| params | object | No | extra parameters specific to the exchange API endpoint |
deepcoin.fetchDepositAddresses (codes, params?)fetchDepositAddress
fetch the deposit address for a currency associated with this account
Kind: instance method of deepcoin
Returns: object - an address structure
See: https://www.deepcoin.com/docs/assets/chainlist
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency code |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.network | string | No | unified network code for deposit chain |
deepcoin.fetchDepositAddress (code, 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 deepcoin
Returns: Array<object> - a list of ledger structures
See: https://www.deepcoin.com/docs/DeepCoinAccount/getAccountBills
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | No | unified currency code |
| since | int | No | timestamp in ms of the earliest ledger entry |
| limit | int | No | max number of ledger entries to return |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.until | int | No | timestamp in ms of the latest ledger entry |
| params.type | string | No | 'spot' or 'swap', the market type for the ledger (default 'spot') |
deepcoin.fetchLedger (code?, since?, limit?, params?)transfer
transfer currency internally between wallets on the same account
Kind: instance method of deepcoin
Returns: object - a transfer structure
See: https://www.deepcoin.com/docs/assets/transfer
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency code |
| amount | float | Yes | amount to transfer |
| fromAccount | string | Yes | account to transfer from ('spot', 'inverse', 'linear', 'fund', 'rebate' or 'demo') |
| toAccount | string | Yes | account to transfer to ('spot', 'inverse', 'linear', 'fund', 'rebate' or 'demo') |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.userId | string | No | user id |
deepcoin.transfer (code, amount, fromAccount, toAccount, params?)createOrder
create a trade order
Kind: instance method of deepcoin
Returns: object - an order structure
See
- https://www.deepcoin.com/docs/DeepCoinTrade/order
- https://www.deepcoin.com/docs/DeepCoinTrade/triggerOrder
| 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.clientOrderId | string | No | a unique id for the order |
| params.timeInForce | string | No | non trigger orders only 'GTC' (Good Till Cancel), 'IOC' (Immediate Or Cancel) or 'PO' (Post Only) |
| params.postOnly | bool | No | non trigger orders only true to place a post only order |
| params.reduceOnly | bool | No | non trigger orders only a mark to reduce the position size for margin, swap and future orders |
| params.triggerPrice | float | No | the price a trigger order is triggered at |
| params.stopLoss.triggerPrice | float | No | the price that a stop loss order is triggered at |
| params.takeProfit.triggerPrice | float | No | the price that a take profit order is triggered at |
| params.positionSide | string | No | if position mode is one-way: set to 'net', if position mode is hedge-mode: set to 'long' or 'short' |
| params.hedged | bool | No | swap only true for hedged mode, false for one way mode |
| params.marginMode | string | No | swap only'cross' or 'isolated', the default is 'cash' for spot and 'cross' for swap |
deepcoin.createOrder (symbol, type, side, amount, price?, params?)createMarketOrderWithCost
create a market order by providing the symbol, side and cost
Kind: instance method of deepcoin
Returns: object - an order structure
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to create an order in |
| side | string | Yes | 'buy' or 'sell' |
| cost | float | Yes | how much you want to trade in units of the quote currency |
| params | object | No | extra parameters specific to the exchange API endpoint |
deepcoin.createMarketOrderWithCost (symbol, side, cost, params?)createMarketBuyOrderWithCost
create a market buy order by providing the symbol and cost
Kind: instance method of deepcoin
Returns: object - an order structure
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to create an order in |
| cost | float | Yes | how much you want to trade in units of the quote currency |
| params | object | No | extra parameters specific to the exchange API endpoint |
deepcoin.createMarketBuyOrderWithCost (symbol, cost, params?)createMarketSellOrderWithCost
create a market sell order by providing the symbol and cost
Kind: instance method of deepcoin
Returns: object - an order structure
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to create an order in |
| cost | float | Yes | how much you want to trade in units of the quote currency |
| params | object | No | extra parameters specific to the exchange API endpoint |
deepcoin.createMarketSellOrderWithCost (symbol, cost, params?)fetchClosedOrder
fetches information on a closed order made by the user
Kind: instance method of deepcoin
Returns: object - an order structure
See: https://www.deepcoin.com/docs/DeepCoinTrade/finishOrderByID
| 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 |
deepcoin.fetchClosedOrder (id, symbol, params?)fetchOpenOrder
fetch an open order by it's id
Kind: instance method of deepcoin
Returns: object - an order structure
See: https://www.deepcoin.com/docs/DeepCoinTrade/orderByID
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | order id |
| symbol | string | Yes | unified market symbol, default is undefined |
| params | object | No | extra parameters specific to the exchange API endpoint |
deepcoin.fetchOpenOrder (id, symbol, params?)fetchCanceledAndClosedOrders
fetches information on multiple canceled and closed orders made by the user
Kind: instance method of deepcoin
Returns: Array<Order> - a list of order structures
See
- https://www.deepcoin.com/docs/DeepCoinTrade/ordersHistory
- https://www.deepcoin.com/docs/DeepCoinTrade/triggerOrdersHistory
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | 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 | bool | No | whether to fetch trigger/algo orders (default false) |
| params.type | string | No | non trigger orders only 'spot' or 'swap', the market type for the orders |
| params.state | string | No | non trigger orders only 'canceled' or 'filled', the order state to filter by |
| params.OrderType | string | No | trigger orders only 'limit' or 'market' |
| params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
deepcoin.fetchCanceledAndClosedOrders (symbol?, since?, limit?, params?)fetchCanceledOrders
fetches information on multiple canceled orders made by the user
Kind: instance method of deepcoin
Returns: Array<object> - a list of order structures
See: https://www.deepcoin.com/docs/DeepCoinTrade/ordersHistory
| 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.type | string | No | 'spot' or 'swap', the market type for the orders |
deepcoin.fetchCanceledOrders (symbol, since?, limit?, params?)fetchClosedOrders
fetches information on multiple closed orders made by the user
Kind: instance method of deepcoin
Returns: Array<object> - a list of order structures
See: https://www.deepcoin.com/docs/DeepCoinTrade/ordersHistory
| 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.type | string | No | 'spot' or 'swap', the market type for the orders |
deepcoin.fetchClosedOrders (symbol, since?, limit?, params?)fetchOpenOrders
fetch all unfilled currently open orders
Kind: instance method of deepcoin
Returns: Array<Order> - a list of order structures
See
- https://www.deepcoin.com/docs/DeepCoinTrade/ordersPendingV2
- https://www.deepcoin.com/docs/DeepCoinTrade/triggerOrdersPending
| 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 | bool | No | whether to fetch trigger/algo orders (default false) |
| params.index | int | No | non trigger orders only pagination index, default is 1 |
| params.orderType | string | No | trigger orders only 'limit' or 'market' |
deepcoin.fetchOpenOrders (symbol, since?, limit?, params?)cancelOrder
cancels an open order
Kind: instance method of deepcoin
Returns: object - An order structure
See: https://www.deepcoin.com/docs/DeepCoinTrade/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.trigger | bool | No | whether the order is a trigger/algo order (default false) |
deepcoin.cancelOrder (id, symbol, params?)cancelAllOrders
cancel all open orders in a market
Kind: instance method of deepcoin
Returns: Array<object> - a list of order structures
See: https://www.deepcoin.com/docs/DeepCoinTrade/cancelAllOrder
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol of the market to cancel orders in |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.marginMode | string | No | swap only 'cross' or 'isolated', the default is 'cash' for spot and 'cross' for swap |
| params.merged | bool | No | swap only true for merged positions, false for split positions (default true) |
deepcoin.cancelAllOrders (symbol, params?)editOrder
edit a trade order
Kind: instance method of deepcoin
Returns: object - an order structure
See
- https://www.deepcoin.com/docs/DeepCoinTrade/replaceOrder
- https://www.deepcoin.com/docs/DeepCoinTrade/replaceTPSL
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | cancel order id |
| symbol | string | No | unified symbol of the market to create an order in (not used in deepcoin editOrder) |
| type | string | No | 'market' or 'limit' (not used in deepcoin editOrder) |
| side | string | No | 'buy' or 'sell' (not used in deepcoin editOrder) |
| amount | float | No | 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.stopLossPrice | float | No | the price that a stop loss order is triggered at |
| params.takeProfitPrice | float | No | the price that a take profit order is triggered at |
deepcoin.editOrder (id, symbol?, type?, side?, amount?, price?, params?)cancelOrders
cancel multiple orders
Kind: instance method of deepcoin
Returns: object - an list of order structures
| Param | Type | Required | Description |
|---|---|---|---|
| ids | Array<string> | Yes | order ids |
| symbol | string | No | unified market symbol, default is undefined |
| params | object | No | extra parameters specific to the exchange API endpoint |
deepcoin.cancelOrders (ids, symbol?, params?)fetchPositionsForSymbol
fetch all open positions for specific symbol
Kind: instance method of deepcoin
Returns: Array<object> - a list of position structure
See: https://www.deepcoin.com/docs/DeepCoinAccount/accountPositions
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
deepcoin.fetchPositionsForSymbol (symbol, params?)fetchPositions
fetch all open positions
Kind: instance method of deepcoin
Returns: Array<object> - a list of position structure
See: https://www.deepcoin.com/docs/DeepCoinAccount/accountPositions
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | list of unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
deepcoin.fetchPositions (symbols?, params?)setLeverage
set the level of leverage for a market
Kind: instance method of deepcoin
Returns: object - response from the exchange
See: https://www.deepcoin.com/docs/DeepCoinAccount/accountSetLeverage
| Param | Type | Required | Description |
|---|---|---|---|
| leverage | float | Yes | the rate of leverage |
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.marginMode | string | No | 'cross' or 'isolated' (default is cross) |
| params.mrgPosition | string | No | 'merge' or 'split', default is merge |
deepcoin.setLeverage (leverage, symbol, params?)fetchFundingRates
fetch the funding rate for multiple markets
Kind: instance method of deepcoin
Returns: Array<object> - a list of funding rate structures, indexed by market symbols
See: https://www.deepcoin.com/docs/DeepCoinTrade/currentFundRate
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string>, undefined | Yes | list of unified market symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.subType | string | No | "linear" or "inverse" |
deepcoin.fetchFundingRates (symbols, params?)fetchFundingRate
fetch the current funding rate
Kind: instance method of deepcoin
Returns: object - a funding rate structure
See: https://www.deepcoin.com/docs/DeepCoinTrade/currentFundRate
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
deepcoin.fetchFundingRate (symbol, params?)fetchFundingRateHistory
fetches historical funding rate prices
Kind: instance method of deepcoin
Returns: Array<object> - a list of funding rate structures
See: https://www.deepcoin.com/docs/DeepCoinTrade/fundingRateHistory
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch the funding rate history for |
| since | int | No | timestamp in ms of the earliest funding rate to fetch |
| limit | int | No | the maximum amount of funding rate structures to fetch |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.page | int | No | pagination page number |
deepcoin.fetchFundingRateHistory (symbol, since?, limit?, params?)fetchMyTrades
fetch all trades made by the user
Kind: instance method of deepcoin
Returns: Array<Trade> - a list of trade structures
See: https://www.deepcoin.com/docs/DeepCoinTrade/tradeFills
| 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 |
| params.until | int | No | timestamp in ms of the latest trade to fetch |
| params.type | string | No | 'spot' or 'swap', the market type for the trades (default is 'spot') |
| params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the available parameters |
deepcoin.fetchMyTrades (symbol, since?, limit?, params?)fetchOrderTrades
fetch all the trades made from a single order
Kind: instance method of deepcoin
Returns: Array<object> - a list of trade structures
See: https://www.deepcoin.com/docs/DeepCoinTrade/tradeFills
| 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 |
| params.type | string | No | 'spot' or 'swap', the market type for the trades |
deepcoin.fetchOrderTrades (id, symbol, since?, limit?, params?)closePosition
closes open positions for a market
Kind: instance method of deepcoin
Returns: object - an order structure
See
- https://www.deepcoin.com/docs/DeepCoinTrade/batchClosePosition
- https://www.deepcoin.com/docs/DeepCoinTrade/closePositionByIds
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | Unified CCXT market symbol |
| side | string | No | not used by deepcoin |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.positionId | string, undefined | No | the id of the position you would like to close |
| params.positionIds | Array<string>, undefined | No | list of position ids to close (for batch closing) |
deepcoin.closePosition (symbol, side?, 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 deepcoin
Returns: object - a ticker structure
See: https://www.deepcoin.com/docs/publicWS/latestMarketData
| 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 |
deepcoin.watchTicker (symbol, params?)unWatchTicker
unWatches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of deepcoin
Returns: object - a ticker structure
See: https://www.deepcoin.com/docs/publicWS/latestMarketData
| 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 |
deepcoin.unWatchTicker (symbol, params?)watchTrades
watches information on multiple trades made in a market
Kind: instance method of deepcoin
Returns: Array<object> - a list of trade structures
See: https://www.deepcoin.com/docs/publicWS/lastTransactions
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol of the market trades were made in |
| since | int | No | the earliest time in ms to fetch orders for |
| limit | int | No | the maximum number of trade structures to retrieve |
| params | object | No | extra parameters specific to the exchange API endpoint |
deepcoin.watchTrades (symbol, since?, limit?, params?)unWatchTrades
unWatches the list of most recent trades for a particular symbol
Kind: instance method of deepcoin
Returns: Array<object> - a list of trade structures
See: https://www.deepcoin.com/docs/publicWS/lastTransactions
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch trades for |
| params | object | No | extra parameters specific to the exchange API endpoint |
deepcoin.unWatchTrades (symbol, params?)watchOHLCV
watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of deepcoin
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://www.deepcoin.com/docs/publicWS/KLines
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | string | No | 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 |
deepcoin.watchOHLCV (symbol, timeframe?, since?, limit?, params?)unWatchOHLCV
watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of deepcoin
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://docs.backpack.exchange/#tag/Streams/Public/K-Line
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | string | No | the length of time each candle represents |
| params | object | No | extra parameters specific to the exchange API endpoint |
deepcoin.unWatchOHLCV (symbol, timeframe?, params?)watchOrderBook
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of deepcoin
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://www.deepcoin.com/docs/publicWS/25LevelIncrementalMarketData
| 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 |
deepcoin.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 deepcoin
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://www.deepcoin.com/docs/publicWS/25LevelIncrementalMarketData
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified array of symbols |
| params | object | No | extra parameters specific to the exchange API endpoint |
deepcoin.unWatchOrderBook (symbol, params?)watchMyTrades
watches information on multiple trades made by the user
Kind: instance method of deepcoin
Returns: Array<object> - a list of order structures
See: https://www.deepcoin.com/docs/privateWS/Trade
| 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 |
deepcoin.watchMyTrades (symbol, since?, limit?, params?)watchOrders
watches information on multiple orders made by the user
Kind: instance method of deepcoin
Returns: Array<object> - a list of order structures
See: https://www.deepcoin.com/docs/privateWS/order
| 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 |
deepcoin.watchOrders (symbol, since?, limit?, params?)watchPositions
watch all open positions
Kind: instance method of deepcoin
Returns: Array<object> - a list of position structure
See: https://www.deepcoin.com/docs/privateWS/Position
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | list of unified market symbols to watch positions for |
| since | int | No | the earliest time in ms to fetch positions for |
| limit | int | No | the maximum number of positions to retrieve |
| params | object | Yes | extra parameters specific to the exchange API endpoint |
deepcoin.watchPositions (symbols?, since?, limit?, params)