数字货币-python策略API文档

快速上手

策略逻辑简介

功夫系统上的策略在策略连接行情交易柜台，发送订阅请求以后，通过以下回调函数给用户发送消息， 用户在不同的回调函数中调用功能函数实现获取行情，下单，时间回调等逻辑。详细数据定义和接口函数定义可查看后文，以下为一个策略示例

注意 ： 策略应和功夫安装目录在一个盘符下面，策略文件路径最好不要有空格 注意 : 在运行策略之前一定要看下启动的账户柜台进程(td)和行情源柜台进程(md)是否与策略中填写的柜台ID一致

import kungfu.yijinjing.time as kft
from kungfu.wingchun.constants import *
from pykungfu import wingchun as wc

source = "okx"
account = "test"
tickers = ["BTC-USDT", "LTC-USDT"]  # 现货
tickers_COINF = ["BTC-USD-240628"]  # 币本位-USD-
tickers_UF = ["LTC-USDT-SWAP"]      # U本位-USDT-

# 订阅标的所属市场：
# 现货：Exchange.OKX_SPOT
# U本位市场：Exchange.OKX_USD_FUTURE，何种合约属于U本位市场，symbol中含有-USDT-的标的，例如：BTC-USD-240628
# 币本位市场：Exchange.OKX_COIN_FUTURE，何种合约属于币本位市场，symbol中含有-USD-的标的，例如：LTC-USDT-SWAP

EXCHANGE_SPOT = Exchange.OKX_SPOT
EXCHANGE_UF = Exchange.OKX_USD_FUTURE
EXCHANGE_CoinF = Exchange.OKX_COIN_FUTURE


# 启动前回调，添加交易账户，订阅行情，策略初始化计算等
def pre_start(context):
    context.log.info("pre_start {}".format(context.now()))

    # 添加交易账户：source 交易账户柜台名，account 交易账户名
    context.add_account(source, account)
    # 添加行情柜台：参数1： 行情柜台名， 参数2： 订阅标的列表， 参数3：标的所属市场
    context.subscribe(source, tickers, EXCHANGE_SPOT)
    context.subscribe(source, tickers_UF, EXCHANGE_UF)
    context.subscribe(source, tickers_COINF, EXCHANGE_CoinF)


# 启动准备工作完成后回调，策略只能在本函数回调以后才能进行获取持仓和报单
def post_start(context):
    context.log.info("post_start {}".format(context.now()))

# 收到快照行情时回调，行情信息通过quote对象获取
def on_quote(context, quote, location, dest):
    context.log.info('[on_quote] {}'.format(quote))

    order_id = context.insert_order(quote.instrument_id, EXCHANGE_SPOT, source, account, quote.last_price, 1,
                                PriceType.Limit, Side.Buy, Offset.Open)

    context.log.info("ticker insert order instrument_id: {},order_id: {}".format(quote.instrument_id, order_id))

def on_transaction(context, transaction, location,dest):
    context.log.info('[on_transaction] {}'.format(transaction))


def on_tick(context, tick, location,dest):
    context.log.info('[on_tick] {}'.format(tick))


def on_funding_rate(context, funding_rate, location,dest):
    context.log.info('[on_funding_rate] {}'.format( funding_rate))


def on_order(context, order, location,dest):
    context.log.info('[on_order] {}, {}, {}'.format( order.order_id, order.status, order.volume))


def on_trade(context, trade, location,dest):
    context.log.info('[on_trade] {}, {}, {}'.format(trade.order_id, trade.volume, trade.price))

函数定义

基本方法

pre_start

启动前调用函数，在策略启动前调用，用于完成添加交易账户，订阅行情，策略初始化计算等

参数

参数	类型	说明
context	python对象	策略的全局变量，通过点标记（”.”）来获取其属性。

返回

返回	类型	说明
无	无	无

范例:

def pre_start(context):
    # 添加柜台id,账户
    context.add_account(source, account)
    # 订阅行情
    context.subscribe(source, tickers, exchange)

post_start

启动后调用函数，策略连接上行情交易柜台后调用，本函数回调后，策略可以执行添加时间回调、获取策略持仓、报单等操作

参数

参数	类型	说明
context	python对象	策略的全局变量，通过点标记（”.”）来获取其属性。

返回

返回	类型	说明
无	无	无

范例:

def post_start(context):
    context.log.info("[post_start] {}".format("post_start"))

pre_stop

策略退出前方法 (当关闭策略的时候,策略退出之前调用这个方法)

参数

参数	类型	说明
context	python对象	策略的全局变量，通过点标记（”.”）来获取其属性。

返回

返回	类型	说明
无	无	无

范例:

# 退出前函数
def pre_stop(context):
    context.log.info("strategy will stop")

post_stop

进程退出前方法 (当关闭策略的时候,策略进程退出之前调用这个方法)

参数

参数	类型	说明
context	python对象	策略的全局变量，通过点标记（”.”）来获取其属性。

返回

返回	类型	说明
无	无	无

范例:

# 退出前函数
def post_stop(context):
    context.log.info("process will stop")

on_quote

行情数据的推送会自动触发该方法的调用。

参数

参数	类型	说明
context	python对象	策略的全局变量，通过点标记（”.”）来获取其属性
quote	Quote对象	行情数据
location	Location对象	数据的来源是来自哪个进程
dest	int	以16进制打印出来与location配合可以知道数据保存的journal文件名

返回

返回	类型	说明
无	无	无

范例:

def on_quote(context, quote, location, dest):
    context.log.info('[on_quote] {}, {}, {}'.format( quote.instrument_id, quote.last_price, quote.volume))

dest举例说明:

def on_quote(context, quote, location, dest):
    context.log.info("[on_quote] ----{}, {}, {}".format(location.category, location.group, location.name, hex(dest)))
# [on_quote] ---- md, okx, okx, 0x0
# location.category为: "md" , location.group为 : "okx" ,location.name为: "okx" , hex(dest)为 : 0x0
# 数据存储在kf_home(kungfu\home\runtime\ md \ okx \ okx \journal\live) 中以16进制打印dest的同名文件中: 00000000.1.journal

on_transaction

逐笔成交行情数据的推送会自动触发该方法的调用

参数

参数	类型	说明
context	python对象	策略的全局变量，通过点标记（”.”）来获取其属性
transaction	Transaction对象	逐笔成交行情数据
location	Location对象	数据的来源是来自哪个进程
dest	int	以16进制打印出来与location配合可以知道数据保存的journal文件名

返回

返回	类型	说明
无	无	无

范例:

def on_transaction(context, transaction, location, dest):
    context.log.info('[on_transaction] {}'.format(transaction))

dest举例说明:

def on_transaction(context, transaction, location, dest):
    context.log.info("[on_transaction] ----{}, {}, {}".format(location.category, location.group, location.name,hex(dest)))
# [on_transaction] ---- md, okx, okx, 0x0
# location.category为: "md" , location.group为 : "okx" ,location.name为: "okx" , hex(dest)为 : 0x0
# 数据存储在kf_home(kungfu\home\runtime\ md \ okx \ okx \journal\live) 中以16进制打印dest的同名文件中: 00000000.1.journal

on_tick

行情数据更新回调

参数

参数	类型	说明
context	python对象	策略的全局变量，通过点标记（”.”）来获取其属性
tick	Tick对象	逐笔委托行情数据
location	Location对象	数据的来源是来自哪个进程
dest	int	以16进制打印出来与location配合可以知道数据保存的journal文件名

返回

返回	类型	说明
无	无	无

范例:

def on_tick(context, tick, location,dest):
    context.log.info('[on_tick] {}'.format(tick))

dest举例说明:

def on_tick(context, tick, location, dest):
    context.log.info("[on_tick] ----{}, {}, {}".format(location.category, location.group, location.name,hex(dest)))
# [on_tick] ---- md, okx, okx, 0x0
# location.category为: "md" , location.group为 : "okx" ,location.name为: "okx" , hex(dest)为 : 0x0
# 数据存储在kf_home(kungfu\home\runtime\ md \ okx \ okx \journal\live) 中以16进制打印dest的同名文件中: 00000000.1.journal

on_funding_rate

资金费率更新回调

参数

参数	类型	说明
context	python对象	策略的全局变量，通过点标记（”.”）来获取其属性
funding_rate	FundingRate对象	逐笔委托行情数据
location	Location对象	数据的来源是来自哪个进程
dest	int	以16进制打印出来与location配合可以知道数据保存的journal文件名

返回

返回	类型	说明
无	无	无

范例:

def on_funding_rate(context, funding_rate , location,dest):
    context.log.info('[on_funding_rate] {}'.format(funding_rate))

dest举例说明:

def on_funding_rate(context, funding_rate, location, dest):
    context.log.info("[on_funding_rate] ----{}, {}, {}".format(location.category, location.group, location.name,hex(dest)))
# [on_funding_rate] ---- md, okx, okx, 0x0
# location.category为: "md" , location.group为 : "okx" ,location.name为: "okx" , hex(dest)为 : 0x0
# 数据存储在kf_home(kungfu\home\runtime\ md \ okx \ okx \journal\live) 中以16进制打印dest的同名文件中: 00000000.1.journal

on_order

订单信息的更新会自动触发该方法的调用

参数

参数	类型	说明
context	python对象	策略的全局变量，通过点标记（”.”）来获取其属性
order	Order对象	订单信息更新数据
location	Location对象	数据的来源是来自哪个进程
dest	int	以16进制打印出来与location配合可以知道数据保存的journal文件名

返回

返回	类型	说明
无	无	无

范例:

def on_order(context, order, location, dest):
    context.log.info('[on_order] {}, {}, {}'.format( order.order_id, order.status, order.volume))

dest举例说明:

def on_order(context, order, location, dest):
    context.log.info("[on_order] -----{}, {}, {}".format(location.category, location.group, location.name, hex(dest)))
# [on_order] ----td, okx, 00031075, 0x44a836d8
# location.category为: "td" , location.group为 : "okx" ,location.name为: "00031075" , hex(dest)为 : 0x44a836d8
# 数据存储在kf_home(kungfu\home\runtime\ td \ okx \ 00031075 \journal\live) 中以16进制打印dest的同名文件中 : 44a836d8.1.journal

on_trade

策略订单成交信息的更新会自动触发该方法的调用

参数

参数	类型	说明
context	python对象	策略的全局变量，通过点标记（”.”）来获取其属性
trade	Trade对象	订单成交更新数据
location	Location对象	数据的来源是来自哪个进程
dest	int	以16进制打印出来与location配合可以知道数据保存的journal文件名

返回

返回	类型	说明
无	无	无

范例:

def on_trade(context, trade, location, dest):
    context.log.info('[on_trade] {}, {}, {}'.format(trade.order_id, trade.volume, trade.price))

dest举例说明:

def on_trade(context, trade, location, dest):
    context.log.info("[on_trade] -----{}, {}, {}".format(location.category, location.group, location.name, hex(dest)))
# [on_trade] ----td, okx, 00031075, 0x44a836d8
# location.category为: "td" , location.group为 : "okx" ,location.name为: "00031075" , hex(dest)为 : 0x44a836d8
# 数据存储在kf_home(kungfu\home\runtime\ td \ okx \ 00031075 \journal\live) 中以16进制打印dest的同名文件中 : 44a836d8.1.journal

on_position_sync_reset

本地交易柜台(TD)的持仓与柜台持仓数据不一致时被调用 (60s同步一次)

注 : 系统会每60s从柜台同步一次账户持仓,并覆盖本地维护的账户持仓数据.当本地维护的账户持仓列表中任意标的数量或者昨仓信息与柜台的不一致就触发此函数

参数

参数	类型	说明
context	python对象	策略的全局变量，通过点标记（”.”）来获取其属性
old_book	book对象	本地维护持仓数据
new_book	book对象	柜台持仓数据

返回

返回	类型	说明
无	无	无

范例:

def on_position_sync_reset(context, old_book, new_book):
    positions_old_book = old_book.long_positions
    for key in positions_old_book:
        pos = positions_old_book[key]
        context.log.info("positions_old_book   (instrument_id){} (direction){} (volume){} (yesterday_volume){} ".format(
            pos.instrument_id,
            pos.direction,
            pos.volume,
            pos.yesterday_volume))

    positions_new_book = new_book.long_positions
    for key in positions_new_book:
        pos = positions_new_book[key]
        context.log.info("positions_new_book   (instrument_id){} (direction){} (volume){} (yesterday_volume){} ".format(
            pos.instrument_id,
            pos.direction,
            pos.volume,
            pos.yesterday_volume))

on_asset_sync_reset

本地维护账户资金与柜台不一致时被调用 (60s同步一次)

注 : 系统会每60s从柜台同步一次账户资金信息,并覆盖本地维护的账户资金信息.当本地维护的账户中可用资金或者保证金(期货)与柜台同步的不一致时此函数被调用

参数

参数	类型	说明
context	python对象	策略的全局变量，通过点标记（”.”）来获取其属性
old_asset	asset	本地维护资金信息
new_asset	asset	柜台资金信息

返回

返回	类型	说明
无	无	无

范例:

def on_asset_sync_reset(context, old_asset, new_asset):
    context.log.warning("on_asset_sync_reset ---- {},{}".format(old_asset.avail, new_asset.avail))

on_order_action_error

撤单报错信息触发调用

参数

参数	类型	说明
context	python对象	策略的全局变量，通过点标记（”.”）来获取其属性
error	OrderActionError对象	撤单报错信息
location	Location对象	数据的来源是来自哪个进程
dest	int	以16进制打印出来与location配合可以知道数据保存的journal文件名

返回

返回	类型	说明
无	无	无

范例:

def on_order_action_error(context, error, location, dest):
    context.log.warning("on_order_action_error {}".format(error))

dest举例说明:

def on_order_action_error(context, error, location, dest):
    context.log.info("[on_order_action_error] -----{}, {}, {}".format(location.category, location.group, location.name, hex(dest)))
# [on_order_action_error] ----td, okx, 00031075, 0x44a836d8
# location.category为: "td" , location.group为 : "okx" ,location.name为: "00031075" , hex(dest)为 : 0x44a836d8
# 数据存储在kf_home(kungfu\home\runtime\ td \ okx \ 00031075 \journal\live) 中以16进制打印dest的同名文件中 : 44a836d8.1.journal

on_deregister

交易账户(TD)进程 / 行情(MD)进程断开回调此函数

参数

参数	类型	说明
context	python对象	策略的全局变量，通过点标记（”.”）来获取其属性
deregister	Deregister对象	断开回调信息
location	Location对象	数据的来源是来自哪个进程

返回

返回	类型	说明
无	无	无

范例:

def on_deregister(context, deregister, location):
    context.log.info('[on_deregister] {}'.format(deregister))

on_broker_state_change

客户端状态变化回调

参数

参数	类型	说明
context	python对象	策略的全局变量，通过点标记（”.”）来获取其属性
broker_state_update	BrokerStateUpdate对象	客户端状态变化回调信息
location	Location对象	数据的来源是来自哪个进程

返回

返回	类型	说明
无	无	无

范例:

def on_broker_state_change(context, broker_state_update, location):
    context.log.info('[on_broker_state_change] {}'.format(broker_state_update))

on_synthetic_data

订阅的算子器发布的数据返回

参数

参数	类型	说明
context	python对象	策略的全局变量，通过点标记（”.”）来获取其属性
synthetic_data	SyntheticData对象	订阅的算子器发布的数据
location	Location对象	数据的来源是来自哪个进程
dest	int	以16进制打印出来与location配合可以知道数据保存的journal文件名

返回

返回	类型	说明
无	无	无

范例:

def on_synthetic_data(context, synthetic_data, location, dest):
    context.log.info("on_synthetic_data: {}".format(synthetic_data))

dest举例说明:

def pre_start(context):
    context.subscribe_operator("bar", "test")

def on_synthetic_data(context, synthetic_data, location, dest):
    context.log.info("[on_synthetic_data] -----{}, {}, {}".format(location.category, location.group, location.name, hex(dest)))

# [on_synthetic_data] ----operator, bar, test, 0x0
# location.category为: "operator" , location.group为 : "bar" ,location.name为: "test" , hex(dest)为 : 0x0
# 数据存储在kf_home(kungfu\home\runtime\ operator \ bar \ test \journal\live) 中以16进制打印dest的同名文件中 : 00000000.1.journal

on_operator_state_change

订阅的算子器状态变化回调

参数

参数	类型	说明
context	python对象	策略的全局变量，通过点标记（”.”）来获取其属性
operator_state_update	OperatorStateUpdate对象	订阅的其他算子器的状态信息
location	Location对象	数据的来源是来自哪个进程

返回

返回	类型	说明
无	无	无

范例:

def on_operator_state_change(context, operator_state_update, location):
    context.log.info("on_operator_state_change {}".format(operator_state_update))

行情交易函数

context.add_account

添加交易柜台，策略需要先添加账户，才能使用该账户报单

参数

参数	类型	说明
source	str	行情柜台ID
account	str	账户ID

返回

返回	类型	说明
无	无	无

范例:

# 添加柜台、账户
context.add_account(source, account)
# 例如 :
# context.add_account("", "123456")

context.subscribe

订阅行情(支持动态订阅)

参数

参数	类型	说明
source	str	行情柜台ID
instrument	list	代码列表
exchange_id	Exchange对象	交易所ID

返回

返回	类型	说明
无	无	无

范例:

# 向source柜台的exchange_id交易所订阅了instruments列表中的合约的行情
context.subscribe(source, instruments, exchange_id)

context.subscribe_operator

订阅算子器/bar数据

注意 : 注意 :算子器的 group 默认为 ‘default’ ； bar数据的 group 为 ‘bar’

参数

参数	类型	说明
group	str	组名
name	str	名字ID

返回

返回	类型	说明
无	无	无

范例:

context.subscribe_operator(group, name)
# 例如 : 订阅算子id为test的算子器
# context.subscribe_operator("default", "test")

# 例如 : 订阅Bar_id为 bar1 的bar数据
# context.subscribe_operator("bar", "bar1")

context.insert_order

报单函数

参数

参数	类型	说明
instrument_id	str	合约ID
exchange_id	str	交易所ID
source_id	str	柜台ID
account_id	str	交易账号
limit_price	float	价格
volume	int	数量
priceType	PriceType	报单类型
side	Side	买卖方向
offset	Offset	开平方向
hedgeFlag	HedgeFlag	投机套保标识 (选填)
is_swap	is_swap	互换单 (选填,默认为False)
block_id	int	大宗交易信息 （不填，默认为0）
parent_id	int	母单号 （不填，默认为0）

返回

返回	类型	说明
order_id	long	订单ID

范例

context.insert_order("BTC-USDT", Exchange.OKX_SPOT, "okx","acc_1", price, 1, PriceType.Limit, Side.Buy, Offset.Open)

context.cancel_order

撤单函数

参数

参数	类型	说明
order_id	long	订单ID

返回

返回	类型	说明
action_id	long	订单操作

范例:

# 通过context.insert_order函数进行下单，同时用order_id记录下单的订单ID号，然后撤单
order_id = context.insert_order(quote.instrument_id, exchange, source,account, quote.last_price, volume, PriceType.Limit, Side.Buy, Offset.Open)
action_id =  context.cancel_order(order_id)

投资组合相关功能

策略持仓维护相关

功夫系统支持实时维护策略收益及持仓及对应的历史记录，针对不同的应用场景，提供共计四种不同的维护收益及持仓的模式。对于任一策略，具体采用的模式由两个 API 决定：context.hold_book() 及 context.hold_positions()，使用者需要在策略的 pre_start() 方法里决定是否调用这两个方法，系统在 pre_start() 处理完成时会根据是否调用这两个方法对应出的共计四种状态来设置维护收益及持仓的结果。

context.hold_book()

保持策略运行历史上的交易过的标的。缺省设置即没有调用此方法时，系统只会维护当前策略代码中通过 subscribe 方法订阅过的标的；当调用此方法后，系统会在策略启动后，根据该同名策略在历史上的交易情况，构造一份包含所有该同名策略所交易过标的，及当前策略代码中通过 subscribe 订阅的标的的账目。注意此方法仅影响标的列表，对于每个标的的具体持仓数值，是由 hold_positions() 方法来决定。

范例:

# 历史曾执行过订阅某些标的
# context.subscribe(source, tickers_list, EXCHANGE)

# 当前代码中重置了 subscribe，且没有调用 context.hold_book()，则该策略只会收到新订阅的标的行情，且账目收益及持仓中只包含新订阅的标的
context.subscribe(source, tickers_list, EXCHANGE)

# 如果调用 hold_book，则该策略订阅行情列表中会自动包含历史记录中有的标的
#，且账目收益及持仓中也会包含对应标的的数据
context.hold_book()

context.hold_positions()

保持账目中每一标的的历史持仓。缺省设置即没有调用此方法时，系统会通过同步柜台查询到的持仓数据来构建策略账目，每次策略启动后，账目中所有标的的持仓都会同步为最新的柜台账户对应的持仓；当调用此方法后，系统会使用功夫内部记录的历史数据来恢复策略的账目持仓。缺省设置保证了策略账目中的持仓数据是绝对准确的，但无法反映功夫运行期间内的策略历史交易情况；如果需要获取之前运行策略时产生的历史持仓记录，则需要通过调用该方法来使系统使用本地存储的历史记录，在这种情况下，当因为各种因素（例如在功夫系统外使用别的软件对同一账户手动交易）都会使得功夫内部维护的持仓记录产生偏差，（例如同一账户下对应的不同策略持仓汇总之和不等于账户总持仓），当发生此类偏差时，建议使用缺省模式来从账户持仓恢复策略持仓。

范例:

# 策略账目所包含的持仓标的列表取决于是否调用context.hold_book()，但每个标的的具体持仓数值则由context.hold_positions()来决定，
# 当缺省即没有调用该方法时，策略启动后的账目中的标的持仓等于所对应账户下的标的持仓：
context.subscribe(source, tickers_list, EXCHANGE)

# 当调用 hold_positions() 方法后，策略启动后的账目中标的持仓等于上次运行策略结束时所对应的标的持仓：
context.hold_positions()

Utils 状态判断

属性	类型	说明
hash_instrument	long	获取账户中某个标的信息对应的key值
is_valid_price	bool	判断当前价格是否为有效价格
is_final_status	bool	判断当前状态是否为最终状态
get_instrument_type	InstrumentType	获取类型

Utils范例:

# hash_instrument 案例示范
from pykungfu import wingchun as wc

# 1. 获取某个可交易标的信息对应的key值  wc.utils.hash_instrument(exchange_id, instrument_id)
instrument_key = wc.utils.hash_instrument(EXCHANGE_SPOT, "BTC-USDT")
instrument = context.get_account_book(source,account).instruments[instrument_key]
context.log.info("instrument {}".format(instrument))

# 2. 获取某个标的持仓信息对应的key值  wc.utils.hash_instrument(account_uid, exchange_id, instrument_id)
account_uid = context.get_account_uid(source, account)
position_key = wc.utils.hash_instrument(account_uid, EXCHANGE_SPOT, "BTC")
position = context.get_account_book(source,account).long_positions[position_key]
context.log.info("position {}".format(position))


# 其他案例示范
def on_quote(context, quote, location, dest):
    is_valid_price = wc.utils.is_valid_price(quote.last_price)
    context.log.warning("当前价格是否为有效价格 {}".format(is_valid_price))


def on_order(context, order, location, dest):
    is_valid_status = wc.utils.is_final_status(order.status)
    context.log.warning("当前状态是否为最终状态 {}".format(is_valid_status))


def post_start(context):
    ticker_instrument_type = wc.utils.get_instrument_type(EXCHANGE_SPOT, "BTC-USDT")
    context.log.warning("标的的合约类型是 {}".format(ticker_instrument_type))

投资组合相关

context.book

策略的投资组合 (当前策略的投资组合信息)

类型

book对象

范例:

#获取策略的投资组合，并打印相关参数
book = context.book
context.log.warning("[strategy capital] (avail){} (margin){}".format(book.asset.avail, book.asset.margin))

context.get_account_book(SOURCE, ACCOUNT)

账户的投资组合 (获取填写的这个柜台的账户的持仓,账户资金等信息)

类型

book对象

范例:

#获取账户的投资组合，并打印相关参数
book = context.get_account_book(SOURCE, ACCOUNT)
context.log.warning("[account capital] (avail){} (margin){} ".format(book.asset.avail, book.asset.margin))

使用方法

属性	类型	说明
asset	asset	投资组合资金信息
instruments	Instrument	获取当日可交易标的信息
funding_rates	FundingRate	获取费率信息
long_positions	Position	投资组合的持仓列表，对应多头仓位
short_positions	Position	投资组合的持仓列表，对应空头仓位
orders	Order	获取订单委托信息
trades	Trade	获取订单成交信息
order_inputs	OrderInput	获取订单输出信息
has_long_position	bool	判断是否为多头仓位
has_short_position	bool	判断是否为空头仓位
get_long_position	dict	多头持仓信息
get_short_position	dict	空头持仓信息

注意

1. 对于 context.book 来说

   1). orders  是获取跟该策略本身相关的所有委托，这个“所有委托”，包含了不同账户的委托信息

   2). trades  是获取跟该策略本身相关的所有成交，这个“所有成交”，包含了不同账户的成交信息

   3). order_inputs  是获取该策略本次的所有订单输出，这个“所有订单输出”，包含了不同账户的订单输出信息

2. 对于 context.get_account_book(source, account) 来说

   1). orders  是获取目标账户的所有委托信息

   2). trades  是获取目标账户的所有成交信息

   3). order_inputs  是获取目标账户在本次策略中的订单输出信息

获取投资组合持仓列表范例:

def post_start(context):
    context.log.warning("post_start")

    context.account_book = context.get_account_book(SOURCE, ACCOUNT)

    book = context.book

    context.log.warning("资金组合信息 {}".format(context.account_book.asset))

    # 账户中多头持仓数据
    long_position = context.account_book.long_positions
    for key in long_position:
        pos = long_position[key]
        context.log.info("多头持仓数据 (instrument_id){} (volume){} (yesterday_volume){} ".format(pos.instrument_id,pos.volume,pos.yesterday_volume))

    # 账户中空头持仓数据
    short_position = context.account_book.short_positions
    for key in short_position:
        pos = short_position[key]
        context.log.info("空头持仓数据 (instrument_id){} (volume){} (yesterday_volume){} ".format(pos.instrument_id,pos.volume,pos.yesterday_volume))



    # 获取当日可交易标的信息
    instrument = context.account_book.instruments
    for key in instrument:
        pos = instrument[key]
        context.log.info(
            "当日可交易标的信息 instrument_id {} , exchange_id {}".format(pos.instrument_id, pos.exchange_id))

    # 获取费率信息
    funding_rates = context.account_book.funding_rates
    for key in funding_rates:
        pos = funding_rates[key]
        context.log.info(
            "获取费率信息  {} ".format(pos))

    # 获取策略所有委托信息
    book_order = book.orders
    for key in book_order:
        pos = book_order[key]
        context.log.info("book orders order_id {} ".format(pos.order_id))

    # 获取策略所有成交信息
    book_trade = book.trades
    for key in book_trade:
        pos = book_trade[key]
        context.log.info("book trades trade_id {} ".format(pos.trade_id))

    # 获取策略本次订单输出信息
    book_order_input = book.order_inputs
    for key in book_order_input:
        pos = book_order_input[key]
        context.log.info("book order_inputs order_id {} ".format(pos.order_id))

    # 获取账户所有委托信息
    account_order = context.account_book.orders
    for key in account_order:
        pos = account_order[key]
        context.log.info("account orders order_id {} ".format(pos.order_id))

    # 获取账户所有成交信息
    account_trade = context.account_book.trades
    for key in account_trade:
        pos = account_trade[key]
        context.log.info("account trades trade_id {} ".format(pos.trade_id))

    # 获取账户在本次策略中的订单输出信息
    account_order_input = context.account_book.order_inputs
    for key in account_order_input:
        pos = account_order_input[key]
        context.log.info("account order_inputs order_id {} ".format(pos.order_id))

    # 判断是否为多头仓位
    context.log.warning("判断是否为多头仓位 {}".format(context.account_book.has_long_position(SOURCE, ACCOUNT,EXCHANGE_SPOT,"BTC")))

    # 多头标的持仓信息
    context.log.warning("多头标的持仓信息 {}".format(context.account_book.get_long_position(SOURCE, ACCOUNT,EXCHANGE_SPOT, "BTC")))

静态数据信息

context.static_data

静态数据信息获取

类型

static_data对象

范例:

#获取静态数据
static_data = context.static_data

使用方法

属性	类型	说明
instruments	Instrument	获取当日可交易标的信息
funding_rates	FundingRate	获取费率信息

范例:

# 获取可交易标的信息
static_data_instrument = context.static_data.instruments
for key in static_data_instrument:
    pos = static_data_instrument[key]
    context.log.info(
        "static_data 当日可交易标的信息 标的 {} , 交易所 {}".format(pos.instrument_id, pos.exchange_id))

# 获取保证金信息
static_data_funding_rates = context.static_data.funding_rates
for key in static_data_funding_rates:
    pos = static_data_funding_rates[key]
    context.log.info(
        "static_data 获取费率信息  标的 {} , 交易所 {} , 资金费率".format(pos.instrument_id, pos.exchange_id, pos.funding_rate))

辅助函数

context.log.info

输出INFO级别 Log 信息

参数	类型	说明
msg	str	Log信息

返回

返回	类型	说明
无	无	无

范例:

context.log.info(msg)

context.log.warning

输出WARN级别Log信息

参数

参数	类型	说明
msg	str	Log信息

返回

返回	类型	说明
无	无	无

范例:

context.log.warning(msg)

context.log.error

输出ERROR级别Log信息

参数

参数	类型	说明
msg	str	Log信息

返回

返回	类型	说明
无	无	无

范例:

context.log.error(msg)

context.strftime()

时间格式转换 ： 将纳秒级时间戳时间转换成文本时间

参数

参数	类型	说明
msg	int	时间戳时间

返回

返回	类型	说明
无	无	无

范例:

context.log.info(" 当前时间是 {} 纳秒".format(context.now()))
# 当前时间是 1669344957395751800 纳秒
context.log.info(" 当前时间转换为 文本类型时间 ： {} ".format(context.strftime(context.now())))
# 当前时间转换为 文本类型时间 ： 2022-11-25 10:55:57.395751800

context.strptime()

时间格式转换 ： 将文本时间转换成纳秒级时间戳时间 注意 ： 文本字符串必须是 “%Y-%m-%d %H:%M:%S.” 的格式，注意最后有一个英文句点（.）不要漏掉了 。

参数

参数	类型	说明
msg	str	文本格式时间

返回

返回	类型	说明
无	无	无

范例:

context.log.info(" 文本时间转换为时间戳 : {} ".format(context.strptime("2022-11-25 11:04:01.")))
# 文本时间转换为时间戳 : 1669345441000000000

context.add_timer

注册时间回调函数

参数

参数	类型	说明
nano	long	触发回调的纳秒时间戳
callback	object	回调函数

返回

返回	类型	说明
无	无	无

范例:

# 通过时间回调函数，在1s后撤去订单号为order_id的报单
context.add_timer(context.now() + 1*1000000000, lambda ctx, event: cancel_order(ctx, order_id))

context.add_time_interval

时间间隔回调函数

参数

参数	类型	说明
nano	long	触发回调的纳秒时间戳
callback	object	回调函数

返回

返回	类型	说明
无	无	无

范例:

# 通过时间间隔回调函数，每过60s,调用一次func函数
context.add_time_interval(60 * 1000000000, lambda ctx, event: func(ctx))

context.clear_timer()

取消定时器

参数

参数	类型	说明
timer_id	int	时间回调函数ID

返回

返回	类型	说明
无	无	无

范例:

# 通过时间间隔回调函数，每过60s,调用一次func函数
timer_id = context.add_time_interval(60 * 1000000000, lambda ctx, event: func(ctx))
# 取消这个时间回调函数
context.clear_timer(timer_id)

context.req_deregister()

关闭策略进程

范例:

# 执行 context.req_deregister() 关闭策略进程
context.req_deregister()

枚举值(enums)

Source柜台

属性	值	说明
OKX	“okx“	欧易柜台
BinanceFuture	“binancefuture“	币安合约

柜台使用方法:

# 案例示范
from kungfu.wingchun.constants import Source
SOURCE = "okx"
ACCOUNT = "1111111"
def pre_start(context):
    # 添加账户柜台信息
    context.add_account(SOURCE, ACCOUNT)

Exchange交易所

属性	值	说明
OKX_SPOT	“OKX_SPOT”	欧易现货
OKX_USD_FUTURE	“OKX_USD_FUTURE”	欧易U本位市场
OKX_COIN_FUTURE	“OKX_COIN_FUTURE”	欧易币本位市场
BINANCE_USD_FUTURE	“BINANCE_USD_FUTURE”	币安U本位市场
BINANCE_COIN_FUTURE	“BINANCE_COIN_FUTURE”	币安币本位市场

交易所使用方法:

# 案例示范
from kungfu.wingchun.constants import Exchange
source = "okx"
tickers = ["BTC-USDT", "LTC-USDT"]
EXCHANGE_SPOT = Exchange.OKX_SPOT

def pre_start(context):
# 订阅行情
context.subscribe(SOURCE, tickers, EXCHANGE_SPOT)

InstrumentType 代码类型

属性	说明
Unknown	未知
Crypto	数字货币
CryptoFuture	数字货币币本位
CryptoUFuture	数字货币U本位

合约类型判断方法:

# 案例示范
from kungfu.wingchun.constants import InstrumentType

positions = context.get_account_book(SOURCE, ACCOUNT)

for key in positions.long_positions:
  pos = positions.long_positions[key]
  if pos.instrument_type == InstrumentType.Crypto:
      context.log.info("这个ticker的合约类型是数字货币")

PriceType 报单类型

属性	说明
Limit	限价,通用
Any	市价，通用

Side 买卖

属性	说明
Buy	买
Sell	卖

Offset 开平

属性	说明
Open	开
Close	平

HedgeFlag 投机套保标识

属性	说明
Speculation	投机

注意 : Python策略中insert_order可以不写这个参数,因为已经默认是投机

IsSwap 是否为互换单

属性	说明
true	互换单
false	不是互换单

Direction 多空

属性	说明
Long	多
Short	空

持仓方向使用方法:

# 案例示范
from kungfu.wingchun.constants import Direction

positions = context.get_account_book(SOURCE, ACCOUNT)

for key in positions.long_positions:
    pos = positions.long_positions[key]
    if pos.direction == Direction .Long:
        context.log.info("这个ticker的持仓方向 : 多")
    elif pos.direction == Direction .Short:
        context.log.info("这个ticker的持仓方向 : 空")

OrderStatus 委托状态

属性	说明
Unknown	未知
Submitted	已提交
Pending	等待
Cancelled	已撤单
Error	错误
Filled	已成交
PartialFilledNotActive	部成部撤
PartialFilledActive	部成交易中
Lost	丢失
Cancelling	待撤
Pause	暂停

订单状态获取:

# 案例示范
from kungfu.wingchun.constants import OrderStatus

def on_order(context, order):
  if order.status == OrderStatus.Submitted:
      context.log.warning("此时的订单状态为 : 已提交")
  elif order.status == OrderStatus.Pending:
      context.log.warning("此时的订单状态为 : 等待中")
  elif order.status == OrderStatus.Filled:
      context.log.warning("此时的订单状态为 : 已成交")

ExecType 标识

属性	说明
Unknown	未知
Cancel	撤单
Trade	成交

BsFlag 标识

属性	说明
Unknown	未知
Buy	买
Sell	卖

LedgerCategory 标识

属性	说明
Account	账户投资组合数据
Strategy	策略投资组合数据

VolumeCondition 标识

属性	说明
Any	任何
Min	最小
All	所有

TimeCondition 标识

属性	说明
IOC	立刻成交，否则撤销
GFD	当日有效
GTC	撤单前有效
GFS	本节有效
GTD	指定日期前有效
GFA	集合竞价有效
Unknown	未知

Location 标识

属性	说明
mode	交易规则(目前只支持 LIVE,实时交易)
category	类别(TD/MD) (这条数据的来源是 td还是md)
group	柜台id (比如 : okx )
name	对于交易进程(如:on_order,on_trade)是账户名(比如: 123456, 123321 ) , 对于行情进程(如:on_quote)是柜台id (比如: okx , sim)
uid	mode/category/group/name 组成的字符串的哈希值
uname	location的整体信息 (比如 : td/sim/123/live (数据来源是td , 柜台是sim柜台 , 账号是 123 , 交易规则是实时交易) )

例子:

def on_order(context, order, location):
    context.log.info(
        "[location]  mode{}, category {}, group {}, name {}, uid{}, uname {}".format(
            location.mode, location.category, location.group, location.name, location.uid, location.uname))

BrokerState 进程连接状态

属性	说明
Pending	等待中
Idle	无数据
DisConnected	已断开
Connected	已连接
LoggedIn	已登录
LoginFailed	登录失败
Ready	就绪

注意 : Idle只有行情模块有, 连续15秒没有数据就会把前端行情状态设置为Idle, 只在前端显示不通知到策略

OperatorState 连接状态

属性	说明
Pending	等待中
DisConnected	已断开
ErrConnectedor	错误连接
Ready	就绪

Currency 币种

属性	说明
Unknown	未知
CNY	人民币
HKD	港币
USD	美元
JPY	日元
GBP	英镑
EUR	欧元
CNH	离岸人民币
SGD	新加坡币
MYR	马来西亚币
CEN	美分

FundingPeriod 资金费收取逻辑

属性	说明
Unknown	未知
CurrentPeriod	当期
NextPeriod	跨期

SettleState 资金费率结算状态

属性	说明
Unknown	等待中
Processing	结算中
Settled	已结算

数据结构

Quote 行情信息

属性	类型	说明
data_time	int	数据生成时间(交易所时间)
instrument_id	str	合约ID
exchange_id	str	交易所ID
instrument_type	InstrumentType	合约类型
pre_close_price	float	昨收价
pre_settlement_price	float	昨结价
last_price	float	最新价
volume	float	数量
turnover	float	成交金额
pre_open_interest	float	昨持仓量
open_interest	float	持仓量
open_price	float	今开盘
high_price	float	最高价
low_price	float	最低价
upper_limit_price	float	涨停板价
lower_limit_price	float	跌停板价
close_price	float	收盘价
settlement_price	float	结算价
iopv	float	基金实时参考净值
total_bid_volume	float	总委托买入量
total_ask_volume	float	总委托卖出量
total_trade_num	float	总成交笔数
bid_price	list of float	申买价
ask_price	list of float	申卖价
bid_volume	list of float	申买量
ask_volume	list of float	申卖量

Tick 行情数据

属性	类型	说明
data_time	int	数据生成时间(交易所时间)
instrument_id	str	合约ID
exchange_id	str	交易所ID
instrument_type	InstrumentType	合约类型
bid_price	float	申买价
ask_price	float	申卖价
bid_volume	float	申买量
ask_volume	float	申卖量

Transaction 逐笔成交

属性	类型	说明
data_time	int	数据生成时间(交易所时间)
instrument_id	str	合约ID
exchange_id	str	交易所ID
instrument_type	InstrumentType	合约类型
price	float	成交价
volume	float	成交量
bid_no	long	买方订单号
ask_no	long	卖方订单号
exec_type	ExecType	SZ: 成交标识
side	Side	买卖方向
main_seq	long	主序号
seq	long	子序号
biz_index	int	业务序号

FundingRate 资金费率回调

属性	类型	说明
data_time	int	数据生成时间(交易所时间)
instrument_id	str	合约ID
exchange_id	str	交易所ID
funding_period	FundingPeriod	资金费收取逻辑
funding_rate	float	资金费率
next_funding_rate	float	下一期预测资金费率, 收取逻辑为当期时为空
funding_time	int	资金费时间
next_funding_time	int	下一期资金费时间
min_funding_rate	float	下一期的预测资金费率下限
max_funding_rate	float	下一期的预测资金费率上限
settle_State	SettleState	资金费率结算状态
settle_funding_rate	float	若processing代表本轮结算资金费率, 若settled代表上轮结算资金费率
premium	float	溢价, 为合约的中间价和指数价格的差异

Order 订单回报

属性	类型	说明
order_id	int	订单ID
external_order_id	str	柜台订单ID
parent_id	int	母单号
insert_time	int	订单写入时间(功夫时间)
update_time	int	订单更新时间(功夫时间)
trading_day	int	交易日
restore_time	int	恢复时间(用于重启td后恢复交易数据的时间戳)
instrument_id	str	合约ID
exchange_id	str	交易所ID
contract_id	str	两融合约唯一标识
instrument_type	InstrumentType	合约类型
limit_price	float	价格
frozen_price	float	冻结价格（市价单冻结价格为0.0）
volume	float	数量
volume_left	float	剩余数量
tax	float	税
commission	float	手续费
status	OrderStatus	订单状态
error_id	int	错误ID
error_msg	str	错误信息
is_swap	bool	互换单
side	Side	买卖方向
offset	Offset	开平方向
hedge_flag	HedgeFlag	投机套保标识
price_type	PriceType	价格类型
volume_condition	VolumeCondition	成交量类型
time_condition	TimeCondition	成交时间类型

Trade 订单成交

属性	类型	说明
trade_id	int	成交ID
parent_order_id	int	母单号
external_order_id	str	柜台订单ID
external_trade_id	str	柜台成交编号ID
order_id	int	订单ID
trade_time	int	成交时间(功夫时间)
trading_day	int	交易日
restore_time	int	恢复时间(用于重启td后恢复交易数据的时间戳)
instrument_id	str	合约ID
exchange_id	str	交易所ID
contract_id	str	两融合约唯一标识
instrument_type	InstrumentType	合约类型
side	Side	买卖方向
offset	Offset	开平方向
hedge_flag	HedgeFlag	投机套保标识
price	float	成交价格
volume	float	成交量
tax	float	税
commission	float	手续费

OrderInput 订单输出

属性	类型	说明
order_id	int	订单ID
parent_id	int	母单号
instrument_id	str	合约ID
exchange_id	str	交易所ID
contract_id	str	两融合约唯一标识
instrument_type	InstrumentType	合约类型
limit_price	float	价格
frozen_price	float	冻结价格
volume	float	数量
is_swap	bool	互换单
side	Side	买卖方向
offset	Offset	开平方向
hedge_flag	HedgeFlag	投机套保标识
price_type	PriceType	价格类型
volume_condition	VolumeCondition	成交量类型
time_condition	TimeCondition	成交时间类型
block_id	int	大宗交易信息id, 非大宗交易则为0
insert_time	int	订单写入时间(功夫时间)

OrderActionError 撤单报错信息

属性	类型	说明
order_id	int	订单ID
external_order_id	str	撤单原委托柜台订单ID, 新生成撤单委托编号不记录
order_action_id	int	订单操作ID
error_id	int	错误ID
error_msg	str	错误信息
insert_time	int	写入时间

SyntheticData 订阅的算子器返回数据

属性	类型	说明
update_time	int	更新时间
key	str	订阅的算子器发布的标识
value	str	订阅的算子器发布的内容
tag_a	str	占位(目前没有用到)
tag_b	str	占位(目前没有用到)
tag_c	str	占位(目前没有用到)

OperatorStateUpdate 订阅的其他算子器状态变化信息

属性	类型	说明
state	OperatorState	连接状态
update_time	int	更新时间
location_uid	int	mode/category/group/name 组成的字符串的哈希值
value	str	内容
info_a	str	占位(目前没有用到)
info_b	str	占位(目前没有用到)

Deregister 断开回调信息

属性	类型	说明
mode	enums	交易规则(目前只支持 LIVE,实时交易)
category	enums	类别(TD/MD) (这条数据的来源是 td还是md)
group	str	柜台ID (比如 : xtp , ctp)
name	str	对于交易进程(如:on_order,on_trade)是账户名(比如: 123456, 123321 ) , 对于行情进程(如:on_quote)是柜台ID (比如: xtp , sim)
location_uid	int	mode/category/group/name 组成的字符串的哈希值

例子:

def on_deregister(context, deregister, location):
    context.log.info(
        '[on_deregister] {}---{}---{}---{}--{}--{}'.format(deregister, deregister.mode, deregister.category,
                                                   deregister.group, deregister.name,deregister.location_uid))

BrokerStateUpdate 客户端状态变化回调信息

属性	类型	说明
location_uid	int	mode/category/group/name 组成的字符串的哈希值
state	BrokerState	进程连接状态

例子:

def on_broker_state_change(context, broker_state_update, location):
    context.log.info('[on_broker_state_change] {}--{}'.format(broker_state_update, broker_state_update.state))

注意:功夫时间在最开始会以真实时间对时，然后根据cpu震动++，是个单调递增的时间，和真实时间是有差别的。交易所时间和本机时间也会有差别

asset 资金信息

属性	类型	说明
update_time	int	更新时间(功夫时间)
holder_uid	int	持有人ID
ledger_category	LedgerCategory	账户类别
initial_equity	float	期初权益
static_equity	float	静态权益
dynamic_equity	float	动态权益
realized_pnl	float	累计收益
unrealized_pnl	float	未实现盈亏
market_value	float	市值
long_market_value	float	融资买入证券市值
short_market_value	float	融券卖出证券市值
margin	float	保证金占用
long_margin	float	融资占用保证金
short_margin	float	融券占用保证金
accumulated_fee	float	累计手续费
intraday_fee	float	当日手续费
frozen_cash	float	冻结资金(股票: 买入挂单资金, 期货: 冻结保证金+冻结手续费)
frozen_margin	float	冻结保证金(期货)
frozen_fee	float	冻结手续费(期货)
position_pnl	float	持仓盈亏(期货)
close_pnl	float	平仓盈亏(期货)
avail	float	可用资金
long_avail	float	otc业务可用资金(多)
short_avail	float	otc业务可用资金(空)
total_asset	float	总资产
avail_margin	float	可用保证金
long_debt	float	融资负债
short_cash	float	融券卖出金额
margin_interest	float	融资融券利息
settlement	float	融资融券清算资金
credit	float	信贷额度
collateral_ratio	float	担保比例
total_debt	float	总负债
net_assets	float	净资产
long_total_debt	float	融资总负债（融资欠款+融资利息+融资费用）
short_total_debt	float	融券总负债（融券市值+融券利息+融券费用）
gage_buy_fund_available	float	担保品买入可用资金
credit_buy_fund_available	float	融资融券可用资金
buyredeliver_fund_available	float	买券还券可用资金
directrepay_fund_available	float	现金还款可用资金

Instrument 当日可交易标的信息

属性	类型	说明
instrument_id	str	合约ID
exchange_id	str	交易所
instrument_type	InstrumentType	合约类型
product_id	int	产品ID (品种)
contract_multiplier	int	合约乘数
price_tick	float	最小变动价位
quantity_unit	float	最小数量单位
open_date	str	上市日
create_date	str	创建日
expire_date	str	到期日
delivery_year	int	交割年份
delivery_month	int	交割月
currency	Currency	币种

Position 持仓信息

属性	类型	说明
update_time	int	更新时间(功夫时间)
instrument_id	str	合约ID
instrument_type	InstrumentType	合约类型
exchange_id	str	交易所ID
holder_uid	int	持有人ID
ledger_category	LedgerCategory	账户类别
direction	Direction	持仓方向
volume	float	总持仓量
yesterday_volume	float	昨仓数量
frozen_total	float	冻结数量
frozen_yesterday	float	冻结昨仓
static_yesterday	float	固定昨仓数量
open_volume	float	今开数量
last_price	float	最新价
avg_open_price	float	开仓均价, 今昨一起
position_cost_price	float	持仓成本
avg_open_price_today	float	今开仓均价, 仅今仓
close_price	float	收盘价
pre_close_price	float	昨收价
realized_pnl	float	已实现盈亏
unrealized_pnl	float	未实现盈亏
source_id	int	来源账户
source_op_id	int	来源账户 xor holder_uid

---

- aliyun镜像源配置

  name = "aliyun"
  url = "https://mirrors.aliyun.com/pypi/simple"
  default = false
  secondary = true

- 依赖的第三方库及其版本

black = "~22.3.0"
nuitka = "~0.9.0"
pdm = "~1.15.0"
poetry-core = "^1.0.0"
scons = "^4.3.0"
click = "^8.0.0"
psutil = "^5.9.0"
tabulate = "^0.8.10"
numpy = "^1.22.0"
pandas = "^1.4.0"
scipy = ">=1.7 <1.8"
statsmodels = "^0.13.2"
ordered-set = "^4.0.0"
pytest = "^7.1.0"
conan = "^1.49.0"
pyinstaller = "^5.1"

---