输入查询参数

命令语法的结构在通用字段中是标准化的。这确保了 date 始终是 date，格式在整个过程中保持一致。

标准化参数包括但不限于：provider、symbol、start_date、end_date、date、limit。

查看函数的文档字符串时，标准参数（在多个提供商之间共享）位于首位。提供商特定参数在位置上跟随 provider 参数。

以下示例来自 obb.equity.price.quote：

参数
----------
symbol : str
    获取数据的符号。在这种情况下，是逗号分隔的符号列表。
provider : Optional[Literal['fmp', 'intrinio']]
    用于查询的提供商，默认为 None。
    如果为 None，则选择默认值中指定的提供商，如果没有默认值则为 'fmp'。
source : Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip']
    数据源。(提供商: intrinio)

备注

以下示例假设 Python 接口已在当前会话中导入，和/或 Fast API 已启动。

from openbb import obb

提供商参数

provider 参数是可选的，当未指定时，将使用默认提供商。默认提供商可以在用户设置中配置，或者使用按字母顺序排列的第一个可用提供商。

# 使用默认提供商
data = obb.equity.price.historical("AAPL")

# 指定提供商
data = obb.equity.price.historical("AAPL", provider="yfinance")

符号参数

符号参数接受单个股票代码或逗号分隔的股票代码列表：

# 单个符号
data = obb.equity.price.quote("AAPL")

# 多个符号
data = obb.equity.price.quote("AAPL,MSFT,GOOGL")

日期参数

日期参数应使用 YYYY-MM-DD 格式：

# 指定日期范围
data = obb.equity.price.historical(
    "AAPL", 
    start_date="2023-01-01", 
    end_date="2023-12-31"
)

限制参数

limit 参数控制返回的记录数量：

# 限制返回最近100条记录
data = obb.equity.price.historical("AAPL", limit=100)

提供商特定参数

每个提供商可能有特定的参数。这些参数在函数文档中会标明所属提供商：

# 使用 Intrinio 提供商的特定参数
data = obb.equity.price.quote(
    "AAPL", 
    provider="intrinio",
    source="iex"  # Intrinio 特定参数
)

参数验证

OpenBB 平台会验证输入参数：

• 日期格式验证
• 符号格式检查
• 提供商可用性验证
• 参数类型检查

无效参数将返回错误消息，帮助您纠正输入。

最佳实践

1. 使用标准日期格式：始终使用 YYYY-MM-DD 格式
2. 检查提供商支持：确保所选提供商支持所需的端点
3. 合理设置限制：避免请求过多数据
4. 处理错误：始终检查返回的错误和警告

有关特定函数的详细参数信息，请参阅函数的文档字符串或 API 参考文档。