Welcome to Broker-Python
An official Python implementation of the lastest Open API for Broker.
Install
pip install bhex
or download from github
Usage
REST API
Init broker client:
b = BrokerClient(entry_point='', api_key='', secret='')
Init broker options client:
b = BrokerOptionClient(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
1 maintainer
Metadata
1 maintainer
Release files for bhex 2.0.14
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| bhex-2.0.14.tar.gz | 8.4 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| bhex-2.0.14-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 30.6 kB
Release files / bhex-2.0.14.tar.gz
| Download URL | bhex-2.0.14.tar.gz |
|---|---|
| Size | 8.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1873e77d8cc037e173cf20f4b69e47505ae57137158bbd4fad077015fc7df22a
|
|
BLAKE2b-256 checksum How to use checksums |
2c4268f83ddaa95942ea497a3fd640def5e16154059abe9521e55e7ee237962c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4
|
Release files / bhex-2.0.14-py3-none-any.whl
| Download URL | bhex-2.0.14-py3-none-any.whl |
|---|---|
| Size | 22.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2038cbfdc3df776102acd5e2ac6b169161915dfbc83ca3a528eac322b19939ab
|
|
BLAKE2b-256 checksum How to use checksums |
9863dc7f1ab5f63c94ed8c792ef35c8c096a1ca17bd4e0443077f6796b2f00dc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4
|
Security for bhex 2.0.14
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
