bitteam

bitteam{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchMarkets
• fetchCurrencies
• fetchOHLCV
• fetchOrderBook
• fetchOrders
• fetchOrder
• fetchOpenOrders
• fetchClosedOrders
• fetchCanceledOrders
• createOrder
• cancelOrder
• cancelAllOrders
• fetchTickers
• fetchTicker
• fetchTrades
• fetchMyTrades
• fetchDepositsWithdrawals

fetchMarkets{docsify-ignore}

retrieves data on all markets for bitteam

Kind: instance method of bitteam
Returns: Array<object> - an array of objects representing market data

See: https://bit.team/trade/api/documentation#/CCXT/getTradeApiCcxtPairs

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange api endpoint

bitteam.fetchMarkets (params?)

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of bitteam
Returns: object - an associative dictionary of currencies

See: https://bit.team/trade/api/documentation#/PUBLIC/getTradeApiCurrencies

Param	Type	Required	Description
params	object	No	extra parameters specific to the bitteam api endpoint

bitteam.fetchCurrencies (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 bitteam
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume

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 bitteam api endpoint

bitteam.fetchOHLCV (symbol, timeframe, since?, limit?, params?)

fetchOrderBook{docsify-ignore}

fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of bitteam
Returns: object - A dictionary of order book structures indexed by market symbols

See: https://bit.team/trade/api/documentation#/CMC/getTradeApiCmcOrderbookPair

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 (default 100, max 200)
params	object	No	extra parameters specific to the bitteam api endpoint

bitteam.fetchOrderBook (symbol, limit?, params?)

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

Kind: instance method of bitteam
Returns: Array<Order> - a list of order structures

See: https://bit.team/trade/api/documentation#/PRIVATE/getTradeApiCcxtOrdersofuser

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 orde structures to retrieve (default 10)
params	object	No	extra parameters specific to the bitteam api endpoint
params.type	string	No	the status of the order - 'active', 'closed', 'cancelled', 'all', 'history' (default 'all')

bitteam.fetchOrders (symbol, since?, limit?, params?)

fetchOrder{docsify-ignore}

fetches information on an order

Kind: instance method of bitteam
Returns: object - An order structure

See: https://bit.team/trade/api/documentation#/PRIVATE/getTradeApiCcxtOrderId

Param	Type	Required	Description
id	int, string	Yes	order id
symbol	string	Yes	not used by bitteam fetchOrder ()
params	object	No	extra parameters specific to the bitteam api endpoint

bitteam.fetchOrder (id, symbol, params?)

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

Kind: instance method of bitteam
Returns: Array<Order> - a list of order structures

See: https://bit.team/trade/api/documentation#/PRIVATE/getTradeApiCcxtOrdersofuser

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 (default 10)
params	object	No	extra parameters specific to the bitteam api endpoint

bitteam.fetchOpenOrders (symbol, since?, limit?, params?)

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

Kind: instance method of bitteam
Returns: Array<Order> - a list of order structures

See: https://bit.team/trade/api/documentation#/PRIVATE/getTradeApiCcxtOrdersofuser

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 closed order structures to retrieve (default 10)
params	object	No	extra parameters specific to the bitteam api endpoint

bitteam.fetchClosedOrders (symbol, since?, limit?, params?)

fetchCanceledOrders{docsify-ignore}

fetches information on multiple canceled orders made by the user

Kind: instance method of bitteam
Returns: object - a list of order structures

See: https://bit.team/trade/api/documentation#/PRIVATE/getTradeApiCcxtOrdersofuser

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 canceled order structures to retrieve (default 10)
params	object	No	extra parameters specific to the bitteam api endpoint

bitteam.fetchCanceledOrders (symbol, since?, limit?, params?)

createOrder{docsify-ignore}

create a trade order

Kind: instance method of bitteam
Returns: object - an order structure

See: https://bit.team/trade/api/documentation#/PRIVATE/postTradeApiCcxtOrdercreate

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 bitteam api endpoint

bitteam.createOrder (symbol, type, side, amount, price?, params?)

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of bitteam
Returns: object - An order structure

See: https://bit.team/trade/api/documentation#/PRIVATE/postTradeApiCcxtCancelorder

Param	Type	Required	Description
id	string	Yes	order id
symbol	string	Yes	not used by bitteam cancelOrder ()
params	object	No	extra parameters specific to the bitteam api endpoint

bitteam.cancelOrder (id, symbol, params?)

cancelAllOrders{docsify-ignore}

cancel open orders of market

Kind: instance method of bitteam
Returns: Array<object> - a list of order structures

See: https://bit.team/trade/api/documentation#/PRIVATE/postTradeApiCcxtCancelallorder

Param	Type	Required	Description
symbol	string	Yes	unified market symbol
params	object	No	extra parameters specific to the bitteam api endpoint

bitteam.cancelAllOrders (symbol, params?)

fetchTickers{docsify-ignore}

fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market

Kind: instance method of bitteam
Returns: object - a dictionary of ticker structures

See: https://bit.team/trade/api/documentation#/CMC/getTradeApiCmcSummary

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 bitteam api endpoint

bitteam.fetchTickers (symbols, 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 bitteam
Returns: object - a ticker structure

See: https://bit.team/trade/api/documentation#/PUBLIC/getTradeApiPairName

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 bitteam api endpoint

bitteam.fetchTicker (symbol, params?)

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of bitteam
Returns: Array<Trade> - a list of trade structures

See: https://bit.team/trade/api/documentation#/CMC/getTradeApiCmcTradesPair

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 bitteam api endpoint

bitteam.fetchTrades (symbol, since?, limit?, params?)

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

Kind: instance method of bitteam
Returns: Array<Trade> - a list of trade structures

See: https://bit.team/trade/api/documentation#/PRIVATE/getTradeApiCcxtTradesofuser

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 (default 10)
params	object	No	extra parameters specific to the bitteam api endpoint

bitteam.fetchMyTrades (symbol, since?, limit?, params?)

fetchDepositsWithdrawals{docsify-ignore}

fetch history of deposits and withdrawals from external wallets and between CoinList Pro trading account and CoinList wallet

Kind: instance method of bitteam
Returns: object - a list of transaction structure

See: https://bit.team/trade/api/documentation#/PRIVATE/getTradeApiTransactionsofuser

Param	Type	Required	Description
code	string	No	unified currency code for the currency of the deposit/withdrawals
since	int	No	timestamp in ms of the earliest deposit/withdrawal
limit	int	No	max number of deposit/withdrawals to return (default 10)
params	object	No	extra parameters specific to the bitteam api endpoint

bitteam.fetchDepositsWithdrawals (code?, since?, limit?, params?)