Skip to content

Home

Jump to bottom
Kay edited this page Jul 3, 2025 · 4 revisions

Welcome to the ptradeSim wiki!

ptradeSim API 文档集合

📚 文档概述

本文档集合为ptradeSim量化交易回测框架提供了完整的API参考资料，包含详细的函数说明、使用示例和最佳实践。

📋 文档结构

1. API_DOCUMENTATION.md - 完整API文档

内容： 详细的API函数说明和参数介绍

  • 📊 市场数据接口 (get_price, get_history, get_current_data等)
  • 💰 财务数据接口 (get_fundamentals, get_income_statement等)
  • 🏢 股票信息接口 (get_Ashares, get_stock_info等)
  • 💼 交易接口 (order, order_target, order_value等)
  • 📊 账户信息接口 (get_initial_cash, get_num_of_positions等)
  • ⚙️ 系统配置接口 (set_commission, set_universe等)
  • 📝 日志接口 (log.info, log.warning等)

适用对象： 需要详细了解API函数的开发者

2. API_QUICK_REFERENCE.md - API快速参考

内容： 常用API的速查表和代码模板

  • 🚀 常用API速查表
  • 📋 字段速查表 (价格数据、财务数据、技术指标)
  • 🎯 常用代码模板 (策略框架、数据获取、交易执行、风险控制)
  • 🔍 调试技巧
  • ⚠️ 注意事项

适用对象： 需要快速查找API用法的开发者

3. API_EXAMPLES.md - API使用示例

内容： 丰富的实际使用示例

  • 📊 市场数据获取示例 (基础价格、历史数据、实时数据、技术指标)
  • 💰 财务数据获取示例 (基本面分析、财务报表、财务比率)
  • 💼 交易策略示例 (均线策略、基本面选股、技术指标组合)
  • 🔍 数据分析示例 (相关性分析、波动率分析)
  • 📊 风险管理示例 (仓位管理、止损止盈)
  • 🎯 完整策略示例 (多因子选股策略)

适用对象： 学习如何使用API构建策略的开发者

🚀 快速开始

1. 查看API概览

# 查看API快速参考
cat API_QUICK_REFERENCE.md

2. 学习具体用法

# 查看详细API文档
cat API_DOCUMENTATION.md

# 查看使用示例
cat API_EXAMPLES.md

3. 验证API功能

# 运行API测试
poetry run python test_api_documentation.py

📊 API功能概览

市场数据 (15+ 接口)

  • 价格数据: 支持OHLCV + 9个扩展字段
  • 历史数据: 支持多时间频率 (1m-1M)
  • 实时数据: 五档买卖盘 + 市场快照
  • 技术指标: 6类主要技术指标 (MA, EMA, MACD, RSI, BOLL, KDJ)

财务数据 (30+ 字段)

  • 基本面数据: 估值、盈利、资产负债、现金流、运营效率
  • 财务报表: 损益表、资产负债表、现金流量表
  • 财务比率: 40+个财务比率指标

交易功能

  • 下单交易: order, order_target, order_value
  • 订单管理: cancel_order
  • 账户查询: 资金、持仓信息

系统配置

  • 手续费设置: set_commission
  • 股票池管理: set_universe
  • 交易模式: set_limit_mode

🎯 使用场景

📈 量化策略开发

# 技术分析策略
ma_data = get_technical_indicators(stocks, 'MA', period=20)
rsi_data = get_technical_indicators(stocks, 'RSI', period=14)

# 基本面选股策略
fundamentals = get_fundamentals(stocks, 'valuation', fields=['pe_ratio', 'pb_ratio'])
profitability = get_fundamentals(stocks, 'income', fields=['roe', 'roa'])

📊 数据分析研究

# 获取历史数据进行分析
hist_data = get_history(252, field='close', security_list=stocks)
returns = hist_data.pct_change()

# 获取财务数据进行基本面分析
financial_data = get_financial_ratios(stocks, fields=['current_ratio', 'debt_to_equity'])

🔍 市场监控

# 实时市场数据监控
current_data = get_current_data(stocks)
snapshot = get_market_snapshot(stocks, fields=['close', 'change', 'pct_change'])

✅ API特性

🔧 技术特性

  • 数据一致性: 基于哈希算法确保数据一致性
  • 错误处理: 优雅处理异常情况
  • 性能优化: 高效的数据计算和访问
  • 兼容性: 完全向后兼容

📋 数据质量

  • 字段丰富: 50+个数据字段
  • 格式标准: pandas.DataFrame标准格式
  • 类型完整: 价格、财务、技术指标全覆盖

🎯 易用性

  • 自动注入: API函数自动注入到策略命名空间
  • 中文支持: 日志输出支持中文
  • 文档完整: 详细的文档和示例

🧪 测试验证

测试覆盖

  • ✅ 所有主要API接口功能测试
  • ✅ 文档示例代码验证
  • ✅ API兼容性测试
  • ✅ 错误处理测试

测试结果

🎉 API文档验证测试完成！
📋 测试结果：所有主要API接口都能正常工作
📚 API文档准确性验证通过
✅ API注入和策略执行兼容性测试通过

📚 相关资源

示例代码

🤝 贡献指南

文档更新

  1. 修改相应的API文档文件
  2. 更新示例代码
  3. 运行测试验证准确性
  4. 提交Pull Request

新功能添加

  1. 在ptradeSim/api.py中实现新功能
  2. 更新API文档
  3. 添加使用示例
  4. 编写测试用例

📞 支持与反馈

如果您在使用API时遇到问题或有改进建议，请：

  1. 查看相关文档和示例
  2. 运行测试脚本验证功能
  3. 提交Issue或Pull Request
  4. 参与项目讨论

注意: 本文档基于ptradeSim当前版本编写，API可能会随版本更新而变化。建议定期查看最新文档。

Clone this wiki locally