Skip to main content

huobi_api for python

Project description

火币API的Python版

  • websocket封装成HBWebsocket类,用run开启连接线程
  • HBWebsocket通过注册Handler的方式来处理数据,消息通过pub_msg来分发到个各topic下的Handler线程来处理
  • restful api基本参照火币网的demo封装成HBRestAPI
  • 没有test和debug,估计含有巨量的BUG,慎用!

Lastest

  • 加入了restapi的异步并发请求

PyPI build license PyPI - Python Version

Installation

pip install huobitrade

Usage

WebSocket API

from huobitrade.service import HBWebsocket

hb = HBWebsocket()  # 可以填入url参数,默认是https://api.huobi.br.com
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')  # 释放处理函数

Restful API

  • restapi需要先用setKey设置密钥
  • 默认交易和行情url都是https://api.huobi.br.com (调试用),实盘要设置url用from huobitrade import setUrl
from huobitrade.service import HBRestAPI
from huobitrade import setKey

setKey('your acess_key', 'you secret_key')
api = HBRestAPI()  # 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)

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做回调处理

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  #  可以加上这个装饰器来测试handle函数的执行性能
    def handle(self, msg):  # 实现handle来处理websocket推送的msg
        print(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)

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, msg):  # 实现handle来处理websocket推送的msg
        print(msg)

HBData

  • 使用类似topic的方式来取数据,topic的表达方式与火币有不同
from huobitrade import setKey
from huobitrade.datatype import HBData
setKey('acess_key', 'secret_key')
data = HBData()

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前面加'_', 后面加数量最大值为1000
data.omgeth.kline.latest
data.omgeth.kline.last_24_hour
data.omgeth.depth.step0  # step0,1,2,3,4,5
data.omgeth.ticker.latest  # 最新的一条tick
data.omgeth.ticker.last_20  # last_1至last_2000

Extra

  • 交易策略运营相关的模块 详见extra

Project details


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.2.6.tar.gz (14.9 kB view details)

Uploaded Source

Built Distribution

huobitrade-0.2.6-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

Details for the file huobitrade-0.2.6.tar.gz.

File metadata

  • Download URL: huobitrade-0.2.6.tar.gz
  • Upload date:
  • Size: 14.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for huobitrade-0.2.6.tar.gz
Algorithm Hash digest
SHA256 21ce9237596256f549555d5bd03025af0f47acd9572a439b8d328f9422ad992c
MD5 5dd4d057aa28fb973eadba58bf14506d
BLAKE2b-256 7d87d3a1bdf9f84cf141f6308840777bab7156b966500015874f8199bce54cca

See more details on using hashes here.

File details

Details for the file huobitrade-0.2.6-py3-none-any.whl.

File metadata

File hashes

Hashes for huobitrade-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 9b6f72b817453465bcc7cf4506512bde3302d10d3b00dcaa19938dcab7ebcbeb
MD5 ccef23901f77818762726a8db3cb5cdf
BLAKE2b-256 3b21aa887707c195effb8686fce06e50c5357aa580235465d7e01b42125892c4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page