bitopro

bitopro{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchCurrencies
• fetchMarkets
• fetchTicker
• fetchTickers
• fetchOrderBook
• fetchTrades
• fetchTradingFees
• fetchOHLCV
• fetchBalance
• createOrder
• cancelOrder
• cancelOrders
• cancelAllOrders
• fetchOrder
• fetchOrders
• fetchOpenOrders
• fetchClosedOrders
• fetchMyTrades
• fetchDeposits
• fetchWithdrawals
• fetchWithdrawal
• withdraw
• fetchDepositWithdrawFees
• watchOrderBook
• watchTrades
• watchMyTrades
• watchTicker
• watchBalance

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

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

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/public/get_currency_info.md

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

bitopro.fetchCurrencies (params?)

fetchMarkets{docsify-ignore}

retrieves data on all markets for bitopro

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

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/public/get_trading_pair_info.md

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

bitopro.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 bitopro
Returns: object - a ticker structure

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/public/get_ticker_data.md

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

bitopro.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 bitopro
Returns: object - a dictionary of ticker structures

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/public/get_ticker_data.md

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

bitopro.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 bitopro
Returns: object - A dictionary of order book structures indexed by market symbols

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/public/get_orderbook_data.md

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

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

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/public/get_trades_data.md

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

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

fetchTradingFees{docsify-ignore}

fetch the trading fees for multiple markets

Kind: instance method of bitopro
Returns: object - a dictionary of fee structures indexed by market symbols

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/public/get_limitations_and_fees.md

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

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

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/public/get_ohlc_data.md

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

bitopro.fetchOHLCV (symbol, timeframe, since?, limit?, 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 bitopro
Returns: object - a balance structure

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/private/get_account_balance.md

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

bitopro.fetchBalance (params?)

createOrder{docsify-ignore}

create a trade order

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

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/private/create_an_order.md

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.triggerPrice	object	No	the price at which a trigger order is triggered at

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

cancelOrder{docsify-ignore}

cancels an open order

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

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/private/cancel_an_order.md

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

bitopro.cancelOrder (id, symbol, params?)

cancelOrders{docsify-ignore}

cancel multiple orders

Kind: instance method of bitopro
Returns: object - an list of order structures

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/private/cancel_batch_orders.md

Param	Type	Required	Description
ids	Array<string>	Yes	order ids
symbol	string	Yes	unified market symbol
params	object	No	extra parameters specific to the exchange API endpoint

bitopro.cancelOrders (ids, symbol, params?)

cancelAllOrders{docsify-ignore}

cancel all open orders

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

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/private/cancel_all_orders.md

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

bitopro.cancelAllOrders (symbol, params?)

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/private/get_an_order_data.md

Param	Type	Required	Description
id	string	Yes	the 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

bitopro.fetchOrder (id, symbol, params?)

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

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

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/private/get_orders_data.md

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

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

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/private/get_open_orders_data.md

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

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

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

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

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/private/get_orders_data.md

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

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

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/private/get_trades_data.md

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

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

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

Kind: instance method of bitopro
Returns: Array<object> - a list of transaction structures

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/private/get_deposit_invoices_data.md

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

bitopro.fetchDeposits (code, since?, limit?, params?)

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

Kind: instance method of bitopro
Returns: Array<object> - a list of transaction structures

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/private/get_withdraw_invoices_data.md

Param	Type	Required	Description
code	string	Yes	unified currency code
since	int	No	the earliest time in ms to fetch withdrawals for
limit	int	No	the maximum number of withdrawals structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

bitopro.fetchWithdrawals (code, since?, limit?, params?)

fetchWithdrawal{docsify-ignore}

fetch data on a currency withdrawal via the withdrawal id

Kind: instance method of bitopro
Returns: object - a transaction structure

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/private/get_an_withdraw_invoice_data.md

Param	Type	Required	Description
id	string	Yes	withdrawal id
code	string	Yes	unified currency code of the currency withdrawn, default is undefined
params	object	No	extra parameters specific to the exchange API endpoint

bitopro.fetchWithdrawal (id, code, params?)

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of bitopro
Returns: object - a transaction structure

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/private/create_an_withdraw_invoice.md

Param	Type	Required	Description
code	string	Yes	unified currency code
amount	float	Yes	the amount to withdraw
address	string	Yes	the address to withdraw to
tag	string	Yes
params	object	No	extra parameters specific to the exchange API endpoint

bitopro.withdraw (code, amount, address, tag, params?)

fetchDepositWithdrawFees{docsify-ignore}

fetch deposit and withdraw fees

Kind: instance method of bitopro
Returns: object - a list of fee structures

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/api/v3/public/get_currency_info.md

Param	Type	Required	Description
codes	Array<string>, undefined	Yes	list of unified currency codes
params	object	No	extra parameters specific to the exchange API endpoint

bitopro.fetchDepositWithdrawFees (codes, params?)

watchOrderBook{docsify-ignore}

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

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

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/ws/public/order_book_stream.md

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

bitopro.watchOrderBook (symbol, limit?, params?)

watchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of bitopro
Returns: Array<object> - a list of trade structures

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/ws/public/trade_stream.md

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

bitopro.watchTrades (symbol, since?, limit?, params?)

watchMyTrades{docsify-ignore}

watches information on multiple trades made by the user

Kind: instance method of bitopro
Returns: Array<object> - a list of trade structures

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/ws/private/matches_stream.md

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 trades for
limit	int	No	the maximum number of trade structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

bitopro.watchMyTrades (symbol, since?, limit?, params?)

watchTicker{docsify-ignore}

watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market

Kind: instance method of bitopro
Returns: object - a ticker structure

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/ws/public/ticker_stream.md

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

bitopro.watchTicker (symbol, params?)

watchBalance{docsify-ignore}

watch balance and get the amount of funds available for trading or funds locked in orders

Kind: instance method of bitopro
Returns: object - a balance structure

See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/ws/private/user_balance_stream.md

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

bitopro.watchBalance (params?)