Getting Started
从 0 到第一次调用行情 API
这份指南面向普通调用者。你不需要理解后台实现,只需要知道自己要调用哪类数据、申请对应 scope,并在文档里验证 Token 可用。
1
注册并绑定 TOTP
使用邮箱完成注册,绑定验证码 App。注册完成后会发放一个试用 Open Token。
2
选择要调用的能力
只查连通性选 market:meta:read;查个股日 K 选 market:kline:read;批量板块和可交易事实选 market:batch:read。
3
提交 Token 申请
填写用途、24h 请求配额、出站流量配额和绝对过期时间,等待管理员审核。
4
在文档里调通 ping
打开文档页,在 Authorize 中填写 Bearer Token,先请求 /api/v2/open/meta/ping。
怎么选 scope
scope 是 Token 能访问的能力边界。申请越小越容易审核,也更安全;不确定时可以先用 `market:read` 完成联调,再拆成更细权限。
| Scope | 覆盖能力 | 适合场景 |
|---|---|---|
| market:read | 全部开放行情读取 | 初次接入、调试、个人研究 |
| market:security:read | 证券主数据与检索 | 代码表、名称搜索 |
| market:kline:read | 个股日 K | 日线回测、行情图表 |
| market:board:read | 板块行情 | 行业/概念板块、成分股 |
| market:batch:read | 批量行情 | 批量板块、股票池、可交易事实 |
| market:external:read | 外盘行情 | 海外股票/ETF、商品期货 |
| market:quality:read | 数据质量 | 覆盖检查、缺口排查 |
调用时怎么写
curl -H "Authorization: Bearer 你的Token" \ "https://stock.xray.top/api/v2/open/meta/ping"
验收标准
- 能正常登录门户。
- Token 列表能看到状态、scope、24h 配额和最近调用。
- `/api/v2/open/meta/ping` 返回成功。
- 访问未授权接口时返回 403,并提示缺少的 scope。