Skip to content

title: Appendix: API Quick Reference

Appendix: API Quick Reference

This appendix provides a quick reference guide to the Lean API.

A.1 Securities Management API

Adding Securities

# 股票
AddEquity("SPY", Resolution.Daily)
AddEquity("AAPL", Resolution.Minute, Market.USA)

# 外汇
AddForex("EURUSD", Resolution.Hour)

# 期货
AddFuture("ES", Resolution.Minute)
AddFuture("GC", Resolution.Daily)

# 期权
AddOption("SPY", Resolution.Minute)

# 加密货币
AddCrypto("BTCUSD", Resolution.Daily)
AddCrypto("ETHUSD", Resolution.Hour, Market.GDAX)

# CFD
AddCfd("XAUUSD", Resolution.Minute)

# 指数
AddIndex("SPX", Resolution.Daily)

Security Configuration

security = AddEquity("SPY", Resolution.Daily)

# 数据归一化模式
security.SetDataNormalizationMode(DataNormalizationMode.Adjusted)
# - Adjusted: 复权价格(默认)
# - Raw: 原始价格
# - SplitAdjusted: 仅调整拆股
# - TotalReturn: 总收益

# 延迟填充与延长时间:Security 上没有 SetFillDataForward / SetExtendedMarketHours,
# 需在添加证券时通过 AddEquity 的参数设置
security = AddEquity("SPY", Resolution.Daily, fillForward=True, extendedMarketHours=True)

# 杠杠杆
security.SetLeverage(2)  # 2倍杠杆

A.2 Order Management API

Basic Orders

# 市价单
MarketOrder("SPY", 100)      # 买入100股
MarketOrder("SPY", -100)     # 卖出100股

# 限价单
LimitOrder("SPY", 100, 450)  # 限价$450买入
LimitOrder("SPY", -100, 455) # 限价$455卖出

# 止损市价单
StopMarketOrder("SPY", -100, 440)  # 跌破$440卖出

# 止损限价单
StopLimitOrder("SPY", -100, 440, 438)  # 跌破$440转为限价$438卖出

Portfolio Management

# 按比例设置持仓
SetHoldings("SPY", 1)          # 100%资金买入
SetHoldings("SPY", 0.5)        # 50%资金买入

# 多证券等权分配(SetHoldings 仅支持 (Symbol, 比例) 与 PortfolioTarget 列表两种形态)
SetHoldings([
    PortfolioTarget.Percent(Symbols["AAPL"], 1.0/3),
    PortfolioTarget.Percent(Symbols["MSFT"], 1.0/3),
    PortfolioTarget.Percent(Symbols["GOOGL"], 1.0/3)
])

# 自定义比例
SetHoldings([
    PortfolioTarget.Percent(Symbols["AAPL"], 0.5),
    PortfolioTarget.Percent(Symbols["MSFT"], 0.3),
    PortfolioTarget.Percent(Symbols["GOOGL"], 0.2)
])

# 平仓
Liquidate()                   # 平掉所有持仓
Liquidate("SPY")              # 平掉SPY持仓
Liquidate([Symbols["AAPL"], Symbols["MSFT"]])   # 平掉多个持仓

OrderTicket Operations

# 获取订单
ticket = MarketOrder("SPY", 100)

# 检查状态
if ticket.Status == OrderStatus.Filled:
    pass

# 更新订单
ticket.Update(UpdateOrderFields(
    Quantity = 150,
    LimitPrice = 455
))

# 取消订单
ticket.Cancel()

A.3 History Data API

# 基本用法
history = History("SPY", 30, Resolution.Daily)              # 30天
history = History("SPY", TimeSpan.FromDays(30), Resolution.Daily)

# 多证券
history = History(["SPY", "AAPL"], 30, Resolution.Daily)

# 时间范围
history = History("SPY", datetime(2023, 1, 1), datetime(2023, 12, 31), Resolution.Daily)

# 获取TradeBar
history = History[TradeBar]("SPY", 30, Resolution.Daily)

# 获取QuoteBar
history = History[QuoteBar]("EURUSD", 30, Resolution.Minute)

# 获取Tick
history = History[Tick]("SPY", 1000, Resolution.Tick)

A.4 Technical Indicator API

Trend Indicators

# 移动平均线
SMA(symbol, period, resolution)
EMA(symbol, period, resolution)
LWMA(symbol, period, resolution)       # 线性加权移动平均
TRIMA(symbol, period, resolution)      # 三角移动平均

# MACD
MACD(symbol, fast, slow, signal, movingAverageType)
macd.Current.Value      # MACD线
macd.Signal.Current.Value  # 信号线
macd.Histogram.Current.Value  # 柱状图

# 自适应移动平均
KAMA(symbol, period, resolution)

Momentum Indicators

# RSI
RSI(symbol, period, movingAverageType)

# 随机指标
STO(symbol, period, k_period, d_period, resolution)
stoch.StochK.Value  # K值
stoch.StochD.Value  # D值

# Williams %R
WILR(symbol, period, resolution)

# ROC (变化率)
ROC(symbol, period, resolution)

Volatility Indicators

# ATR (平均真实波幅)
ATR(symbol, period, movingAverageType)

# 布林带
BB(symbol, period, std_dev, movingAverageType)
bb.MiddleBand.Current.Value
bb.UpperBand.Current.Value
bb.LowerBand.Current.Value
bb.BandWidth.Current.Value

# 标准差
STD(symbol, period, resolution)

Volume Indicators

# OBV (能量潮)
OBV(symbol)

# VWAP (成交量加权平均价)
VWAP(symbol)

# MFI (资金流量指数)
MFI(symbol, period)

A.5 Scheduling API

# 基本调度
Schedule.On(
    DateRules.EveryDay("SPY"),
    TimeRules.At(9, 30),
    callback_function
)

# 日期规则
DateRules.EveryDay()
DateRules.Every(DayOfWeek.Monday)
DateRules.MonthStart()
DateRules.MonthEnd()
DateRules.YearStart()
DateRules.YearEnd()
DateRules.On(self.Time.year, self.Time.month, 15)  # 每月15号(On 接收具体日期)

# 时间规则
TimeRules.At(9, 30)  # 9:30 AM
TimeRules.AfterMarketOpen("SPY", 30)  # 开盘后30分钟
TimeRules.BeforeMarketClose("SPY", 30)  # 收盘前30分钟
TimeRules.Every(TimeSpan.FromMinutes(15))  # 每15分钟
TimeRules.Every(TimeSpan.FromHours(1))   # 每小时

A.6 Portfolio API

Properties

Portfolio.TotalPortfolioValue    # 总资产
# 初始资金:Portfolio 没有 StartingCash 属性,
# 在 Initialize 中自行记录:self.starting_cash = self.Portfolio.TotalPortfolioValue
Portfolio.Cash                   # 可用现金
Portfolio.Invested               # 是否有持仓
Portfolio.TotalAbsoluteProfit  # 总盈亏

# 持仓信息
holding = Portfolio["SPY"]
holding.Quantity              # 持仓数量
holding.AveragePrice          # 平均成本
holding.TotalCost             # 总成本
holding.HoldingsValue         # 持仓市值
holding.UnrealizedProfit     # 未实现盈亏
holding.UnrealizedProfitPercent  # 未实现盈亏%

A.7 Securities API

security = Securities["SPY"]

# 价格
security.Price
security.BidPrice
security.AskPrice
security.High
security.Low
security.Close
security.Open

# 成交量
security.Volume
security.BidSize
security.AskSize

# 其他
security.Symbol
security.Type
security.IsTradable
security.HasData
security.LocalTime  # 本地时间

A.8 Common Constants

Resolution

from Resolution import *
Resolution.Tick       # 逐笔
Resolution.Second     # 秒
Resolution.Minute     # 分钟
Resolution.Hour       # 小时
Resolution.Daily      # 日

Market

from Market import *
Market.USA
Market.India
Market.FXCM
Market.GDAX     # Coinbase
Market.Binance

SecurityType

from SecurityType import *
SecurityType.Equity    # 股票
SecurityType.Forex      # 外汇
SecurityType.Future    # 期货
SecurityType.Option    # 期权
SecurityType.Cfd       # CFD
SecurityType.Crypto     # 加密货币
SecurityType.Index     # 指数

OrderDirection

from OrderDirection import *
OrderDirection.Buy
OrderDirection.Sell

OrderStatus

from OrderStatus import *
OrderStatus.New
OrderStatus.Submitted
OrderStatus.PartiallyFilled
OrderStatus.Filled
OrderStatus.Canceled
OrderStatus.Invalid
OrderStatus.CancelPending

DataNormalizationMode

from DataNormalizationMode import *
DataNormalizationMode.Adjusted
DataNormalizationMode.Raw
DataNormalizationMode.SplitAdjusted
DataNormalizationMode.TotalReturn

A.9 Quick Code Snippets

Checking Indicator Readiness

if indicator.IsReady:
    value = indicator.Current.Value

Iterating Over Holdings

```python for symbol in Portfolio.Keys: holding = Portfolio[symbol] if holding.Invested: self.Debug(f"{symbol}: {holding.Quantity}")

Iterating Over Securities

python for symbol in Securities.Keys: security = Securities[symbol] self.Debug(f"{symbol}: {security.Price}")

Getting the Current Time

python self.Time # 当前算法时间 self.UtcTime # UTC时间

Setting the Benchmark

python SetBenchmark("SPY") SetBenchmark(lambda x: x.Securities["SPY"].Price)

Debug Output

```python Debug("debug message") Log("log message") Error("error message")

注意:QCAlgorithm 没有 Warn,输出方法只有 Debug / Log / Error

```

Chart Plotting

python Plot("Chart", "Series", value) PlotIndicator("Indicator", indicator) # PlotIndicator 无 series 名称参数