python-bitrue

A package to communicate with the Bitrue API

Welcome to python-bitrue 0.0.2

Note

This is an unofficial Python wrapper for the Bitrue exchange REST API v1. I am in no way affiliated with Bitrue, use at your own risk.

If you came here looking for the Bitrue exchange to purchase cryptocurrencies, then go here. If you want to automate interactions with Bitrue stick around.

Source code https://github.com/sammchardy/python-bitrue

Documentation https://python-bitrue.readthedocs.io/en/latest/ (pending release)

Features

• Implementation of all General, Market Data and Account endpoints.
• Simple handling of authentication
• No need to generate timestamps yourself, the wrapper does it for you
• Response exception handling

Quick Start

Register an account with Bitrue

Generate an API Keyand assign relevant permissions.

Automatic Method

.. code:: bash (PyPi)

pip install bitrue-python  *OFFICIALLY RELEASED - https://pypi.org/project/bitrue-python/

Manual Method

 Download zip
 Unzip
 Place package (folder 'python-bitrue') in 'site-packages' directory or preferred location
   ('Python Install Folder ' \Lib\site-packages)
 open command prompt
 Navigate to above folder.
 pip install -e python-bitrue
 
 Linux
 python3 -m venv bitruevenv
 source bitruevenv/bin/activate
 git clone https://github.com/snub-fighter/python-bitrue.git
 cd bitrue
 apt-get install python3-dev
 python3 -m pip install -r requirements.txt

.. code:: python

from bitrue.client import Client
api_key=''
api_secret=''
client = Client(api_key, api_secret)

# get market depth
depth = client.get_order_book(symbol='BNBBTC')

# place a test market buy order, to place an actual order use the create_order function
order = client.create_order(
    symbol='XRPUSDT',
    side=Client.SIDE_BUY,
    type=Client.ORDER_TYPE_MARKET,
    quantity=100)

# get all symbol prices
prices = client.get_all_tickers()

# withdraw 1000 XRP
# check docs for assumptions around withdrawals
from bitrue.exceptions import BitrueAPIException, BitrueWithdrawException
try:
    result = client.withdraw(
        asset='ETH',
        address='<eth_address>',
        amount=100)
except BitrueAPIException as e:
    print(e)
except BitrueWithdrawException as e:
    print(e)
else:
    print("Success")

# fetch list of withdrawals
withdraws = client.get_withdraw_history()

# fetch list of ETH withdrawals
eth_withdraws = client.get_withdraw_history(asset='ETH')

# get a deposit address for BTC
address = client.get_deposit_address(asset='BTC')

# Fetch balance of asset, create a sell order - subsequently cancel sell order using orderId
asset = test.get_asset_balance(asset='XRP')
asset_free = asset['free']
order = test.create_order(symbol='XRPUSDT',
                        side=Client.SIDE_SELL,
                        type=Client.ORDER_TYPE_LIMIT,
                        quantity=int(float(asset_free)),
                         price=4.01)
print(order)
orderId = order['orderId']
print('Order ID: ',orderId, 'sleeping for 10')
time.sleep(10)
pprint(test.cancel_order(symbol='XRPUSDT', orderId=orderId))

#check for open orders and format data for easy reading.
try:
    open = test.get_open_orders(symbol='CSCXRP',orderId=orderId) #,orderId=orderId
    filled = open[0]['executedQty']
    total = open[0]['origQty']
    print('Order status: ', float(filled), 'of',float(total))
except:
    print('no orders open')
    
    
try: # Better formatting using tabulate
    open_orders = client.get_open_orders(symbol='XRPUSDT')
    order_formatted = client._order_format_print(open_orders, orient='h')
    print(order_formatted)
except:
    print('no orders open')
    
    Output Below
    
    symbol      orderId  clientOrderId      price    origQty ...  type    side    stopPrice   ... 
    --------  ---------  ---------------  -------  --------- ...  ------  ------  ----------- ...
    XRPUSDT    53289178                         2     250    ...  LIMIT   SELL                ... 
    XRPUSDT    53289160                         2     127.5  ...  LIMIT   SELL                ... 

Coil

Coil is enabled by default in this package so that if you use it a healdess browser will attempt to load ONLY if you have the coil extension installed on that browser. It will attempt firefox by default as it is the most stable. If you do not have the extension installed on firefox nothing happens. Either way this should be completely transparent to you. I have put a lot of effort into getting the package itself and coil to function seemlessly. If you wish to disable it you can either turn the coil_enabled=True flag to False when calling the client.Client class or statically disable it inside client.Client under the init function.

Example Setup (default)

if __name__ == '__main__':
client = Client(api_key='2f0982022fc09377f43bc1da4bcb6c2219778ffe256cb96d0e966362908f0d51',
                api_secret='8ec2561b0b457b6b1695f4bc6e95eb11663723fe510e39baed92998187075150',
                coil_enabled=True, headless=True, browser='firefox')

Donate

If this library helped you out feel free to donate.

• SIGN UP FOR COIL AND ADD EXTENSION TO FIREFOX -> coil.com
• ETH: 0xd6933c5199Aa7Ac295dEff154a6AaF3342F43C90
• XRP: rsCJ7ZKeXKacVSsiBZUZqgKxteradBUEuR
• BTC: 1Dknp6L6oRZrHDECRedihPzx2sSfmvEBys
• BNB: bnb136ns6lfw4zs5hg4n85vdthaad7hq5m4gtkgf23 Memo: 103712985

Special Thanks

Sam McHardy (sammchardy) - Who did a lot of work on python-binance which I forked and converted to use it for Bitrue .