wiki/exchanges/bitteam.md
<a name="bitteam" id="bitteam"></a>
Kind: global class
Extends: <code>Exchange</code>
<a name="fetchMarkets" id="fetchmarkets"></a>
retrieves data on all markets for bitteam
Kind: instance method of <code>bitteam</code>
Returns: <code>Array<object></code> - an array of objects representing market data
See: https://bit.team/trade/api/documentation#/CCXT/getTradeApiCcxtPairs
| Param | Type | Required | Description |
|---|---|---|---|
| params | <code>object</code> | No | extra parameters specific to the exchange api endpoint |
bitteam.fetchMarkets ([params])
<a name="fetchCurrencies" id="fetchcurrencies"></a>
fetches all available currencies on an exchange
Kind: instance method of <code>bitteam</code>
Returns: <code>object</code> - an associative dictionary of currencies
See: https://bit.team/trade/api/documentation#/PUBLIC/getTradeApiCurrencies
| Param | Type | Required | Description |
|---|---|---|---|
| params | <code>object</code> | No | extra parameters specific to the bitteam api endpoint |
bitteam.fetchCurrencies ([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>bitteam</code>
Returns: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume
| 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 bitteam api endpoint |
bitteam.fetchOHLCV (symbol, timeframe[, since, limit, 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>bitteam</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols
See: https://bit.team/trade/api/documentation#/CMC/getTradeApiCmcOrderbookPair
| 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 (default 100, max 200) |
| params | <code>object</code> | No | extra parameters specific to the bitteam api endpoint |
bitteam.fetchOrderBook (symbol[, limit, params])
<a name="fetchOrders" id="fetchorders"></a>
fetches information on multiple orders made by the user
Kind: instance method of <code>bitteam</code>
Returns: <code>Array<Order></code> - a list of order structures
See: https://bit.team/trade/api/documentation#/PRIVATE/getTradeApiCcxtOrdersofuser
| 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 orde structures to retrieve (default 10) |
| params | <code>object</code> | No | extra parameters specific to the bitteam api endpoint |
| params.type | <code>string</code> | No | the status of the order - 'active', 'closed', 'cancelled', 'all', 'history' (default 'all') |
bitteam.fetchOrders (symbol[, since, limit, params])
<a name="fetchOrder" id="fetchorder"></a>
fetches information on an order
Kind: instance method of <code>bitteam</code>
Returns: <code>object</code> - An order structure
See: https://bit.team/trade/api/documentation#/PRIVATE/getTradeApiCcxtOrderId
| Param | Type | Required | Description |
|---|---|---|---|
| id | <code>int</code>, <code>string</code> | Yes | order id |
| symbol | <code>string</code> | Yes | not used by bitteam fetchOrder () |
| params | <code>object</code> | No | extra parameters specific to the bitteam api endpoint |
bitteam.fetchOrder (id, symbol[, params])
<a name="fetchOpenOrders" id="fetchopenorders"></a>
fetch all unfilled currently open orders
Kind: instance method of <code>bitteam</code>
Returns: <code>Array<Order></code> - a list of order structures
See: https://bit.team/trade/api/documentation#/PRIVATE/getTradeApiCcxtOrdersofuser
| 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 order structures to retrieve (default 10) |
| params | <code>object</code> | No | extra parameters specific to the bitteam api endpoint |
bitteam.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>bitteam</code>
Returns: <code>Array<Order></code> - a list of order structures
See: https://bit.team/trade/api/documentation#/PRIVATE/getTradeApiCcxtOrdersofuser
| 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 closed order structures to retrieve (default 10) |
| params | <code>object</code> | No | extra parameters specific to the bitteam api endpoint |
bitteam.fetchClosedOrders (symbol[, since, limit, params])
<a name="fetchCanceledOrders" id="fetchcanceledorders"></a>
fetches information on multiple canceled orders made by the user
Kind: instance method of <code>bitteam</code>
Returns: <code>object</code> - a list of order structures
See: https://bit.team/trade/api/documentation#/PRIVATE/getTradeApiCcxtOrdersofuser
| 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 canceled order structures to retrieve (default 10) |
| params | <code>object</code> | No | extra parameters specific to the bitteam api endpoint |
bitteam.fetchCanceledOrders (symbol[, since, limit, params])
<a name="createOrder" id="createorder"></a>
create a trade order
Kind: instance method of <code>bitteam</code>
Returns: <code>object</code> - an order structure
See: https://bit.team/trade/api/documentation#/PRIVATE/postTradeApiCcxtOrdercreate
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | <code>string</code> | Yes | unified symbol of the market to create an order in |
| type | <code>string</code> | Yes | 'market' or '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 bitteam api endpoint |
bitteam.createOrder (symbol, type, side, amount[, price, params])
<a name="cancelOrder" id="cancelorder"></a>
cancels an open order
Kind: instance method of <code>bitteam</code>
Returns: <code>object</code> - An order structure
See: https://bit.team/trade/api/documentation#/PRIVATE/postTradeApiCcxtCancelorder
| Param | Type | Required | Description |
|---|---|---|---|
| id | <code>string</code> | Yes | order id |
| symbol | <code>string</code> | Yes | not used by bitteam cancelOrder () |
| params | <code>object</code> | No | extra parameters specific to the bitteam api endpoint |
bitteam.cancelOrder (id, symbol[, params])
<a name="cancelAllOrders" id="cancelallorders"></a>
cancel open orders of market
Kind: instance method of <code>bitteam</code>
Returns: <code>Array<object></code> - a list of order structures
See: https://bit.team/trade/api/documentation#/PRIVATE/postTradeApiCcxtCancelallorder
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | <code>string</code> | Yes | unified market symbol |
| params | <code>object</code> | No | extra parameters specific to the bitteam api endpoint |
bitteam.cancelAllOrders (symbol[, params])
<a name="fetchTickers" id="fetchtickers"></a>
fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of <code>bitteam</code>
Returns: <code>object</code> - a dictionary of ticker structures
See: https://bit.team/trade/api/documentation#/CMC/getTradeApiCmcSummary
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | <code>Array<string></code>, <code>undefined</code> | Yes | 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 bitteam api endpoint |
bitteam.fetchTickers (symbols[, 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>bitteam</code>
Returns: <code>object</code> - a ticker structure
See: https://bit.team/trade/api/documentation#/PUBLIC/getTradeApiPairName
| 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 bitteam api endpoint |
bitteam.fetchTicker (symbol[, params])
<a name="fetchTrades" id="fetchtrades"></a>
get the list of most recent trades for a particular symbol
Kind: instance method of <code>bitteam</code>
Returns: <code>Array<Trade></code> - a list of trade structures
See: https://bit.team/trade/api/documentation#/CMC/getTradeApiCmcTradesPair
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | <code>string</code> | Yes | unified symbol of the market to fetch trades for |
| 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 bitteam api endpoint |
bitteam.fetchTrades (symbol[, since, limit, params])
<a name="fetchMyTrades" id="fetchmytrades"></a>
fetch all trades made by the user
Kind: instance method of <code>bitteam</code>
Returns: <code>Array<Trade></code> - a list of trade structures
See: https://bit.team/trade/api/documentation#/PRIVATE/getTradeApiCcxtTradesofuser
| 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 (default 10) |
| params | <code>object</code> | No | extra parameters specific to the bitteam api endpoint |
bitteam.fetchMyTrades (symbol[, since, limit, params])
<a name="fetchDepositsWithdrawals" id="fetchdepositswithdrawals"></a>
fetch history of deposits and withdrawals from external wallets and between CoinList Pro trading account and CoinList wallet
Kind: instance method of <code>bitteam</code>
Returns: <code>object</code> - a list of transaction structure
See: https://bit.team/trade/api/documentation#/PRIVATE/getTradeApiTransactionsofuser
| Param | Type | Required | Description |
|---|---|---|---|
| code | <code>string</code> | No | unified currency code for the currency of the deposit/withdrawals |
| since | <code>int</code> | No | timestamp in ms of the earliest deposit/withdrawal |
| limit | <code>int</code> | No | max number of deposit/withdrawals to return (default 10) |
| params | <code>object</code> | No | extra parameters specific to the bitteam api endpoint |
bitteam.fetchDepositsWithdrawals ([code, since, limit, params])