基础API¶

SysConfig - 系统配置¶

class SysConfig¶

对python api系统参数进行配置

set_client_info¶

set_client_info(cls, client_id, client_ver)¶

设置调用api的client信息, 非必调接口

Parameters:	client_id – str, client的标识 client_ver – int, client的版本号
Returns:	None
Example:

from futu import *
SysConfig.set_client_info("MyFutuAPI", 0)
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
quote_ctx.close()

set_proto_fmt¶

set_proto_fmt(cls, proto_fmt)¶

设置通讯协议body格式, 目前支持Protobuf | Json两种格式, 非必调接口

Parameters:	proto_fmt – ProtoFMT
Returns:	None
Example:

from futu import *
SysConfig.set_proto_fmt(ProtoFMT.Protobuf)
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
quote_ctx.close()

enable_proto_encrypt¶

enable_proto_encrypt(cls, is_encrypt)¶

设置通讯协议是否加密，网关客户端和api需配置相同的RSA私钥文件，在连接初始化成功后，网关会下发随机生成的AES 加密密钥。

每种context（例如OpenQuoteContext）可以单独设置自己是否加密。如果不设置，则使用这里的全局设置。即Context的加密设置优先级更高。

如果FutuOpenD配置了RSA私钥文件（rsa_private_key），那么客户端不管是否在这里启用全局加密，还是每个context自己设置加密，都需要调用SysConfig.set_init_rsa_file来设置RSA私钥文件。

Parameters:	is_encrypt – bool
Returns:	None
Example:

from futu import *
SysConfig.enable_proto_encrypt(True)
SysConfig.set_init_rsa_file("conn_key.txt")   # rsa 私钥文件路径
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
quote_ctx.close()

set_init_rsa_file¶

set_init_rsa_file(cls, file)¶

设置RSA私钥文件, 要求1024位, 格式为PKCS#1

Parameters:	file – str, 文件路径
Returns:	None
Example:

from futu import *
SysConfig.enable_proto_encrypt(True)
SysConfig.set_init_rsa_file("conn_key.txt")   # rsa 私钥文件路径
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
quote_ctx.close()

set_all_thread_daemon¶

set_all_thread_daemon(cls, all_daemon)¶

设置是否所有内部创建的线程都是daemon线程。在主线程退出后，如果其余线程都是daemon线程，则进程退出。否则进程仍会继续运行。如果不设置，默认内部会创建非daemon线程。默认情况下，行情和交易的context连接上FutuOpenD后，如果不调用close，即使主线程退出，进程也不会退出。因此，如果行情和交易的context设置了接收数据推送，并且也设置了daemon线程，则要自己保证主线程存活，否则进程将退出，也就不会再收到推送数据了。

Parameters:	all_daemon – bool, 是否所有内部线程都是daemon线程
Returns:	None
Example:

from futu import *
SysConfig.set_all_thread_daemon(True)
quote_ctx = OpenQuoteContext(host='127.0.0.1', port=11111)
# 不调用quote_ctx.close()，进程也会退出

枚举常量¶

AuType - K线复权类型¶

K线复权定义

class AuType¶

QFQ¶: 前复权

HFQ¶: 后复权

NONE¶: 不复权

DarkStatus - 暗盘状态¶

暗盘状态定义

class DarkStatus¶

NONE¶: 无暗盘交易

TRADING¶: 暗盘交易中

END¶: 暗盘交易结束

GtwEventType - 网关异步通知类型¶

网关异步通知类型定义

class GtwEventType¶

LocalCfgLoadFailed¶: 本地配置文件加载失败

APISvrRunFailed¶: 网关监听服务运行失败

ForceUpdate¶: 强制升级网关

LoginFailed¶: 登录牛牛服务器失败

UnAgreeDisclaimer¶: 未同意免责声明，无法加运行

NetCfgMissing¶: 缺少网络连接配置

KickedOut¶: 登录被踢下线

LoginPwdChanged¶: 登陆密码变更

BanLogin¶: 牛牛后台不允许该账号登陆

NeedPicVerifyCode¶: 登录需要输入图形验证码

NeedPhoneVerifyCode¶: 登录需要输入手机验证码

AppDataNotExist¶: 程序打包数据丢失

NessaryDataMissing¶: 必要的数据没同步成功

TradePwdChanged¶: 交易密码变更通知

EnableDeviceLock¶: 需启用设备锁

ProgramStatusType - 程序运行状态通知类型¶

程序运行状态通知类型定义

class GtwEventType

NONE¶: 未知类型

LOADED¶: 已完成类似加载配置,启动服务器等操作,服务器启动之前的状态无需返回

LOGING¶: 登录中

NEED_PIC_VERIFY_CODE¶: 需要图形验证码

NEED_PHONE_VERIFY_CODE¶: 需要手机验证码

LOGIN_FAILED¶: 登录失败,详细原因在描述返回

FORCE_UPDATE¶: 客户端版本过低

NESSARY_DATA_PREPARING¶: 正在拉取类似免责声明等一些必要信息

NESSARY_DATA_MISSING¶: 缺少必要信息

UN_AGREE_DISCLAIMER¶: 未同意免责声明

READY¶: 可以接收业务协议收发,正常可用状态

IpoPeriod - 涡轮上市日¶

涡轮上市日定义

class IpoPeriod¶

NONE¶: 未知

TODAY¶: 今日上市

TOMORROW¶: 明日上市

NEXTWEEK¶: 未来一周上市

LASTWEEK¶: 过去一周上市

LASTMONTH¶: 过去一月上市

Issuer - 发行人过滤列表¶

发行人过滤列表

class Issuer¶

NONE¶: 未知

SG¶: 法兴

BP¶: 法巴

CS¶: 瑞信

CT¶: 花旗

EA¶: 东亚

GS¶: 高盛

HS¶: 汇丰

JP¶: 摩通

MB¶: 麦银

SC¶: 渣打

UB¶: 瑞银

BI¶: 中银

DB¶: 德银

DC¶: 大和

ML¶: 美林

NM¶: 野村

RB¶: 荷合

RS¶: 苏皇

BC¶: 巴克莱

HT¶: 海通

VT¶: 瑞通

KC¶: 比联

MS¶: 摩利

KLDataStatus - k线数据状态¶

指定时间点取历史k线，获得数据的实际状态

class KLDataStatus¶

NONE¶: 无效数据

CURRENT¶: 当前时间周期数据

PREVIOUS¶: 前一时间周期数据

BACK¶: 后一时间周期数据

KL_FIELD - K线数据字段¶

获取K线数据, 可指定需返回的字段

class KL_FIELD¶

ALL¶: 所有字段

DATE_TIME¶: 日期时间

OPEN¶: 开盘价

CLOSE¶: 收盘价

HIGH¶: 最高价

LOW¶: 最低价

PE_RATIO¶: 市盈率

TURNOVER_RATE¶: 换手率

TRADE_VOL¶: 成交量

TRADE_VAL¶: 成交额

CHANGE_RATE¶: 涨跌比率

LAST_CLOSE¶: 昨收价

KLNoDataMode - K线数据取值模式¶

指定时间为非交易日时，对应的k线数据取值模式

class KLNoDataMode¶

NONE¶: 返回无数据

FORWARD¶: 往前取数据

BACKWARD¶: 往后取数据

KLType - k线类型¶

k线类型定义

class KLType¶

K_1M¶: 1分钟K线

K_3M¶: 3分钟K线

K_5M¶: 5分钟K线

K_15M¶: 15分钟K线

K_30M¶: 30分钟K线

K_60M¶: 60分钟K线

K_DAY¶: 日K线

K_WEEK¶: 周K线

K_MON¶: 月K线

K_QUARTER¶: 季K线

K_YEAR¶: 年K线

Market - 行情市场¶

标识不同的行情市场，股票名称的前缀复用该字符串,如 ‘HK.00700’, ‘HK_FUTURE.999010’

class Market¶

HK¶: 港股

SH¶: 沪市

SZ¶: 深市

HK_FUTURE¶: 港股期货

NONE¶: 未知

MarketState - 行情市场状态¶

行情市场状态定义

class MarketState¶

NONE¶: 无交易,美股未开盘

AUCTION¶: 竞价

WAITING_OPEN¶: 早盘前等待开盘

MORNING¶: 早盘

REST¶: 午间休市

AFTERNOON¶: 午盘

CLOSED¶: 收盘

PRE_MARKET_BEGIN¶: 盘前开始

PRE_MARKET_END¶: 盘前结束

AFTER_HOURS_BEGIN¶: 盘后开始

AFTER_HOURS_END¶: 盘后结束

NIGHT_OPEN¶: 夜市开盘

NIGHT_END¶: 夜市收盘

FUTURE_DAY_OPEN¶: 期指日市开盘

FUTURE_DAY_BREAK¶: 期指日市休市

FUTURE_DAY_CLOSE¶: 期指日市收盘

FUTURE_DAY_WAIT_OPEN¶: 期指日市等待开盘

HK_CAS¶: 港股盘后竞价

ModifyOrderOp - 修改订单操作类型¶

修改订单操作类型定义

class ModifyOrderOp¶

NONE¶: 未知

NORMAL¶: 修改订单的数量、价格

CANCEL¶: 取消订单

DISABLE¶: 使订单失效

ENABLE¶: 使订单生效

DELETE¶: 删除订单

OptionCondType - 价内价外¶

价内价外定义

class OptionType¶

ALL¶: 全部

WITHIN¶: 价内

OUTSIDE¶: 价外

OptionType - 期权类型¶

期权类型定义

class OptionType

ALL: 全部

CALL¶: 涨

PUT¶: 跌

OrderType - 订单类型¶

订单类型定义

class OrderType¶

NONE¶: 未知

NORMAL¶: 普通订单(港股的增强限价单、A股限价委托、美股的限价单)

MARKET¶: 市价，目前仅美股

ABSOLUTE_LIMIT¶: 港股限价单(只有价格完全匹配才成交)

AUCTION¶: 港股竞价单

AUCTION_LIMIT¶: 港股竞价限价单

SPECIAL_LIMIT¶: 港股特别限价(即市价IOC, 订单到达交易所后，或全部成交，或部分成交再撤单，或下单失败)

SPECIAL_LIMIT_ALL¶: 港股特别限价(要么全部成交，否则下单失败)

OrderStatus - 订单状态定义¶

订单状态定义

class OrderStatus¶

NONE¶: 未知

UNSUBMITTED¶: 未提交

WAITING_SUBMIT¶: 等待提交

SUBMITTING¶: 提交中

SUBMIT_FAILED¶: 提交失败，下单失败

SUBMITTED¶: 已提交，等待成交

FILLED_PART¶: 部分成交

FILLED_ALL¶: 全部已成

CANCELLING_PART¶: 正在撤单部分(部分已成交，正在撤销剩余部分)

CANCELLING_ALL¶: 正在撤单全部

CANCELLED_PART¶: 部分成交，剩余部分已撤单

CANCELLED_ALL¶: 全部已撤单，无成交

FAILED¶: 下单失败，服务拒绝

DISABLED¶: 已失效

DELETED¶: 已删除(无成交的订单才能删除)

DealStatus - 成交状态¶

成交状态

class DealStatus¶

OK¶: 正常

CANCELLED¶: 被取消

CHANGED¶: 被更改

Plate - 板块集合分类¶

板块集合分类定义

class Plate¶

ALL¶: 所有板块

INDUSTRY¶: 行业板块

REGION¶: 地域板块

CONCEPT¶: 概念板块

PositionSide - 持仓方向类型¶

持仓方向类型定义

class PositionSide¶

NONE¶: 未知

LONG¶: 多仓

SHORT¶: 空仓

PriceType - 涡轮价(界)内外¶

上市日

class PriceType¶

Unknown¶: 未知

Outside¶: 价外,界内证表示界外

WithIn¶: 价内,界内证表示界内

ProtoFMT - 协议格式¶

协议格式类型

class ProtoFMT¶

Protobuf¶

google的protobuf格式

Json¶

json格式

PushDataType - 推送数据类型¶

推送数据类型定义

class PushDataType¶

REALTIME¶: 实时推送数据

BYDISCONN¶: 行情连接断开重连后，OpenD拉取补充断开期间的数据，最多50根

CACHE¶: 非实时推送数据，非连接断开补充数据

ret_code - 接口返回值¶

接口返回值定义

RET_OK = 0

RET_ERROR = -1

SecurityType - 证券类型¶

证券类型定义

class SecurityType¶

STOCK¶: 股票

IDX¶: 指数

ETF¶: 交易所交易基金(Exchange Traded Funds)

WARRANT¶: 港股涡轮牛熊界内证

BOND¶: 债券

DRVT¶: 期权

NONE¶: 未知

SecurityReferenceType - 股票关联数据类型¶

股票关联数据类型

class SecurityReferenceType¶

NONE¶

未知

WARRANT¶

相关窝轮

StockHolder - 持有者类别¶

持有者类别定义

class StockHolder¶

INSTITUTE¶: 机构

FUND¶: 基金

EXECUTIVE¶: 高管

SubType - 实时数据定阅类型¶

实时数据定阅类型定义

class SubType¶

TICKER¶: 逐笔

QUOTE¶: 报价

ORDER_BOOK¶: 买卖摆盘

K_1M¶: 1分钟K线

K_3M¶: 3分钟K线

K_5M¶: 5分钟K线

K_15M¶: 15分钟K线

K_30M¶: 30分钟K线

K_60M¶: 60分钟K线

K_DAY¶: 日K线

K_WEEK¶: 周K线

K_MON¶: 月K线

K_QUARTER¶: 季K线

K_YEAR¶: 年K线

RT_DATA¶: 分时

BROKER¶: 买卖经纪

SysNotifyType - 系统异步通知类型¶

系统异步通知类型定义

class SysNotifyType¶

NONE¶: 未知

GTW_EVENT¶: 网关事件

PROGRAM_STATUS¶: 程序状态变化

CONN_STATUS¶: 与Server的连接状态变化

QOT_RIGHT¶: 行情权限变化

API_LEVEL¶: API等级变化

TickerDirect - 逐笔方向¶

逐笔方向定义

class TickerDirect¶

BUY¶: 买

SELL¶: 卖

NEUTRAL¶: 中性

TickerType - 逐笔类型¶

逐笔类型定义

class TickerType¶

AUTO_MATCH¶

自动对盘

LATE¶

开市前成交盘

NON_AUTO_MATCH¶

非自动对盘

INTER_AUTO_MATCH¶

同一证券商自动对盘

INTER_NON_AUTO_MATCH¶

同一证券商非自动对盘

ODD_LOT¶

碎股交易

AUCTION¶

竞价交易

BULK¶

批量交易

CRASH¶

现金交易

CROSS_MARKET¶

跨市场交易

BULK_SOLD¶

批量卖出

FREE_ON_BOARD¶

离价交易

RULE127_OR_155¶

第127条交易（纽交所规则）或第155条交易

DELAY¶

延迟交易

MARKET_CENTER_CLOSE_PRICE¶

中央收市价

NEXT_DAY¶

隔日交易

MARKET_CENTER_OPENING¶

中央开盘价交易

PRIOR_REFERENCE_PRICE¶

前参考价

MARKET_CENTER_OPEN_PRICE¶

中央开盘价

SELLER¶

卖方

T¶

T类交易(盘前和盘后交易)

EXTENDED_TRADING_HOURS¶

延长交易时段

CONTINGENT¶

合单交易

AVERAGE_PRICE¶

平均价成交

OTC_SOLD¶

场外售出

ODD_LOT_CROSS_MARKET¶

碎股跨市场交易

DERIVATIVELY_PRICED¶

衍生工具定价

REOPENINGP_RICED¶

再开盘定价

CLOSING_PRICED¶

收盘定价

COMPREHENSIVE_DELAY_PRICE¶

综合延迟价格

TradeDateType - 交易时间类型¶

交易时间类型定义

class TradeDateType¶

WHOLE¶: 全天交易

MORNING¶: 上午交易，下午休市

AFTERNOON¶: 下午交易，上午休市

TrdEnv - 交易环境类型¶

交易环境类型定义

class TrdEnv¶

REAL¶: 真实环境

SIMULATE¶: 模拟环境

TrdMarket - 交易市场类型¶

交易市场类型定义

class TrdMarket¶

NONE¶: 未知

HK¶: 港股交易

US¶: 美股交易

CN¶: A股交易

HKCC¶: 香港的A股通交易

TrdSide - 交易方向类型¶

交易方向类型定义(客户端下单只传Buy或Sell即可，SELL_SHORT / BUY_BACK 服务器可能会传回)

class TrdSide¶

NONE¶: 未知

BUY¶: 买

SELL¶: 卖

SELL_SHORT¶: 卖空

BUY_BACK¶: 买回

WarrantStatus - 涡轮状态¶

涡轮状态定义

class WarrantStatus¶

NONE¶: 未知

NORMAL¶: 正常状态

SUSPEND¶: 停牌

STOP_TRADE¶: 终止交易

PENDING_LISTING¶: 等待上市

WrtType - 港股窝轮类型¶

港股窝轮类型定义

class WrtType¶

CALL¶: 认购

PUT¶: 认沽

BULL¶: 牛证

BEAR¶: 熊证

INLINE¶: 界内证

NONE¶: 未知

SortField - 涡轮排序¶

涡轮排序定义

class SortField¶

NONE¶: 未知

CODE¶: 代码

CUR_PRICE¶: 最新价

PRICE_CHANGE_VAL¶: 涨跌额

CHANGE_RATE¶: 涨跌幅%

STATUS¶: 状态

BID_PRICE¶: 买入价

ASK_PRICE¶: 卖出价

BID_VOL¶: 买量

ASK_VOL¶: 卖量

VOLUME¶: 成交量

TURNOVER¶: 成交额

SCORE¶: 综合评分

PREMIUM¶: 溢价%

EFFECTIVE_LEVERAGE¶: 有效杠杆

DELTA¶: 对冲值,仅认购认沽支持该字段

IMPLIED_VOLATILITY¶: 引伸波幅,仅认购认沽支持该字段

TYPE¶: 类型

STRIKE_PRICE¶: 行权价

BREAK_EVEN_POINT¶: 打和点

MATURITY_TIME¶: 到期日

LIST_TIME¶: 上市日期

LAST_TRADE_TIME¶: 最后交易日

LEVERAGE¶: 杠杆比率

IN_OUT_MONEY¶: 价内/价外%

RECOVERY_PRICE¶: 收回价,仅牛熊证支持该字段

CHANGE_PRICE¶: 换股价

CHANGE¶: 换股比率

STREET_RATE¶: 街货比%

STREET_VOL¶: 街货量

AMPLITUDE¶: 振幅%

WARRANT_NAME¶: 名称

ISSUER¶: 发行人

LOT_SIZE¶: 每手

ISSUE_SIZE¶: 发行量

PRE_CUR_PRICE¶: 盘前最新价

AFTER_CUR_PRICE¶: 盘后最新价

PRE_PRICE_CHANGE_VAL¶: 盘前涨跌额

AFTER_PRICE_CHANGE_VAL¶: 盘后涨跌额

PRE_CHANGE_RATE¶: 盘前涨跌幅%

AFTER_CHANGE_RATE¶: 盘后涨跌幅%

PRE_AMPLITUDE¶: 盘前振幅%

AFTER_AMPLITUDE¶: 盘后振幅%

PRE_TURNOVER¶: 盘前成交额

AFTER_TURNOVER¶: 盘后成交额

UPPER_STRIKE_PRICE¶: 上限价，仅界内证支持该字段

LOWER_STRIKE_PRICE¶: 下限价，仅界内证支持该字段

INLINE_PRICE_STATUS¶: 界内界外，仅界内证支持该字段

ModifyUserSecurityOp - 自选股操作类型¶

自选股操作类型定义

class ModifyUserSecurityOp¶

NONE¶: 未知

ADD¶: 新增

DEL¶: 删除

StockMarket - 条件选股的股票市场¶

条件选股的股票市场定义

class StockMarket¶

NONE¶: 未知

HK¶: 港股

US¶: 美股

CN¶: A股

StockField - 条件选股的简单属性筛选条件¶

条件选股的筛选条件定义

class StockField¶

NONE¶: 未知

STOCK_CODE¶: 股票代码

STOCK_NAME¶: 股票名称

CUR_PRICE¶: 最新价

CUR_PRICE_TO_HIGHEST52_WEEKS_RATIO¶: (现价 - 52周最高)/52周最高

CUR_PRICE_TO_LOWEST52_WEEKS_RATIO¶: (现价 - 52周最低)/52周最低

HIGH_PRICE_TO_HIGHEST52_WEEKS_RATIO¶: (今日最高 - 52周最高)/52周最高

LOW_PRICE_TO_LOWEST52_WEEKS_RATIO¶: (今日最低 - 52周最低)/52周最低

VOLUME_RATIO¶: 量比

BID_ASK_RATIO¶: 委比

LOT_PRICE¶: 每手价格

MARKET_VAL¶: 市值

PE_ANNUAL¶: 市盈率 (静态)

PE_TTM¶: 市盈率TTM

PB_RATE¶: 市净率

SortDir - 条件选股的排序方向¶

条件选股的排序方向定义

class SortDir¶

NONE¶: 不排序

ASCEND¶: 升序

DESCEND¶: 降序

TrdAccType - 交易账户类型¶

交易账户类型定义

class TrdAccType¶

NONE¶: 未知

CASH¶: 现金账户

MARGIN¶: 保证金账户