HuoBi Trading Framwork(python)
Project description
火币API的Python版
- websocket封装成
HBWebsocket
类,用run
开启连接线程 HBWebsocket
通过注册Handler
的方式来处理数据,消息通过pub_msg
来分发到个各topic
下的Handler
线程来处理- 火币的鉴权WS是与普通WS独立的,所以同时使用需要开启两个WS
- restful api基本参照火币网的demo封装成
HBRestAPI
类 - 兼容win,mac,linux,python版本必须3.6或以上,因为使用了大量的f***
- 目前已经稳定使用,后续会基于框架提供如行情持久化,交易数据持久化等
handler
- 暂时先不维护
Restful API-Decoration
版,所以火币API8月份之后的修改将会导致其失效,有需求的小伙伴可以issues一波,再考虑去维护吧! - 有疑问或者需要支持和交流的小伙伴可以联系我, QQ:137150224
Notice
- 该封装的函数命名跟火币本身的请求命名表达不太一致
- 包含open, close, high, low的数据命名是kline(其中部分有ask和bid,都纳入这类命名)
- 当且仅当数据只有一条逐笔tick(没有ohlc),命名是ticker
- 深度数据则命名为depth
Lastest
- WS中的addr参数为了配合现在的鉴权WS,变成了host参数,之前需要用
addr=wss://api.huobi.br.com/ws
的,现在用host=api.huobi.br.com
- 新增了WS接口的after_open装饰器(鉴权ws是after_auth),用于回调WS连接成功后的函数
- 修改了部分命名
- 目前鉴权WS与普通行情WS已经分开两模块,通过统一工厂函数HBWebsocket调用(auth参数)
- 新增同一个handler被注册进多个ws的支持,解决开多个ws的冲突问题
1. Installation
pip install huobitrade
2. Usage
- 实现长连订阅策略最核心的部分是实现handler里面的handle函数
- 通过
HBWebsocket
实例的sub
开头的函数订阅需要的topic - 通过继承
BaseHandler
的实例的初始化或者add_topic
来增加对相关topic,实现handl
e函数来处理相关topic的消息 - 通过
HBWebsocket
实例的register_handler
来注册handler
handler
初始化中有个latest
,建议使用depth或者ticker数据来做处理,且策略性能不高的时候使用它
- 通过
- 基于websocket的接口都是用异步回调的方式来处理
- 首先需要用
HBWebsocket
的装饰器register_onRsp
来绑定实现一个处理相关的topic消息的函数 - 再用
req
开头的函数来请求相关topic数据,回调的数据将会交给回调函数处理
- 首先需要用
- 交易相关的都是用的restful api(因为火币还没推出websocket的交易接口)
setKey
是必要的,如果需要用到交易相关请求的话,只是请求行情的话可以不设。HBRestAPI
是单例类,所以多次初始化也木有啥大问题,如在handler里面初始化- 每个请求都有一个
_async
参数来提供异步请求,建议尽量使用它,具体用法是先初始化数个请求到一个list,再用async_request
一次性向服务器发起请求 - 子账户体系因为刚出,没用过,可能会有问题,有bug欢迎pr
- 另外还提供了几个简单易用的封装类
HBMarket
,HBAccount
,HBMargin
分别是行情,账户和借贷账户类,里面提供了大部分属性调用请求,均基于HBRestAPI
- 一般情景下应该是可以替代HBRestAPI的使用的
- 最后还提供了数个运营管理的工具
- 微信推送handler,可以实现一些交易信息推送之类的,但是建议朋友们慎用,因为鄙人有试过一天推送几千条信息被封禁了半个月微信web端登陆的经历
rpc
模块,具体用法就不细说了,懂的应该都懂的,看下源码就知道咋用啦
- 最后的最后,其实基于这个项目,还有附带的另外一个可视化web的项目没有放出来
- 基于
flask
写的一个用于查询当日成交明细和成交分布图,很丑很简陋 - 有兴趣的小伙伴可以联系我
- 基于
2.1.1 WebSocket API
from huobitrade.service import HBWebsocket
hb = HBWebsocket() # 可以填入url参数,默认是api.huobi.br.com
@hb.after_open # 使用装饰器注册函数,当ws连接之后会调用函数,可以实现订阅之类的
def sub_depth():
hb.sub_depth('ethbtc')
hb.run() # 开启websocket进程
# --------------------------------------------
hb.sub_kline('ethbtc', '1min') # 订阅数据
@hb.register_handle_func('market.ethbtc.kline.1min') # 注册一个处理函数,最好的处理方法应该是实现一个handler
def handle(msg):
print('handle:', msg)
hb.unregister_handle_func(handle, 'market.ethbtc.kline.1min') # 释放处理函数
# --------------------------------------------
# websocket请求数据是异步请求回调,所以先注册一个回调处理函数,再请求
@hb.register_onRsp('market.btcusdt.kline.1min')
def OnRsp_print(msg):
print(msg)
hb.req_kline('btcusdt', '1min')
hb.unregister_onRsp('market.btcusdt.kline.1min') # 注销某topic的请求回调处理
2.1.2 Auth WebSocket API
from huobitrade.service import HBWebsocket
setKey('your acess_key', 'you secret_key')
hb = HBWebsocket(auth=True) # 可以填入url参数,默认是api.huobi.br.com
@hb.after_open # 会再鉴权成功通过之后自动调用
def sub_accounts():
hb.sub_accounts()
hb.run() # 开启websocket进程
@hb.register_handle_func('accounts') # 注册一个处理函数,最好的处理方法应该是实现一个handler
def auth_handle(msg):
print('auth_handle:', msg)
2.2 Restful API
- restapi需要先用
setKey
设置密钥 - 默认交易和行情url都是https://api.huobi.br.com (调试用),实盘要用
from huobitrade import setUrl
设置url
from huobitrade.service import HBRestAPI
from huobitrade import setKey
# setUrl('', '')
setKey('your acess_key', 'you secret_key') # setKey很重要,最好在引入其他模块之前先setKey,鉴权ws和restapi的部分函数是基于密钥
api = HBRestAPI(get_acc=True) # get_acc参数默认为False,初始化不会取得账户ID,需要ID的函数无法使用.也可用api.set_acc_id('you_account_id')
print(api.get_timestamp())
api = HBRestAPI(get_acc=True) # 异步请求
klines = api.get_kline('omgeth', _async=True)
symbols = api.get_symbols(_async=True)
results = api.async_request([klines, symbols])
for r in results:
print(r)
2.3 Restful API-Decoration(Experimental)
- 用装饰器来初始化回调处理函数
from huobitrade.service import HBRestAPI_DEC
from huobitrade import setKey
setKey('your acess_key', 'you secret_key')
api_dec = HBRestAPI_DEC()
@api_dec.get_kline('ethbtc', '1min') # 装饰器初始化处理函数
def handle_func(msg):
print('handle:', msg)
handle_func() # __call__调用函数会请求并用handle_func做回调处理
2.4 Message Handler
- handler是用来处理websocket的原始返回消息的,通过继承basehandler实现handle函数以及注册进HBWebsocket相关的topic来使用
from huobitrade.handler import BaseHandler
fromm huobitrade.util import handler_profiler
class MyHandler(BaseHandler):
def __init__(self, topic, *args, **kwargs):
BaseHandler.__init__(self, 'just Thread name', topic)
@handler_profiler('profiler.csv') # 可以加上这个装饰器来测试handle函数的执行性能,加参数会输出到单独文件
def handle(self, topic, msg): # 实现handle来处理websocket推送的msg
print(topic, msg)
handler = MyHandler('market.ethbtc.kline.1min') # topic为str或者list
handler.add_topic('market.ethbtc.kline.5min') # 为handler增加处理topic(remove_topic来删除)
hb.register_handler(handler) # 通过register来把handler注册到相应的topic
- 内置实现了一个mongodb的
DBHandler
from huobitrade.handler import DBHandler
handler = DBHandler() # topic为空的话,会对所有topic的msg做处理
hb.register_handler(handler)
2.5 Latest Message Handler
- 基于handler函数根据策略复杂度和性能的的不同造成对message的处理时间不一样,可能造成快生产慢消费的情况,增加lastest参数,每次都是handle最新的message
class MyLatestHandler(BaseHandler):
def __init__(self, topic, *args, **kwargs):
BaseHandler.__init__(self, 'just Thread name', topic, latest=True)
@handler_profiler() # 可以加上这个装饰器来测试handle函数的执行性能
def handle(self, topic, msg): # 实现handle来处理websocket推送的msg
print(topic, msg)
2.6 HBData
- 使用类似topic的方式来取数据,topic的表达方式与火币有不同
from huobitrade import setKey
from huobitrade.datatype import HBMarket, HBAccount, HBMargin
setKey('acess_key', 'secret_key')
data = HBMarket() # 行情接口类
account = HBAccount() # 交易接口类
margin = HBMargin() # 借贷接口类
data.omgeth
# <Symbol:omgeth-{'base-currency': 'omg', 'quote-currency': 'eth', 'price-precision': 6, 'amount-precision': 4, 'symbol-partition': 'main'}>
data.omgeth.kline
# <<class 'huobitrade.datatype.HBKline'> for omgeth>
data.omgeth.depth
# <<class 'huobitrade.datatype.HBDepth'> for omgeth>
data.omgeth.ticker
# <<class 'huobitrade.datatype.HBTicker'> for omgeth>
data.omgeth.kline._1min_200 # period前面加'_', 后面加数量最大值为2000
data.omgeth.kline.last
data.omgeth.kline.last_24_hour
data.omgeth.depth.step0 # step0,1,2,3,4,5
data.omgeth.ticker.last # 最新的一条tick
data.omgeth.ticker.last_20 # last_1至last_2000
data.all_24h_kline # 当前所有交易对的ticker
account.Detail # 所有账户明细
account.Pro_XXXXX_balance # XXXX为account_id,某账户的结余
account.Pro_XXXXX_balance.update() # 更新账户结余信息
account.Pro_XXXXX_order # 某账户的订单类
account.Pro_XXXXX_order['order_id'] # 查询某order明细,或者用get方法
account.Pro_XXXXX_order.send(1, 'omgeth', 'buy-limit', 0.001666) # 发送订单
account.Pro_XXXXX_trade.get_by_id('order_id') # 某账户的成交类(即火币的matchresults),也可以直接索引
margin.transferIn('ethusdt', 'eth', 1)
ethusdt_margin_info = margin['ethusdt'] # 或者用getBalance
ethusdt_margin_info.balance # ethusdt交易对的保证金结余信息
3. Extra
- 交易策略运营相关的模块,
wechat推送
,rpc远程订阅调用
等 详见extra
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
huobitrade-0.4.6.tar.gz
(24.5 kB
view details)
Built Distribution
File details
Details for the file huobitrade-0.4.6.tar.gz
.
File metadata
- Download URL: huobitrade-0.4.6.tar.gz
- Upload date:
- Size: 24.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.6.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a80b16a5397f80c423fa03cfd8b354f5cab428419985f9d845519b56a1d9c82e |
|
MD5 | 667afd29816e206606fd6ef74a705741 |
|
BLAKE2b-256 | 1d1d2ae5da5ebba6251608b96ccda3e1746ede135186afccfbe5d3cc973a2aa8 |
File details
Details for the file huobitrade-0.4.6-py3-none-any.whl
.
File metadata
- Download URL: huobitrade-0.4.6-py3-none-any.whl
- Upload date:
- Size: 27.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.6.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76a4fa4ffc294c3f8544b218630e586f031b3cbee78df8e4f84a9e8c0d587187 |
|
MD5 | 14e477107107951eabece8996b4b18c1 |
|
BLAKE2b-256 | 71d2b688bdfea5ed13bc1394afc5bf7beba2753bf780726cbeff5a3893c3e3b4 |