API 参考

本目录面向使用已安装发行包的策略作者。按下面的任务进入接口说明；无需框架源码。机制解释和运行步骤保留在各资产页、公共操作页，接口页负责参数、返回与直接影响调用的约束。

策略内接口

除单独标明导入路径外，从 localquant.apis 导入；由模块注册的scheduler与时间规则在init中从 localquant.api 导入。函数在框架回调内使用，不在没有回测环境的普通脚本中直接查询或下单。

任务	接口与阅读入口
订阅行情	update_universe / subscribe / unsubscribe
历史行情	history_bars、时间边界、行情字段
当前行情	bar_dict与Bar、current_snapshot
交易日历	get_trading_dates / get_previous_trading_date / get_next_trading_date
停牌、分红、利率	is_suspended、get_dividend、get_yield_curve
当前合约	active_instrument、active_instruments、all_instruments
合约基础信息	instruments、instrument_history / instruments_history、symbol
期货月份与路由	get_future_contracts、get_future_series_contract
股票基金数量下单	order_shares、order_lots
股票基金金额下单	order_value、order_percent
股票基金目标调仓	order_target_value、order_target_percent、order_target_portfolio
约束下重分配仓位	order_target_portfolio_smart
期货开平仓	buy_open、sell_open、sell_close、buy_close
净数量下单	期货order、order_to；股票基金语义
订单管理	MarketOrder / LimitOrder、get_open_orders、cancel_order
持仓查询	get_position、get_positions
出入金	deposit / withdraw
定时任务	scheduler.run_daily / run_weekly / run_monthly及时间规则
成交通知	subscribe_event

运行对象与结果

对象	说明
Instrument	标的信息、数量单位、保证金与乘数
Bar / 快照	当前行情属性、缺bar判断
Order / Trade	订单状态与实际成交，两者不可混用
context / Portfolio / Account	回调状态、组合权益与账户资金
股票基金持仓 / 期货真实持仓 / 系列视图	不同资产及归属的字段
分析结果	pkl字典、DataFrame列、绩效指标与单位

类型说明中 A | None 表示可能没有值，list[T]表示元素为T的列表，dict[K, V]表示键值类型；float/int按数值含义描述，结果中也可能使用对应NumPy数值标量。数值参数使用有限值；价格使用原始价格，收益与权重的小数0.1表示10%。日期类型及具体单位以接口页为准。

策略外入口

这些接口在启动脚本中调用，直接在对应操作页维护：

• run_func / run_file / run_code / run：启动回测。
• load_framework_data / register_bundle / discard_bundle：准备行情；attach_minute_bars挂载分钟。
• export_full_html / generate_detail_xlsx：读取分析结果并导出。
• run_grid_search / RunOutcome / run_fingerprint等：参数优化与研究身份。

本参考覆盖当前seeddata链路的常规策略接口，不将包内所有上游名称列为已支持能力。不可用的数据查询见能力边界，资产与运行范围见指南首页。