跳到主要内容

平台 vs SDK

本文档解释了 OpenBB 平台和 OpenBB SDK 之间的区别,帮助您选择合适的版本。

概述

OpenBB SDK (v2.x)

OpenBB SDK 是 OpenBB 的第二代产品,提供了丰富的金融数据和分析功能。

OpenBB 平台 (v4.x)

OpenBB 平台是最新一代产品,采用了全新的架构设计,提供更好的性能和扩展性。

主要区别

架构设计

特性SDK (v2.x)平台 (v4.x)
架构单体架构模块化架构
扩展性有限高度可扩展
性能中等优化的性能
内存使用较高优化的内存使用

API 设计

SDK (v2.x):

from openbb_terminal.sdk import openbb

# 获取股票数据
data = openbb.stocks.load("AAPL")

平台 (v4.x):

import openbb

# 获取股票数据
data = openbb.equity.price.historical("AAPL")

数据提供商

特性SDK (v2.x)平台 (v4.x)
提供商管理内置插件化
自定义提供商困难简单
多提供商支持有限完全支持

功能对比

数据访问

SDK (v2.x):

  • 预定义的数据函数
  • 固定的数据格式
  • 有限的自定义选项

平台 (v4.x):

  • 标准化的数据接口
  • 灵活的数据格式
  • 高度可定制

扩展开发

SDK (v2.x):

  • 需要修改核心代码
  • 复杂的集成过程
  • 有限的第三方支持

平台 (v4.x):

  • 独立的扩展开发
  • 简单的插件系统
  • 丰富的第三方生态

迁移指南

从 SDK 迁移到平台

1. 安装新版本

# 卸载旧版本
pip uninstall openbb-terminal

# 安装新版本
pip install openbb

2. 更新导入语句

旧版本:

from openbb_terminal.sdk import openbb

新版本:

import openbb

3. 更新函数调用

旧版本:

# 股票数据
data = openbb.stocks.load("AAPL")
chart = openbb.stocks.candle("AAPL")

# 经济数据
gdp = openbb.economy.gdp()

新版本:

# 股票数据
data = openbb.equity.price.historical("AAPL")
# 图表功能需要单独处理

# 经济数据
gdp = openbb.economy.gdp.real("US")

4. 处理配置

旧版本:

# 配置存储在 ~/.openbb_terminal/

新版本:

# 使用新的配置系统
openbb.account.credentials.alpha_vantage_api_key = "key"
openbb.account.save()

选择建议

选择 SDK (v2.x) 如果:

  • 您需要现有的图表功能
  • 您的项目已经基于 SDK 构建
  • 您需要特定的 SDK 功能

选择平台 (v4.x) 如果:

  • 您开始新项目
  • 您需要更好的性能
  • 您计划开发自定义扩展
  • 您需要更灵活的数据访问

支持状态

版本状态支持期限
SDK (v2.x)维护模式2024年底
平台 (v4.x)积极开发长期支持

获取帮助

迁移支持

学习资源