# Welcome to TruBit-Python

An official Python implementation of the lastest Open API for Broker.

## Install

```bash
pip install broker-trade-client
```

or download from github

Note: pip install may be fail. We are working on fix this. if so, just download from github

## Usage

#### REST API

Init broker client:

```python
b = BrokerClient(entry_point='', api_key='', secret='')
```

Init broker options client:

```python
b = BrokerOptionClient(entry_point='', api_key='', secret='')
```

Init broker contract client:

```python
b = BrokerContractClient(entry_point='', api_key='', secret='')
```

Request with proxies:

```python
proxies = {
  "http": "http://ip:port",
  "https": "http://ip:port",
}

b = BrokerClient(entry_point='', api_key='', secret='', proxies=proxies)
```

#### Web Socket

**Init**

Init broker websocket client:

```python
client = BrokerWss(entry_point='', rest_entry_point='', api_key='', secret='')
```

**Subscribe**

Subscribe trades:

```python
client.subscribe_to_trades(symbol='BTCUSDT', callback=handler)
```

Subscribe Kline/Candlestick:

```python
client.subscribe_to_kline(symbol='BTCUSDT', interval='5m', callback=handler)
```

Subscribe market tickers:

```python
client.subscribe_to_realtimes(symbol='BTCUSDT,ETHUSDT', callback=handler)
```

Subscribe book depth tickers:

```python
client.subscribe_to_depth(symbol='BTCUSDT', callback=handler)
```

Subscribe user data:

```python
client.user_data_stream(callback=handler)
```

**Start**

Start websocket thread

```python
client.start()
```

## API List

### Public API

#### ping

```python
b.ping()
```

#### time

```python
b.time()
```

#### broker info

```python
b.broker_info()
```

#### depth

```python
b.depth('BTCUSDT')
```

#### trades

```python
b.trades('BTCUSDT')
```

#### klines

```python
b.klines('BTCUSDT')
```

#### ticker 24hr

```python
b.ticker_24hr('BTCUSDT')
```

### Private API

#### new order

```python
 b.order_new(symbol='BTCUSDT', side='BUY', type='LIMIT', quantity='0.01', price='1000', timeInForce='GTC')
```

#### get order

```python
b.order_get(order_id='')
```

#### cancel order

```python
b.order_cancel(order_id='')
```

#### open orders

```python
b.open_orders()
```

#### history orders

```python
b.history_orders()
```

#### account

```python
b.account()
```

#### my trades

```python
b.my_trades()
```

#### deposit orders

```python
b.deposit_orders()
```

## Examples

* [examples.py](https://github.com/Galactic-Tech/GitBook/blob/main/Other/examples/examples.py)
* [option-examples.py](https://github.com/Galactic-Tech/GitBook/blob/main/Other/examples/option-examples.py)
* [contract-examples.py](https://github.com/Galactic-Tech/GitBook/blob/main/Other/examples/contract-examples.py)
* [ws-examples.py](https://github.com/Galactic-Tech/GitBook/blob/main/Other/examples/ws-examples.py)