跳到主要内容

Python API

欢迎使用 NautilusTrader 的 Python API 参考!

API 参考为 NautilusTrader 框架提供详细的技术文档,包括其模块、类、方法和函数。该参考使用 Sphinx 从最新的 NautilusTrader 源代码自动生成。

请注意,不同版本的 NautilusTrader 有单独的参考:

  • 最新版: 此 API 参考从 develop 分支的头部构建,代表最新的稳定版本。
  • 每夜版: 此 API 参考从 nightly 分支的头部构建,代表当前开发中的前沿和实验性更改/功能。

您可以从左上角的版本下拉菜单中选择所需的 API 参考。

使用右侧导航侧边栏探索可用的模块及其内容。 您可以点击任何项目查看其详细文档,包括参数描述和返回值说明。

为什么选择 Python?

Python 最初在几十年前被创建为一种具有简洁直接语法的简单脚本语言。此后它已发展成为一种功能齐全的通用面向对象编程语言。根据 TIOBE 指数,Python 目前是世界上最受欢迎的编程语言。不仅如此,Python 已成为数据科学、机器学习和人工智能的事实上的通用语言

然而,开箱即用的语言并非没有缺点,特别是在实现大型性能关键系统的背景下。Cython 解决了很多这些问题,提供了静态类型语言的所有优势,嵌入到 Python 丰富的软件库生态系统和开发者/用户社区中。

API 模块

核心模块

  • core - 核心系统组件和基础设施
  • common - 通用工具和实用程序
  • config - 配置管理和设置

数据和模型

  • model - 数据模型和领域对象
  • data - 数据处理和管理
  • indicators - 技术指标和分析工具

交易系统

基础设施

系统组件

  • system - 系统级组件和服务
  • live - 实时交易系统
  • backtest - 回测引擎和组件

分析工具

适配器

  • adapters - 交易所和数据提供商适配器

使用指南

快速查找

使用页面顶部的搜索功能快速找到特定的类或方法。

代码示例

大多数 API 文档都包含使用示例,帮助您理解如何在实际代码中使用这些组件。

类型提示

所有 API 都包含完整的类型提示,帮助您在 IDE 中获得更好的代码补全和类型检查。

参数说明

每个方法和函数都包含详细的参数说明,包括类型、默认值和用途描述。