Python SDK for Broker REST And Websocket API
Project description
Welcome to Broker-Python
An official Python implementation of the lastest Open API for Broker.
Install
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:
b = BrokerClient(entry_point='', api_key='', secret='')
Init broker v3 client:
b = BrokerV3Client(entry_point='', api_key='', secret='')
Init broker contract client:
b = BrokerContractClient(entry_point='', api_key='', secret='')
Request with proxies:
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:
client = BrokerWss(entry_point='', rest_entry_point='', api_key='', secret='')
Subscribe
Subscribe trades:
client.subscribe_to_trades(symbol='BTCUSDT', callback=handler)
Subscribe Kline/Candlestick:
client.subscribe_to_kline(symbol='BTCUSDT', interval='5m', callback=handler)
Subscribe market tickers:
client.subscribe_to_realtimes(symbol='BTCUSDT,ETHUSDT', callback=handler)
Subscribe book depth tickers:
client.subscribe_to_depth(symbol='BTCUSDT', callback=handler)
Subscribe user data:
client.user_data_stream(callback=handler)
Start
Start websocket thread
client.start()
API List
Public API
ping
b.ping()
time
b.time()
broker info
b.broker_info()
depth
b.depth('BTCUSDT')
trades
b.trades('BTCUSDT')
klines
b.klines('BTCUSDT')
ticker 24hr
b.ticker_24hr('BTCUSDT')
Private API
new order
b.order_new(symbol='BTCUSDT', side='BUY', type='LIMIT', quantity='0.01', price='1000', timeInForce='GTC')
get order
b.order_get(order_id='')
cancel order
b.order_cancel(order_id='')
open orders
b.open_orders()
history orders
b.history_orders()
account
b.account()
my trades
b.my_trades()
deposit orders
b.deposit_orders()
Examples
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for broker-trade-client-3.0.0b2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d8b2e14813bbd922477fa3518999e069ddff444494d95a4d9ed8c5694a6ca64 |
|
MD5 | df606793d6156ffe540e84dd31d56238 |
|
BLAKE2b-256 | 6a21659e93febc4dbaf078b8655a5c5646fd89ae56f937b4a88686fe3efbdd60 |
Close
Hashes for broker_trade_client-3.0.0b2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e33ce7f63ba85b555f627fe6bfa1f670bed25269a630f5431b0706f000ca7ba |
|
MD5 | ab51132b7158959600f40cda277449fa |
|
BLAKE2b-256 | 85c8d9fd6d563d0231bab37dd497d4f6118d447c3b4bfa91aafcb296bb113d89 |