## bit2c{docsify-ignore} **Kind**: global class **Extends**: Exchange * [fetchBalance](#fetchbalance) * [fetchOrderBook](#fetchorderbook) * [fetchTicker](#fetchticker) * [fetchTrades](#fetchtrades) * [fetchTradingFees](#fetchtradingfees) * [createOrder](#createorder) * [cancelOrder](#cancelorder) * [fetchOpenOrders](#fetchopenorders) * [fetchOrder](#fetchorder) * [fetchMyTrades](#fetchmytrades) * [fetchDepositAddress](#fetchdepositaddress) ### fetchBalance{docsify-ignore} query for balance and get the amount of funds available for trading or funds locked in orders **Kind**: instance method of [bit2c](#bit2c) **Returns**: object - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure) **See**: https://bit2c.co.il/home/api#balance | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript bit2c.fetchBalance ([params]) ``` ### fetchOrderBook{docsify-ignore} fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [bit2c](#bit2c) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See**: https://bit2c.co.il/home/api#orderb | 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 bit2c.fetchOrderBook (symbol[, limit, 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 [bit2c](#bit2c) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://bit2c.co.il/home/api#ticker | 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 bit2c.fetchTicker (symbol[, params]) ``` ### fetchTrades{docsify-ignore} get the list of most recent trades for a particular symbol **Kind**: instance method of [bit2c](#bit2c) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See** - https://bit2c.co.il/home/api#transactions - https://bit2c.co.il/home/api#trades | 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 bit2c.fetchTrades (symbol[, since, limit, params]) ``` ### fetchTradingFees{docsify-ignore} fetch the trading fees for multiple markets **Kind**: instance method of [bit2c](#bit2c) **Returns**: object - a dictionary of [fee structures](https://docs.ccxt.com/#/?id=fee-structure) indexed by market symbols **See**: https://bit2c.co.il/home/api#balance | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript bit2c.fetchTradingFees ([params]) ``` ### createOrder{docsify-ignore} create a trade order **Kind**: instance method of [bit2c](#bit2c) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://bit2c.co.il/home/api#addo | 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 bit2c.createOrder (symbol, type, side, amount[, price, params]) ``` ### cancelOrder{docsify-ignore} cancels an open order **Kind**: instance method of [bit2c](#bit2c) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://bit2c.co.il/home/api#cancelo | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | order id | | symbol | string | Yes | Not used by bit2c cancelOrder () | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript bit2c.cancelOrder (id, symbol[, params]) ``` ### fetchOpenOrders{docsify-ignore} fetch all unfilled currently open orders **Kind**: instance method of [bit2c](#bit2c) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://bit2c.co.il/home/api#geto | 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 | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript bit2c.fetchOpenOrders (symbol[, since, limit, params]) ``` ### fetchOrder{docsify-ignore} fetches information on an order made by the user **Kind**: instance method of [bit2c](#bit2c) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://bit2c.co.il/home/api#getoid | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | the order id | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript bit2c.fetchOrder (id, symbol[, params]) ``` ### fetchMyTrades{docsify-ignore} fetch all trades made by the user **Kind**: instance method of [bit2c](#bit2c) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure) **See**: https://bit2c.co.il/home/api#orderh | 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 | ```javascript bit2c.fetchMyTrades (symbol[, since, limit, params]) ``` ### fetchDepositAddress{docsify-ignore} fetch the deposit address for a currency associated with this account **Kind**: instance method of [bit2c](#bit2c) **Returns**: object - an [address structure](https://docs.ccxt.com/#/?id=address-structure) **See**: https://bit2c.co.il/home/api#addc | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript bit2c.fetchDepositAddress (code[, params]) ```