zer0data SDK

欢迎使用 zer0data SDK

zer0data SDK 是用于访问币安永续合约数据的 Python 工具包，提供 K 线数据查询和合约元数据查询两个核心接口。

🚀 快速开始

安装

pip install "git+ssh://git@github.com/zer0coldai/zer0data.git@main#subdirectory=sdk"

基础用法

import zer0data as zd

client = zd.Client()

# 查询合约列表
symbols = client.get_symbols(market="um", quote_asset="USDT")
print(symbols.head())

# 查询 K 线数据
df = client.get_kline(
    symbol="BTCUSDT",
    start_date="2024-01-01",
    end_date="2024-01-07",
    frequency="1h",
)
print(df.head())

📚 文档导航

• 快速开始

  ---

  从安装到第一次查询的完整引导

• K线数据 API

  ---

  get_kline() 完整参数说明与使用示例

• 合约元数据 API

  ---

  get_symbols() 完整参数说明与使用示例

• 常见问题

  ---

  安装、连接、查询常见问题与解决方案

• 更新日志

  ---

  版本历史与功能变更记录

🏗️ SDK 架构

Client
├── get_kline(...)       # 快捷方法
├── get_symbols(...)     # 快捷方法
├── .kline               # KlineService 子服务
│   └── get_kline(...)
└── .symbols             # SymbolService 子服务
    └── get_symbols(...)

Client 是统一入口，内部组合了两个子服务：

• KlineService — 连接 DolphinDB，查询 K 线（OHLCV）数据
• SymbolService — 读取本地 exchangeInfo.json 快照，查询合约元数据

🆕 当前版本

版本 0.1.0

• K 线数据查询，支持 8 种周期（1m / 5m / 15m / 30m / 1h / 2h / 4h / 1d）
• 合约元数据查询，支持 spot / um / cm 三个市场
• 支持多标的批量查询与分页

📞 获取帮助

• 📖 查看快速开始
• 📈 查看 K线数据 API
• 📋 查看合约元数据 API

---

准备开始了吗？ 立即安装 →