- 富途的量化函数没有很好的网页说明，这里从app中贴出来。
- 格式由deepseek自动生成
- 版权归富途所有
注册指标
本节内容仅用于代码策略，可视化策略不涉及以下内容。
register_indicator
接口说明
使用此接口注册一个麦语言指标，以便策略调用。
register_indicator(indicator_name, script, param_list)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| indicator_name | string | 指标名 | — | — |
| script | string | 麦语言脚本 | — | — |
| param_list | list | 麦语言脚本参数列表 | — | — |
返回 无返回值
示例说明
def custom_indicator(self):
self.register_indicator(indicator_name='MA', script='''MA1:MA(CLOSE,P1),COLORFF8D1E;MA2:MA(CLOSE,P2),COLOR0CAEE6;''', param_list=['P1', 'P2'])
示例返回值
--
指标约定函数
本节内容仅用于代码策略，可视化策略不涉及以下内容。
custom_indicator
接口说明 指标约定函数。在代码策略中，麦语言指标须先在此函数下注册后，方可使用。
custom_indicator()
返回 返回类型： None
示例说明 在 custom_indicator() 约定函数下，注册一个名为’MA’的指标
def custom_indicator(self):
self.register_indicator(indicator_name='MA', script='''MA1:MA(CLOSE,P1),COLORFF8D1E;MA2:MA(CLOSE,P2),COLOR0CAEE6;''', param_list=['P1', 'P2'])
示例返回值
--
全局变量显示函数
本节内容仅用于代码策略，可视化策略不涉及以下内容。
show_variable() 用法介绍
接口说明
当使用该函数时，会在运行设置上显示出该全局变量。
show_variable() 仅适用于在 def global_variable() 约定函数下方使用。（在可视化策略下，def global_variable() 约定函数会在开始卡片下方展示）
当全局变量使用该函数时，不允许使用其他赋值方式对该变量进行赋值。
多变量赋值时，不支持使用此函数。
步骤图
show_variable(value, variable_type=GlobalType.FLOAT)
参数
| 参数 | 参数类型 | 参数说明 | 参数默认值 | 参数范围 |
|---|---|---|---|---|
| value | 与 variable_type 匹配 | 全局变量值 | — | — |
| variable_type | GlobalType | 全局变量类型 | GlobalType.FLOAT | — |
返回 无返回值
示例说明
创建全局变量 A 和 B，值分别为 1.0 和 2.0，类型为 Float，使用 show_variable() 函数显示全局变量 A。
def global_variable(self):
self.A = show_variable(1.0, GlobalType.FLOAT) # 使用 show_variable() 函数显示全局变量 A
self.B = 2.0 # 全局变量 B 不显示在运行设置中
示例表现
运行设置中出现全局变量 A，默认值为 1.0，类型为 Float，全局变量 B 不显示。
错误码
本节内容仅用于代码策略，可视化策略不涉及以下内容。
错误码说明
错误码，是对各类错误场景进行的归类。以下是量化功能设定的错误码和对应的场景，您可以通过示例中的方法，识别和处理异常错误。
错误码枚举
错误码枚举类 ErrCode
| 错误码枚举 | 错误码枚举对应场景 |
|---|---|
| ExceedReqLimit | 请求过于频繁，触发频率限制 |
| ReqTimeout | 接口请求超时 |
| NoQuoteRight | 行情权限不足 |
| InvalidArgument | 无效参数（参数校验失败） |
| ReqFailed | 接口请求失败 |
| NoDataAvailable | 无数据（返回数据是 NA） |
| EmptySymbol | 参数 symbol 为空 |
| Unknown | 未知错误 |
示例说明
量化功能已经为各种错误情况定义了一组错误码，在您使用时，可以针对返回的不同错误码执行相应的处理逻辑。以下是一个示例说明如何使用错误码对异常错误的处理：
try:
a = current_price(code=Con"US.AAPL")
# 标的的写法有误（正确写法为 Contract("US.AAPL")），触发无效参数的报错
except APIException as ex:
if ex.err_code == ErrCode.ExceedReqLimit:
print("请求过于频繁，触发频率限制")
elif ex.err_code == ErrCode.ReqTimeout:
print("接口请求超时")
elif ex.err_code == ErrCode.NoQuoteRight:
print("行情权限不足")
elif ex.err_code == ErrCode.InvalidArgument:
print("无效参数（参数校验失败）")
elif ex.err_code == ErrCode.ReqFailed:
print("接口请求失败")
elif ex.err_code == ErrCode.NoDataAvailable:
print("无数据（返回数据是NA）")
elif ex.err_code == ErrCode.EmptySymbol:
print("参数symbol为空")
elif ex.err_code == ErrCode.Unknown:
print("未知错误")
else:
print("可能存在其他错误")
示例表现
在上述示例中，在获取最新价格时，由于标的格式填写错误，系统会返回 “InvalidArgument” 的错误码。根据第 12 行，会在日志中打印 “无效参数（参数校验失败）”。
参考上述示例，您可以在捕捉到相应的错误码后，执行期望的处理逻辑。
量化中支持 import 哪些模块
本节内容仅用于代码策略，可视化策略不涉及以下内容。
模块支持说明
目前支持使用 Python 标准模块，暂不支持添加第三方模块。
标准模块的使用示例
import time
print(time.time()) # 在日志中打印当前时间戳
time.sleep(5) # 等待 5 秒
import random
print(random.random()) # 生成一个[0,1)范围内的随机数，并在日志中打印出来
注意事项
出于安全考虑，我们在 Python 底层禁用了读写硬盘、网络请求、界面创建的功能。这可能导致标准库中部分相关功能无法使用。
最新价格
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
- 美国市场：股票、ETFs、指数、板块、期权、期货
- A股市场：股票、ETFs、指数、板块
- 新加坡市场：期货
- 日本市场：期货
- 外汇市场：外汇
current_price
接口说明
获取指定标的的最新价格。
current_price(symbol, price_type=THType.FTH)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| price_type | THType | 时段类型 | THType.FTH | — |
返回
返回类型：float
示例说明
获取苹果的最新价格。
current_price(symbol=Contract("US.AAPL"), price_type=THType.FTH)
示例返回值
150.82
摆盘委托价
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证、期权、期货
- 美国市场：股票、ETFs、期权、期货
- A股市场：股票、ETFs
- 新加坡市场：期货
- 日本市场：期货
bid
接口说明
获取指定标的第 n 档的买盘委托价。
bid(symbol, level=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| level | int | 第几档 | 1 | 1-50 |
返回
返回类型：float
示例说明
获取苹果的第 1 档买盘委托价。
bid(symbol=Contract("US.AAPL"), level=1)
示例返回值
145.94
ask
接口说明
获取指定标的第 n 档的卖盘委托价。
ask(symbol, level=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| level | int | 第几档 | 1 | 1-50 |
返回
返回类型：float
示例说明
获取苹果的第 1 档卖盘委托价。
ask(symbol=Contract("US.AAPL"), level=1)
示例返回值
145.99
K 线开盘价
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
- 美国市场：股票、ETFs、指数、板块、期权、期货
- A股市场：股票、ETFs、指数、板块
- 新加坡市场：期货
- 日本市场：期货
- 外汇市场：外汇
bar_open
接口说明
获取指定标的指定周期的 K 线开盘价。
bar_open(symbol, bar_type=BarType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-500 |
返回
返回类型：float
示例说明
获取苹果的最新 1 根 1 小时 K 线的开盘价。
bar_open(symbol=Contract("US.AAPL"), bar_type=BarType.H1, select=1)
示例返回值
145.54
bar_custom
接口说明
将指定周期的多根 K 线聚合成 1 根 K 线，例如：自定义“8 小时 K”周期，是指每 8 根 1 小时 K 线聚合成 1 根 “8 小时 K”。
bar_custom(symbol, data_type=BarDataType.OPEN, custom_num=4, custom_type=CustomType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| data_type | BarDataType | 数据类型 | BarDataType.CLOSE | — |
| custom_num | int | 自定义根数 | 4 | 1-200 |
| custom_type | CustomType | 自定义周期 | CustomType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-5 |
返回
返回类型：float
示例说明
获取苹果的最新 1 根 8 小时 K 线的开盘价。
bar_custom(symbol=Contract("US.AAPL"), data_type=BarDataType.OPEN, custom_num=8, custom_type=CustomType.H1, select=1)
示例返回值
179.69
K 线收盘价
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
- 美国市场：股票、ETFs、指数、板块、期权、期货
- A股市场：股票、ETFs、指数、板块
- 新加坡市场：期货
- 日本市场：期货
- 外汇市场：外汇
bar_close
接口说明
获取指定标的指定周期的 K 线柱收盘价。
bar_close(symbol, bar_type=BarType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-500 |
返回
返回类型：float
示例说明
获取苹果的最新 1 根 1 小时 K 线的收盘价。
bar_close(symbol=Contract("US.AAPL"), bar_type=BarType.H1, select=1)
示例返回值
143
bar_custom
接口说明
将指定周期的多根 K 线聚合成 1 根 K 线，例如：自定义“8 小时 K”周期，是指每 8 根 1 小时 K 线聚合成 1 根 “8 小时 K”。
bar_custom(symbol, data_type=BarDataType.CLOSE, custom_num=4, custom_type=CustomType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| data_type | BarDataType | 数据类型 | BarDataType.CLOSE | — |
| custom_num | int | 自定义根数 | 4 | 1-200 |
| custom_type | CustomType | 自定义周期 | CustomType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-5 |
返回
返回类型：float
示例说明
获取苹果的最新 1 根 8 小时 K 线的收盘价。
bar_custom(symbol=Contract("US.AAPL"), data_type=BarDataType.CLOSE, custom_num=8, custom_type=CustomType.H1, select=1)
示例返回值
174.49
K 线最高价
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
- 美国市场：股票、ETFs、指数、板块、期权、期货
- A股市场：股票、ETFs、指数、板块
- 新加坡市场：期货
- 日本市场：期货
- 外汇市场：外汇
bar_high
接口说明
获取指定标的指定周期的 K 线最高价。
bar_high(symbol, bar_type=BarType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-500 |
返回
返回类型：float
示例说明
获取苹果的最新 1 根 1 小时 K 线的最高价。
bar_high(symbol=Contract("US.AAPL"), bar_type=BarType.H1, select=1)
示例返回值
142.43
bar_custom
接口说明
将指定周期的多根 K 线聚合成 1 根 K 线，例如：自定义“8 小时 K”周期，是指每 8 根 1 小时 K 线聚合成 1 根 “8 小时 K”。
bar_custom(symbol, data_type=BarDataType.HIGH, custom_num=4, custom_type=CustomType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| data_type | BarDataType | 数据类型 | BarDataType.CLOSE | — |
| custom_num | int | 自定义根数 | 4 | 1-200 |
| custom_type | CustomType | 自定义周期 | CustomType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-5 |
返回
返回类型：float
示例说明
获取苹果近 8 日的最高价。
bar_custom(symbol=Contract("US.AAPL"), data_type=BarDataType.HIGH, custom_num=8, custom_type=CustomType.D1, select=1)
示例返回值
181.55
K 线最低价
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
- 美国市场：股票、ETFs、指数、板块、期权、期货
- A股市场：股票、ETFs、指数、板块
- 新加坡市场：期货
- 日本市场：期货
- 外汇市场：外汇
bar_low
接口说明
获取指定标的指定周期的 K 线最低价。
bar_low(symbol, bar_type=BarType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-500 |
返回
返回类型：float
示例说明
获取苹果的最新 1 根 1 小时 K 线的最低价。
bar_low(symbol=Contract("US.AAPL"), bar_type=BarType.H1, select=1)
示例返回值
140.3
bar_custom
接口说明
将指定周期的多根 K 线聚合成 1 根 K 线，例如：自定义“8 小时 K”周期，是指每 8 根 1 小时 K 线聚合成 1 根 “8 小时 K”。
bar_custom(symbol, data_type=BarDataType.LOW, custom_num=4, custom_type=CustomType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| data_type | BarDataType | 数据类型 | BarDataType.CLOSE | — |
| custom_num | int | 自定义根数 | 4 | 1-200 |
| custom_type | CustomType | 自定义周期 | CustomType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-5 |
返回
返回类型：float
示例说明
获取苹果近 8 日的最低价。
bar_custom(symbol=Contract("US.AAPL"), data_type=BarDataType.LOW, custom_num=8, custom_type=CustomType.D1, select=1)
示例返回值
171.96
K 线成交量
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
- 美国市场：股票、ETFs、指数、板块、期权、期货
- A股市场：股票、ETFs、指数、板块
- 新加坡市场：期货
- 日本市场：期货
bar_volume
接口说明
获取指定标的指定周期的 K 线的成交量。
bar_volume(symbol, bar_type=BarType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-500 |
返回
返回类型：float
示例说明
获取苹果的最新 1 根 1 小时 K 线的成交量。
bar_volume(symbol=Contract("US.AAPL"), bar_type=BarType.H1, select=1)
示例返回值
1321039494
bar_custom
接口说明
将指定周期的多根 K 线聚合成 1 根 K 线，例如：自定义“8 小时 K”周期，是指每 8 根 1 小时 K 线聚合成 1 根 “8 小时 K”。
bar_custom(symbol, data_type=BarDataType.VOLUME, custom_num=4, custom_type=CustomType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| data_type | BarDataType | 数据类型 | BarDataType.CLOSE | — |
| custom_num | int | 自定义根数 | 4 | 1-200 |
| custom_type | CustomType | 自定义周期 | CustomType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-5 |
返回
返回类型：float
示例说明
获取苹果近 8 日的成交量。
bar_custom(symbol=Contract("US.AAPL"), data_type=BarDataType.VOLUME, custom_num=8, custom_type=CustomType.D1, select=1)
示例返回值
374480860
K 线成交额
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证
- 美国市场：股票、ETFs
- A股市场：股票、ETFs
bar_turnover
接口说明
获取指定标的指定周期的 K 线的成交额。
bar_turnover(symbol, bar_type=BarType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-500 |
返回
返回类型：float
示例说明
获取苹果的最新 1 根 1 小时 K 线的成交额。
bar_turnover(symbol=Contract("US.AAPL"), bar_type=BarType.H1, select=1)
示例返回值
2187750950.014
bar_custom
接口说明
将指定周期的多根 K 线聚合成 1 根 K 线，例如：自定义“8 小时 K”周期，是指每 8 根 1 小时 K 线聚合成 1 根 “8 小时 K”。
bar_custom(symbol, data_type=BarDataType.TURNOVER, custom_num=4, custom_type=CustomType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| data_type | BarDataType | 数据类型 | BarDataType.CLOSE | — |
| custom_num | int | 自定义根数 | 4 | 1-200 |
| custom_type | CustomType | 自定义周期 | CustomType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-5 |
返回
返回类型：float
示例说明
获取苹果近 8 日的成交额。
bar_custom(symbol=Contract("US.AAPL"), data_type=BarDataType.TURNOVER, custom_num=8, custom_type=CustomType.D1, select=1)
示例返回值
66086088532.94
K 线涨跌幅
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
- 美国市场：股票、ETFs、指数、板块、期权、期货
- A股市场：股票、ETFs、指数、板块
- 新加坡市场：期货
- 日本市场：期货
- 外汇市场：外汇
bar_chg_rate
接口说明
获取指定标的指定周期的 K 线的涨跌幅。
bar_chg_rate(symbol, bar_type=BarType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-500 |
返回
返回类型：float
示例说明
获取苹果的最新 1 根 1 小时 K 线的涨跌幅。
bar_chg_rate(symbol=Contract("US.AAPL"), bar_type=BarType.H1, select=1)
示例返回值
-0.00069
bar_custom
接口说明
将指定周期的多根 K 线聚合成 1 根 K 线，例如：自定义“8 小时 K”周期，是指每 8 根 1 小时 K 线聚合成 1 根 “8 小时 K”。
bar_custom(symbol, data_type=BarDataType.CHG_RATE, custom_num=4, custom_type=CustomType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| data_type | BarDataType | 数据类型 | BarDataType.CHG_RATE | — |
| custom_num | int | 自定义根数 | 4 | 1-200 |
| custom_type | CustomType | 自定义周期 | CustomType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-5 |
返回
返回类型：float
示例说明
获取苹果近 8 日的涨跌幅。
bar_custom(symbol=Contract("US.AAPL"), data_type=BarDataType.CHG_RATE, custom_num=8, custom_type=CustomType.D1, select=1)
示例返回值
0.021092
K 线涨跌额
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
- 美国市场：股票、ETFs、指数、板块、期权、期货
- A股市场：股票、ETFs、指数、板块
- 新加坡市场：期货
- 日本市场：期货
- 外汇市场：外汇
bar_chg
接口说明
获取指定标的指定周期的 K 线的涨跌额。
bar_chg(symbol, bar_type=BarType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-500 |
返回
返回类型：float
示例说明
获取苹果的最新 1 根 1 小时 K 线的涨跌额。
bar_chg(symbol=Contract("US.AAPL"), bar_type=BarType.H1, select=1)
示例返回值
-0.1
bar_custom
接口说明
将指定周期的多根 K 线聚合成 1 根 K 线，例如：自定义“8 小时 K”周期，是指每 8 根 1 小时 K 线聚合成 1 根 “8 小时 K”。
bar_custom(symbol, data_type=BarDataType.CHG, custom_num=4, custom_type=CustomType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| data_type | BarDataType | 数据类型 | BarDataType.CLOSE | — |
| custom_num | int | 自定义根数 | 4 | 1-200 |
| custom_type | CustomType | 自定义周期 | CustomType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-5 |
返回
返回类型：float
示例说明
获取苹果近 8 日的涨跌额。
bar_custom(symbol=Contract("US.AAPL"), data_type=BarDataType.CHG, custom_num=8, custom_type=CustomType.D1, select=1)
示例返回值
3.75
K 线换手率
适用市场
- 香港市场：股票
- 美国市场：股票
- A股市场：股票
bar_turnover_rate
接口说明
获取指定标的指定周期的 K 线的换手率。
公式：换手率 = (K 线成交股数 / 当时的流通股股数) × 100%
含义：指在一定时间内市场中股票转手买卖的频率，是反映股票流通性强弱的指标之一。
仅提供了日 K 及以上级别的 K 线换手率，暂未提供小时 K 和分 K 的换手率。
bar_turnover_rate(symbol, bar_type=BarType.D1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| bar_type | BarType | K 线周期 | BarType.D1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-500 |
返回
返回类型：float
示例说明
获取苹果的倒数第 2 根 日 K 线的换手率。
bar_turnover_rate(symbol=Contract("US.AAPL"), bar_type=BarType.D1, select=2)
示例返回值
0.00261
bar_custom
接口说明
将指定周期的多根 K 线聚合成 1 根 K 线，例如：自定义“8 日 K”周期，是指每 8 根 日 K 线聚合成 1 根 “8 日 K”。
bar_custom(symbol, data_type=BarDataType.TURNOVER_RATE, custom_num=1, custom_type=CustomType.D1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| data_type | BarDataType | 数据类型 | BarDataType.TURNOVER_RATE | — |
| custom_num | int | 自定义根数 | 1 | 1-200 |
| custom_type | CustomType | 自定义周期 | CustomType.D1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-5 |
返回
返回类型：float
示例说明
获取苹果近 8 日的换手率。
bar_custom(symbol=Contract("US.AAPL"), data_type=BarDataType.TURNOVER_RATE, custom_num=8, custom_type=CustomType.D1, select=1)
示例返回值
0.00417
摆盘委托数量
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证、期权、期货
- 美国市场：股票、ETFs、期权、期货
- A股市场：ETFs、股票
- 新加坡市场：期货
- 日本市场：期货
bid_qty
接口说明
获取指定标的第 n 档的买盘委托数量。
bid_qty(symbol, level=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| level | int | 第几档 | 1 | 1-50 |
返回
返回类型：float
示例说明
获取苹果的第 1 档买盘委托数量。
bid_qty(symbol=Contract("US.AAPL"), level=1)
示例返回值
100
ask_qty
接口说明
获取指定标的第 n 档的卖盘委托数量。
ask_qty(symbol, level=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| level | int | 第几档 | 1 | 1-50 |
返回
返回类型：float
示例说明
获取苹果的第 1 档卖盘委托数量。
ask_qty(symbol=Contract("US.AAPL"), level=1)
示例返回值
1700
摆盘委托订单数量
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证、期权、期货
bid_order_qty
接口说明
获取指定标的第 n 档的买盘委托订单数量。
摆盘委托订单数量仅支持香港市场股票、期货、期权，获取摆盘委托订单数量需要香港 LV2 及以上权限。
bid_order_qty(symbol, level=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| level | int | 第几档 | 1 | 1-50 |
返回
返回类型：float
示例说明
获取苹果的第 1 档买盘委托订单数量。
bid_order_qty(symbol=Contract("US.AAPL"), level=1)
示例返回值
284
ask_order_qty
接口说明
获取指定标的第 n 档的卖盘委托订单数量。
摆盘委托订单数量仅支持香港市场股票、期货、期权，获取摆盘委托订单数量需要香港 LV2 及以上权限。
ask_order_qty(symbol, level=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| level | int | 第几档 | 1 | 1-50 |
返回
返回类型：float
示例说明
获取苹果的第 1 档卖盘委托订单数量。
ask_order_qty(symbol=Contract("US.AAPL"), level=1)
示例返回值
212
振幅
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
- 美国市场：股票、ETFs、指数、板块、期权、期货
- A股市场：股票、ETFs、指数、板块
- 新加坡市场：期货
- 日本市场：期货
- 外汇市场：外汇
amplitude
接口说明
获取指定标的的振幅。
公式：振幅 = （当日最高点的价格 － 当日最低点的价格） / 昨天收盘价 × 100%
含义：指股票开盘后的当日最高价和最低价之间的差的绝对值与前一日收盘价的百分比，它在一定程度上表现股票的活跃程度。
仅提供盘中时段的振幅。
amplitude(symbol)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| price_type（已废弃） | THType | 时段类型 | THType.FTH | — |
返回
返回类型：float
示例说明
获取苹果的振幅。
amplitude(symbol=Contract("US.AAPL"))
示例返回值
0.02661
委比
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证、期权
- 美国市场：股票、ETFs、期权、期货
- A股市场：股票、ETFs
- 新加坡市场：期货
- 日本市场：期货
rate_ratio
接口说明
获取委比。
公式：委比 = (委买手数 － 委卖手数) / (委买手数 + 委卖手数) × 100%
含义：指在报价系统之上的所有买卖单之比，用以衡量一段时间内买卖盘相对力量的强弱。
rate_ratio(symbol)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
返回
返回类型：float
示例说明
获取特斯拉期权的委比。
rate_ratio(symbol=Contract("US.TSLA230728C230000"))
示例返回值
-0.00971
量比
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证、期权、指数
- 美国市场：股票、ETFs、期权、指数
- A股市场：股票、ETFs、指数
volume_ratio
接口说明
获取量比。
公式：量比 = （现成交总手数 / 现累计开市时间(分) ） / 过去 5 日平均每分钟成交量
含义：指股市开市后平均每分钟的成交量与过去 5 个交易日平均每分钟成交量之比。量比是衡量相对成交量的指标。
volume_ratio(symbol)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
返回
返回类型：float
示例说明
获取特斯拉期权的量比。
volume_ratio(symbol=Contract("US.TSLA230728C230000"))
示例返回值
3.001
最小变动价格
适用市场
- 香港市场：期货、期权、界内证、窝轮、牛熊证、ETFs、股票
- 美国市场：期权、期货、ETFs、股票
- A股市场：股票、ETFs
- 新加坡市场：期货
- 日本市场：期货
min_tick
接口说明
获取指定标的的最小变动价格。
不同品类的标的，其最小变动价格规则都不同。这个接口可以用于获取指定标的的最小变动价格。
例如：美股 1 美元以上的股票的最小变动价格是 0.01，1 美元以下的股票的最小变动价格是 0.0001。点击可以查看港股的最小变动价格。
min_tick(symbol)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
返回
返回类型：float
示例说明
获取苹果的最小变动价格。
min_tick(symbol=Contract("US.AAPL"))
示例返回值
0.01
中间价
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证、期权、期货
- 美国市场：股票、ETFs、期权、期货
- A股市场：股票、ETFs
- 新加坡市场：期货
- 日本市场：期货
mid_price
接口说明
获取指定标的 bid 和 ask 的中间价。
mid_price(symbol)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
返回
返回类型：float
示例说明
获取苹果的买卖盘中间价。
mid_price(symbol=Contract("US.AAPL"))
示例返回值
151.945
所属交易时段
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
- 美国市场：股票、ETFs、指数、板块、期权、期货
- A股市场：股票、ETFs、指数、板块
- 新加坡市场：期货
- 日本市场：期货
- 外汇市场：外汇
trading_session
接口说明
获取指定标的当前交易时段。
trading_session(symbol)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
返回
返回类型：TrdHours
示例说明
获取 “US.AAPL” 的当前交易时段。
trading_session(Contract("US.AAPL"))
示例返回值
CLOSED
当前时间
device_time
接口说明
获取当前设备时间。
device_time(TimeZone.DEVICE_TIME_ZONE)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| time_zone | TimeZone | 时区 | TimeZone.DEVICE_TIME_ZONE | — |
返回
返回类型：datetime
示例说明
获取本设备的当前时间。
devicetime = device_time(TimeZone.DEVICE_TIME_ZONE)
print(devicetime)
print(devicetime.strftime("%Y-%m-%d %H:%M:%S")) # 格式化日期和时间
print(devicetime.hour) # 打印小时
print(devicetime.minute) # 打印分钟
print(devicetime.second) # 打印秒
示例返回值
2023-07-31 09:30:00-04:00
2023-07-31 09:30:00
9
30
0
is_the_time
接口说明
判断当前时间是否早于或晚于指定时间。
is_the_time(Orientation, hour, min, sec, year, month, day, time_zone=TimeZone.DEVICE_TIME_ZONE)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| Orientation | TimeOrientation | 时间判断方向 | — | — |
| hour | int | 时 | — | 0-23 |
| min | int | 分 | — | 0-59 |
| sec | int | 秒 | — | 0-59 |
| year | int | 年 | — | 1970-2050 |
| month | int | 月 | — | 1-12 |
| day | int | 日 | — | 1-31 |
| time_zone | TimeZone | 时区 | TimeZone.DEVICE_TIME_ZONE | — |
返回
返回类型：Boolean
示例说明
判断当前时间是否在 UTC+8 的 9:46:49 之后。
is_the_time(hour=9, min=46, orientation=TimeOrientation.LATER_THAN, sec=49, time_zone=TimeZone.UTC_PLUS_8)
示例返回值
True
is_the_day
接口说明
判断当前时间是否处于指定时间（日）。
is_the_day(day, time_zone=TimeZone.DEVICE_TIME_ZONE)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| day | list | 日 | — | 1-31 |
| time_zone | TimeZone | 时区 | TimeZone.DEVICE_TIME_ZONE | — |
返回
返回类型：Boolean
示例说明
判断当前时间是否在 UTC+8 的 1 日或 2 日。
is_the_day(day=[1,2], time_zone=TimeZone.UTC_PLUS_8)
示例返回值
True
is_the_week
接口说明
判断当前时间是否处于指定时间（周）。
is_the_week(week, time_zone=TimeZone.DEVICE_TIME_ZONE)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| week | list | 周 | — | 1-7 |
| time_zone | TimeZone | 时区 | TimeZone.DEVICE_TIME_ZONE | — |
示例说明
判断当前时间是否在 UTC+8 的周一或周二。
is_the_week(time_zone=TimeZone.UTC_PLUS_8, week=[1,2])
示例返回值
True
is_the_month
接口说明
判断当前时间是否处于指定时间（月）。
is_the_month(month, time_zone=TimeZone.DEVICE_TIME_ZONE)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| month | list | 月 | — | 1-12 |
| time_zone | TimeZone | 时区 | TimeZone.DEVICE_TIME_ZONE | — |
示例说明
判断当前时间是否在 UTC+8 的 1 月或 2 月。
is_the_month(month=[1,2], time_zone=TimeZone.UTC_PLUS_8)
示例返回值
True
is_the_year
接口说明
判断当前时间是否处于指定时间（年）。
is_the_year(year, time_zone=TimeZone.DEVICE_TIME_ZONE)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| year | list | 年 | — | 1970-2050 |
| time_zone | TimeZone | 时区 | TimeZone.DEVICE_TIME_ZONE | — |
示例说明
判断当前时间是否在 UTC+8 的 2023 或 2024 年。
is_the_year(time_zone=TimeZone.UTC_PLUS_8, year=[2023,2024])
示例返回值
True
每手股数
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证、期货、期权
- 美国市场：股票、ETFs、期货、期权
- A股市场：股票、ETFs
- 新加坡市场：期货
- 日本市场：期货
lot_size
接口说明
获取指定标的的每手股数。
美股 1 手等于 1 股，港股不同股票的每手股数不同，A 股 1 手等于 100 股。
期货、期权标的：1 手等于 1 张等于 1 股。
lot_size(symbol)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
返回
返回类型：float
示例说明
获取苹果的每手股数。
lot_size(symbol=Contract("US.AAPL"))
示例返回值
1
是否停牌
适用市场
- 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
- 美国市场：股票、ETFs、指数、板块、期权、期货
- A股市场：股票、ETFs、指数、板块
- 新加坡市场：期货
- 日本市场：期货
- 外汇市场：外汇
is_suspended
接口说明
获取是否停牌。
股票由于某种消息或进行某种活动引起股价的连续上涨或下跌，由证券交易所暂停其在股票市场上进行交易。待情况澄清或企业恢复正常后，再复牌在交易所挂牌交易。
is_suspended(symbol)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
返回
返回类型：Bool
示例说明
获取恒指花旗三乙牛I.C的是否停牌。
is_suspended(symbol=Contract("HK.68647"))
示例返回值
False
是否允许融资
适用市场
- 香港市场：股票、ETFs
- 美国市场：股票、ETFs
- A股市场：股票、ETFs
is_marginable
接口说明
判断指定标的是否允许融资。
is_marginable(symbol)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
返回
返回类型：Boolean
示例说明
判断苹果是否允许融资。
is_marginable("US.AAPL")
示例返回值
True
是否允许融券
适用市场
- 香港市场：股票、ETFs
- 美国市场：股票、ETFs
- A股市场：股票、ETFs
is_shortable
接口说明
判断指定标的是否允许融券。
is_shortable(symbol)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
返回
返回类型：Boolean
示例说明
判断苹果是否允许融券。
is_shortable("US.AAPL")
示例返回值
True
卖空池剩余数量
适用市场
- 香港市场：股票、ETFs
- 美国市场：股票、ETFs
short_pool_remaining
接口说明
获取指定标的的卖空池剩余数量。
short_pool_remaining(symbol)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
返回
返回类型：float
示例说明
获取苹果的卖空池剩余数量。
short_pool_remaining("US.AAPL")
示例返回值
10000000
融资初始保证金率
适用市场
• 香港市场：股票、ETFs
• 美国市场：股票、ETFs
• A股市场：股票、ETFs
initial_marginratio_long
接口说明
获取指定标的的融资初始保证金率。
initial_marginratio_long(symbol)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
返回
返回类型： float
示例说明
获取苹果的融资初始保证金率。
initial_marginratio_long("US.AAPL")
示例返回值
0.4
融券初始保证金率
适用市场
• 香港市场：股票、ETFs
• 美国市场：股票、ETFs
initial_marginratio_short
接口说明
获取指定标的的融券初始保证金率。
initial_marginratio_short(symbol)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
返回
返回类型： float
示例说明
获取苹果的融券初始保证金率。
initial_marginratio_short(Contract("US.AAPL"))
示例返回值
0.4
融券参考利率
适用市场
• 香港市场：股票、ETFs
• 美国市场：股票、ETFs
short_interest_rate
接口说明
获取指定标的的融券参考利率。
short_interest_rate(symbol)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
返回
返回类型： float
示例说明
获取苹果的融券参考利率。
short_interest_rate("US.AAPL")
示例返回值
0.03
融资维持保证金率
适用市场
• 香港市场：股票、ETFs
• 美国市场：股票、ETFs
• A股市场：ETFs、股票
maint_marginratio_long
接口说明
获取指定标的的融资维持保证金率。
maint_marginratio_long(symbol)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
返回
返回类型： float
示例说明
获取苹果的融资维持保证金率。
maint_marginratio_long("US.AAPL")
示例返回值
0.3
融券维持保证金率
适用市场
• 香港市场：股票、ETFs
• 美国市场：股票、ETFs
maint_marginratio_short
接口说明
获取指定标的的融券维持保证金率。
maint_marginratio_short(symbol)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
返回
返回类型： float
示例说明
获取苹果的融券维持保证金率。
maint_marginratio_short("US.AAPL")
示例返回值
0.3
MA
适用市场
• 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
• 美国市场：股票、ETFs、指数、板块、期权、期货
• A股市场：股票、ETFs、指数、板块
• 新加坡市场：期货
• 日本市场：期货
• 外汇市场：外汇
ma
接口说明
获取指定标的指定 K 线周期下的 MA 值。
ma(symbol, period=5, bar_type=BarType.H1, data_type=DataType.CLOSE, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| period | int | 移动平均周期 | 5 | 1-500 |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
| data_type | DataType | 数据类型 | DataType.CLOSE | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-500 |
返回
返回类型： float
示例说明
获取苹果的最新 1 根 1 小时 K 线上收盘价在移动平均周期为 5 的 MA 值。
ma(bar_type=BarType.H1, symbol=Contract("US.AAPL"), data_type=DataType.CLOSE, period=5, select=1)
示例返回值
155.18492
is_ma_bearish_alignment
接口说明
判断指定标的的 MA 形态是否是空头排列。
is_ma_bearish_alignment(symbol, bar_type=BarType.H1, data_type=DataType.CLOSE)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
| data_type | DataType | 数据类型 | DataType.CLOSE | — |
返回
返回类型： Boolean
示例说明
判断苹果的 1 小时 K 线收盘价 MA 形态是否是空头排列。
is_ma_bearish_alignment(bar_type=BarType.H1, symbol=Contract("US.AAPL"), data_type=DataType.CLOSE)
示例返回值
False
EMA
适用市场
• 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
• 美国市场：股票、ETFs、指数、板块、期权、期货
• A股市场：股票、ETFs、指数、板块
• 新加坡市场：期货
• 日本市场：期货
• 外汇市场：外汇
ema
接口说明
获取指定标的指定 K 线周期下的 EMA 值。
ema(symbol, period=5, bar_type=BarType.H1, data_type=DataType.CLOSE, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| period | int | 移动平均周期 | 5 | 1-500 |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
| data_type | DataType | 数据类型 | DataType.CLOSE | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-500 |
返回
返回类型： float
示例说明
获取苹果的最新 1 根 1 小时 K 线上收盘价在移动平均周期为 5 的 EMA 值。
ema(bar_type=BarType.H1, symbol=Contract("US.AAPL"), data_type=DataType.CLOSE, period=5, select=1)
示例返回值
154.72797
is_ema_bearish_alignment
接口说明
判断指定标的的 EMA 形态是否是空头排列。
is_ema_bearish_alignment(symbol, bar_type=BarType.H1, data_type=DataType.CLOSE)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
| data_type | DataType | 数据类型 | DataType.CLOSE | — |
返回
返回类型： Boolean
示例说明
判断苹果的 1 小时 K 线收盘价 EMA 形态是否是空头排列。
is_ema_bearish_alignment(bar_type=BarType.H1, symbol=Contract("US.AAPL"), data_type=DataType.CLOSE)
示例返回值
False
MACD
适用市场
• 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
• 美国市场：股票、ETFs、指数、板块、期权、期货
• A股市场：股票、ETFs、指数、板块
• 新加坡市场：期货
• 日本市场：期货
• 外汇市场：外汇
macd_dea
接口说明
获取指定标的的 MACD 的 DEA 值。
macd_dea(symbol, fast_period=12, slow_period=26, signal_period=9, bar_type=BarType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| fast_period | int | 短周期 | 12 | 1-500 |
| slow_period | int | 长周期 | 26 | 1-500 |
| signal_period | int | 移动平均周期 | 9 | 1-500 |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-500 |
返回
返回类型：float
示例说明
获取苹果 1 小时 K 线的 MACD 的 DEA 值。
macd_dea(symbol=Contract("US.AAPL"), fast_period=12, slow_period=26, signal_period=9, bar_type=BarType.H1, select=1)
示例返回值
2.63327
is_macd_golden_cross
接口说明
判断指定标的的 MACD 形态是否是金叉。
is_macd_golden_cross(symbol, fast_period=12, slow_period=26, signal_period=9, bar_type=BarType.H1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| fast_period | int | 短周期 | 12 | 1-500 |
| slow_period | int | 长周期 | 26 | 1-500 |
| signal_period | int | 移动平均周期 | 9 | 1-500 |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
返回
返回类型：Boolean
示例说明
判断苹果 1 小时 K 线的 MACD 形态（短周期 12，长周期 26，移动平均周期 9）是否为金叉。
is_macd_golden_cross(symbol=Contract("US.AAPL"), fast_period=12, slow_period=26, signal_period=9, bar_type=BarType.H1)
示例返回值
True
is_macd_top_divergence
接口说明
判断指定标的的 MACD 形态是否是顶背离。
is_macd_top_divergence(symbol, fast_period=12, slow_period=26, signal_period=9, bar_type=BarType.H1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| fast_period | int | 短周期 | 12 | 1-500 |
| slow_period | int | 长周期 | 26 | 1-500 |
| signal_period | int | 移动平均周期 | 9 | 1-500 |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
返回
返回类型：Boolean
示例说明
判断苹果 1 小时 K 线的 MACD 形态（短周期 12，长周期 26，移动平均周期 9）是否为顶背离。
is_macd_top_divergence(symbol=Contract("US.AAPL"), fast_period=12, slow_period=26, signal_period=9, bar_type=BarType.H1)
示例返回值
False
RSI
适用市场
• 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
• 美国市场：股票、ETFs、指数、板块、期权、期货
• A股市场：股票、ETFs、指数、板块
• 新加坡市场：期货
• 日本市场：期货
• 外汇市场：外汇
is_rsi_death_cross
接口说明
判断指定标的的 RSI 形态是否高位死叉。
is_rsi_death_cross(symbol, fast_period=6, slow_period=12, bar_type=BarType.H1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| fast_period | int | 移动平均周期 | 6 | 1-500 |
| slow_period | int | 移动平均周期 | 12 | 1-500 |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
返回
返回类型：Boolean
示例说明
判断苹果 1 小时 K 线的 RSI 形态是否高位死叉。
is_rsi_death_cross(symbol=Contract("US.AAPL"), fast_period=6, slow_period=12, bar_type=BarType.H1)
示例返回值
True
is_rsi_bottom_divergence
接口说明
判断指定标的的 RSI 形态是否底背离。
is_rsi_bottom_divergence(symbol, period=12, bar_type=BarType.H1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| period | int | 移动平均周期 | 12 | 1-500 |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
返回
返回类型：Boolean
示例说明
判断苹果 1 小时 K 线的 RSI 形态是否底背离。
is_rsi_bottom_divergence(symbol=Contract("US.AAPL"), period=12, bar_type=BarType.H1)
示例返回值
False
BOLL
适用市场
• 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
• 美国市场：股票、ETFs、指数、板块、期权、期货
• A股市场：股票、ETFs、指数、板块
• 新加坡市场：期货
• 日本市场：期货
• 外汇市场：外汇
is_boll_cross_below_lower
接口说明
判断指定标的的 Boll 形态是否突破下轨。
is_boll_cross_below_lower(symbol, period=20, deviation=2, bar_type=BarType.H1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| period | int | 计算周期 | 20 | 1-500 |
| deviation | float | 股票特性参数 | 2 | 0-5 |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
返回
返回类型：Boolean
示例说明
判断苹果的 1 小时 K 线的 Boll 形态是否突破下轨。
is_boll_cross_below_lower(bar_type=BarType.H1, symbol=Contract("US.AAPL"), deviation=2, period=20)
示例返回值
True
is_boll_cross_below_middle
接口说明
判断指定标的的 Boll 形态是否向下突破中轨。
is_boll_cross_below_middle(symbol, period=20, deviation=2, bar_type=BarType.H1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| period | int | 计算周期 | 20 | 极速500 |
| deviation | float | 股票特性参数 | 2 | 0-5 |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
返回
返回类型：Boolean
示例说明
判断苹果的 1 小时 K 线的 Boll 形态是否向下突破中轨。
is_boll_cross_below_middle(bar_type=极速H1, symbol=Contract("US.AAPL"), deviation=2, period=20)
示例返回值
True
boll_mid
接口说明
获取指定标的的 Boll 中轨值。
boll_mid(symbol极速, period=20, deviation=2, bar_type=BarType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| period | int | 计算周期 | 20 | 1-500 |
| deviation | float | 股票特性参数 | 2 | 0-500 |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-500 |
返回
返回类型：float
示例说明
获取苹果的最新 1 根 1 小时 K 线的 Boll 的 mid 值。
boll_mid(bar_type=BarType.H1, symbol=Contract("US.AAPL"), deviation=2, period=20, select=1)
示例返回值
149.91906
KDJ
适用市场
• 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
• 美国市场：股票、ETFs、指数、板块、期权、期货
• A股市场：股票、ETFs、指数、板块
• 新加坡市场：期货
• 日本市场：期货
• 外汇市场：外汇
is_kdj_death_cross
接口说明
判断指定标的的 KDJ 形态是否高位死叉。
is_kdj_death_cross(symbol, k_period=9, d_period=3, slowing=3, bar_type=BarType.H1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| k_period | int | 计算周期 | 9 | 1-500 |
| d_period | int | 移动平均周期 | 3 | 1-500 |
| slowing | int | 移动平均周期 | 3 | 1-500 |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
返回
返回类型：Boolean
示例说明
判断苹果以 1 小时 K 线为周期的 KDJ 形态是否是高位死叉。
is_kdj_death_cross(bar_type=BarType.H1, symbol=Contract("US.AAPL"), d_period=3, k_period=9, slowing=3)
示例返回值
True
is_kdj_bottom_divergence
接口说明
判断指定标的的 KDJ 形态是否底背离。
is_kdj_bottom_divergence(symbol, k_period=9, d_period=3, slowing=3, bar_type=BarType.H1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| k_period | int | 计算周期 | 9 | 1-500 |
| d_period | int | 移动平均周期 | 3 | 1-500 |
| slowing | int | 移动平均周期 | 3 | 1-500 |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
返回
返回类型：Boolean
示例说明
判断苹果以 1 小时 K 线为周期的 KDJ 形态是否是底背离。
is_kdj_bottom_divergence(bar_type=BarType.H1, symbol=Contract("US.AAPL"), d_period=3, k_period=9, slowing=3)
示例返回值
True
kdj_d
接口说明
获取指定标的的 KDJ 的 D 值。
kdj_d(symbol, k_period=9, d_period=3, slowing=3, bar_type=BarType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| k_period | int | 计算周期 | 9 | 1-500 |
| d_period | int | 移动平均周期 | 3 | 1-500 |
| slowing | int | 移动平均周期 | 3 | 1-500 |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-500 |
返回
返回类型：float
示例说明
获取苹果以 1 小时 K 线为周期的 KDJ 的 D 值。
kdj_d(bar_type=BarType.H1, symbol=Contract("US.AAPL"), d_period=3, k_period=9, select=1, slowing=3)
示例返回值
81.55649
ATR 真实波幅
适用市场
• 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
• 美国市场：股票、ETFs、指数、板块、期权、期货
• A股市场：股票、ETFs、指数、板块
• 新加坡市场：期货
• 日本市场：期货
• 外汇市场：外汇
atr_atr
接口说明
获取指定标的的 ATR 的 ATR 值。
atr_atr(symbol, period=14, bar_type=BarType.H1, select=1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| period | int | 移动平均周期 | 14 | 1-500 |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
| select | int | 选取倒数第几根 K 线数据 | 1 | 1-500 |
返回
返回类型：float
示例说明
获取苹果 1 小时 K 线的 ATR 的 ATR 值。
atr_atr(symbol=Contract("US.AAPL"), period=14, bar_type=BarType.H1, select=1)
示例返回值
2.17159
VOLAT 历史波动率
适用市场
• 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
• 美国市场：股票、ETFs、指数、板块、期权、期货
• A股市场：股票、ETFs、指数、板块
• 新加坡市场：期货
• 日本市场：期货
• 外汇市场：外汇
–
VWAP 成交量加权平均价
适用市场
• 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
• 美国市场：股票、ETFs、指数、板块、期权、期货
• A股市场：股票、ETFs、指数、板块
• 新加坡市场：期货
• 日本市场：期货
–
NINE 神奇九转
适用市场
• 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
• 美国市场：股票、ETFs、指数、板块、期权、期货
• A股市场：股票、ETFs、指数、板块
• 新加坡市场：期货
• 日本市场：期货
• 外汇市场：外汇
is_nine_down_structure
接口说明
判断指定标的的 NINE 是否满足下跌 9 结构。
is_nine_down_structure(symbol, bar_type=BarType.H1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
返回
返回类型：Boolean
示例说明
判断苹果 1 小时 K 线的形态是否满足下跌 9 结构。
is_nine_down_structure(symbol=Contract("US.AAPL"), bar_type=BarType.H1)
示例返回值
False
SAR 停损点转向指标
适用市场
• 香港市场：股票、ETFs、窝轮、牛熊证、界内证、指数、板块、期权、期货
• 美国市场：股票、ETFs、指数、板块、期权、期货
• A股市场：股票、ETFs、指数、板块
• 新加坡市场：期货
• 日本市场：期货
• 外汇市场：外汇
is_sar_down_trend
接口说明
判断指定标的的 SAR 是否满足下跌趋势。
is_sar_down_trend(symbol, period=4, step=2, maximum=20, bar_type=BarType.H1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| period | int | 计算周期 | 4 | 1-100 |
| step | float | 步长 | 2 | 1-100 |
| maximum | float | 极限值 | 20 | 1-100 |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
返回
返回类型：Boolean
示例说明
判断苹果 1 小时 K 线的 SAR 在停损点是否满足下跌趋势。
is_sar_down_trend(symbol=Contract("US.AAPL"), period=4, step=2, maximum=20, bar_type=BarType.H1)
示例返回值
True
is_sar_bearish_reversal
接口说明
判断指定标的的 SAR 是否是由跌转涨。
is_sar_bearish_reversal(symbol, period=4, step=2, maximum=20, bar_type=BarType.H1)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| symbol | Contract | 标的 | — | — |
| period | int | 计算周期 | 4 | 1-100 |
| step | float | 步长 | 2 | 1-100 |
| maximum | float | 极限值 | 20 | 极值 |
| bar_type | BarType | K 线周期 | BarType.H1 | — |
返回
返回类型：Boolean
示例说明
判断苹果 1 小时 K 线的 SAR 在停损点是否是由跌转涨。
is_sar_bearish_reversal(symbol=Contract("US.AAPL"), period=4, step=2, maximum=20, bar_type=BarType.H1)
示例返回值
False
资产净值
net_asset
接口说明
获取当前账户的资产净值。
net_asset(currency=Currency.HKD)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| currency | Currency | 计价货币 | Currency.HKD | — |
返回
返回类型：float
示例说明
获取当前账户的资产净值。
net_asset(currency=Currency.HKD)
示例返回值
20380
证券市值
market_value_security
接口说明
获取当前账户的证券市值。
证券市值：账户持仓中股票与证券衍生品的市值总和。
market_value_security(currency=Currency.HKD)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| currency | Currency | 计价货币 | Currency.HKD | — |
返回
返回类型：float
示例说明
获取当前账户的证券市值。
market_value_security(currency=Currency.HKD)
示例返回值
20000
总现金
total_cash
接口说明
获取当前账户（以某个币种计价）的总现金。
total_cash(currency=Currency.HKD)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| currency | Currency | 计价货币 | Currency.HKD | — |
返回
返回类型：float
示例说明
获取当前账户（以 HKD 计价）的总现金。
total_cash(currency=Currency.HKD)
示例返回值
20380
最大购买力
max_buying_power
接口说明
获取当前账户（以某个币种计价）的最大购买力。
最大购买力：代表账户最高的购买力水平，即：买入杠杆比率最大的股票的可用金额，买入不同股票的实际购买力可能会小于最大购买力。
是按照 50% 的融资初始保证金率计算得到的近似值。但事实上，每个标的的融资保证金率并不相同，买入不同股票所需实际购买力可能会大于最大购买力。
建议使用“最大可买”卡片，获取指定标的最多可买入多少股。
max_buying_power(currency=Currency.HKD)
参数
| 参数名 | 类型 | 说明 | 默认值 | 范围 |
|---|---|---|---|---|
| currency | Currency | 计价货币 | Currency.HKD | — |
返回
返回类型：float
示例说明
获取当前账户（以 HKD 计价）的最大购买力。
max_buying_power(currency=Currency.HKD)
示例返回值
10000
风险状态
risk_status
接口说明
获取当前账户的风险状态。
risk_status()
参数
无参数。
返回
返回类型：CltRiskStatus
示例说明
获取当前账户的风险状态。
risk_status()
示例返回值
LEVEL1
发表回复
要发表评论，您必须先登录。