Skip to content

Update client.py #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
neal8891214 wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update client.py #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e325345
Update client.py
neal8891214 May 16, 2019
3aa2778
pyhton_SDK with new gateway
neal8891214 May 21, 2019
09bb049
update README.md
NealBincentive Oct 31, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
171 changes: 9 additions & 162 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,179 +25,26 @@ exception if no response is received in the specified seconds.
## Bincentive Client Methods
Bincentive Trader Client

**Kind**: global class
<a name="BincentiveClient+set_position"></a>

* [BincentiveClient](#BincentiveClient)

* [.get_strategy_list(timeout=None)](#BincentiveClient+get_strategy_list)
* [.get_exchange_list(timeout=None)](#BincentiveClient+get_exchange_list)
* [.add_market_order(strategy_id, exchange_id, base_currency, quote_currency, side, amount, leverage=None, timeout=None)](#BincentiveClient+add_market_order)
* [.get_history_list(strategy_id, begin_time, end_time, account_type='real', timeout=None)](#BincentiveClient+get_history_list)
* [.add_api_key(api_key, api_secret_key, exchange_id, timeout=None)](#BincentiveClient+add_api_key)
* [.get_api_key_list(timeout=None)](#BincentiveClient+get_api_key_list)
* [.delete_api_key(exchange_id, timeout=None)](#BincentiveClient+delete_api_key)
* [.get_account_asset(self, strategy_id, account_type='virtual', timeout=None)](#BincentiveClient+get_account_asset)
* [.get_exchange_symbol_list(self, exchange_id, timeout=None)](#BincentiveClient+get_exchange_symbol_list)
* [.get_currency_list(self, timeout=None)](#BincentiveClient+get_currency_list)


<a name="new_BincentiveClient_new"></a>

<a name="BincentiveClient+get_strategy_list"></a>

### bincentiveClient.get_strategy_list(timeout=None)
Gets the list of strategies

**Kind**: instance method of [<code>BincentiveClient</code>](#BincentiveClient)


<a name="BincentiveClient+get_exchange_list"></a>

### bincentiveClient.get_exchange_list(timeout=None)
Gets the list of exchanges

**Kind**: instance method of [<code>BincentiveClient</code>](#BincentiveClient)

<a name="BincentiveClient+add_market_order"></a>

### bincentiveClient.add_market_order(strategy_id, exchange_id, base_currency, quote_currency, side, amount, leverage=None, timeout=None)
Adds an order for a specific strategy

**Kind**: instance method of [<code>BincentiveClient</code>](#BincentiveClient)

| Param | Type |
| --- | --- |
| strategy_id | <code>number</code> |
| exchange_id | <code>number</code> |
| base_currency | <code>string</code> |
| quote_currency | <code>string</code> |
| side | <code>string</code> |
| amount | <code>number</code> |
| leverage | <code>number</code> |


<a name="BincentiveClient+get_history_list"></a>

### bincentiveClient.get_history_list(strategy_id, begin_time, end_time, account_type='real')
Gets the historical data of all transactions

**Kind**: instance method of [<code>BincentiveClient</code>](#BincentiveClient)

| Param | Type |
| --- | --- |
| strategy_id | <code>number</code> |
| begin_time | <code>datetime</code> |
| end_time | <code>datetime</code> |
| account_type | <code>string</code> |

account_type description:
- 'virtual' means signal send to bincentive
- 'real' means order send to exchange

sample code

```python
import pytz
from datetime import datetime
us = pytz.timezone('US/Pacific')
begin = datetime(2019, 1, 1, 6, 0, 0).replace(tzinfo=us)
end = datetime.now().replace(tzinfo=us)
strategy_id = 100342
history = client.get_history_list(strategy_id, begin, end)

```

<a name="BincentiveClient+add_api_key"></a>

### bincentiveClient.add_api_key(api_key, api_secret_key, exchange_id, timeout=None)
Adds all the keys of each transaction

**Kind**: instance method of [<code>BincentiveClient</code>](#BincentiveClient)

| Param | Type |
| --- | --- |
| api_key | <code>string</code> |
| api_secret_key | <code>string</code> |
| exchange_id | <code>number</code> |


<a name="BincentiveClient+get_api_key_list"></a>

### bincentiveClient.get_api_key_list(timeout=None)
Gets API key list

**Kind**: instance method of [<code>BincentiveClient</code>](#BincentiveClient)

<a name="BincentiveClient+delete_api_key"></a>

### bincentiveClient.delete_api_key(exchange_id, timeout=None)
Deletes all the keys of a transaction

**Kind**: instance method of [<code>BincentiveClient</code>](#BincentiveClient)

| Param | Type |
| --- | --- |
| exchangeId | <code>number</code> |


<a name="BincentiveClient+get_account_asset"></a>

### bincentiveClient.get_account_asset(self, strategy_id, account_type='virtual', timeout=None)
Gets the historical data of account asset
### bincentiveClient.set_position(self, strategy_id, Ratio, LimitPrice, timeout=None)
Set a position ratio for a specific strategy to send the order

**Kind**: instance method of [<code>BincentiveClient</code>](#BincentiveClient)

| Param | Type |
| --- | --- |
| strategy_id | <code>number</code> |
| account_type | <code>string</code> |

account_type description:
- 'virtual' means signal send to bincentive
- 'real' means order send to exchange
| Ratio | <code>number</code> |
| LimitPrice | <code>number</code> |

sample code

```python
strategy_id = 100342
account_asset = client.get_account_asset(strategy_id)

```

stgy_id = your_strategy_id
r = 0.3

<a name="BincentiveClient+get_exchange_symbol_list"></a>

### bincentiveClient.get_exchange_symbol_list(self, exchange_id, timeout=None)
Gets all symbol of the exchange

**Kind**: instance method of [<code>BincentiveClient</code>](#BincentiveClient)

| Param | Type |
| --- | --- |
| exchange_id | <code>number</code> |


sample code

```python
exchange_id = 3
exchange_symbol = client.get_exchange_symbol_list(exchange_id)

```

<a name="BincentiveClient+get_currency_list"></a>

### bincentiveClient.get_currency_list(self, timeout=None)
Gets the currency_id corresponding currency_name

**Kind**: instance method of [<code>BincentiveClient</code>](#BincentiveClient)


sample code

```python

currency_list = client.get_currency_list()

```
order_id = client.set_position(strategy_id=stgy_id, Ratio=r, LimitPrice=1)

```
Loading