使用 Stock Events API

Stock Events API 是一项 Pro 会员专属功能，可以让你通过自己的工具来自动化管理 Stock Events 账户中的数据。它的设计初衷是用于账户自动化，而不是作为通用的市场数据或股票代码搜索 API。

通过写入请求（Write requests），你可以修改在 Stock Events 中看到的自选股列表（watchlists）、股票代码（symbols）以及交易记录（transactions）。

你可以用 API 做什么

• 列出、创建、获取和更新自选股列表。
• 在自选股列表中列出、添加、更新和移除股票代码。
• 列出、创建、获取、更新和删除交易记录。
• 读取计算后的持仓（Holdings）和分红（Dividends）视图。

如何创建 API key

你需要拥有有效的 Stock Events Pro 订阅才能创建和使用 API keys。

1. 登录 Stock Events Web 应用。
2. 打开你的 Profile（个人资料）。
3. 选择 Settings（设置）。
4. 在 Account（账户）下方，选择 Data（数据）。
5. 选择 API Keys。
6. 选择 Create API key。
7. 输入一个描述性的 Name（名称），然后选择 Create（创建）。
8. 选择 Copy API key，并在关闭对话框前安全地保存该 key。

完整的 API key 只会显示一次。关闭对话框后，API Keys 页面只会显示它的名称、前缀、创建日期和最后使用日期，而不会显示完整的 key。

如果你的 Pro 订阅失效了，你的 keys 仍然会绑定在你的账户上，但 API 请求会返回 403 Forbidden，直到你的 Pro 权限重新激活为止。

发送你的第一个请求

API 的基础 URL 是 https://stockevents.app/api/v1。请在 Authorization 请求头中将你的 API key 作为 bearer token 发送。

curl -H "Authorization: Bearer $STOCK_EVENTS_API_KEY" \ 
  https://stockevents.app/api/v1/watchlists

这个请求会返回你的自选股列表及其对应的 ID。你可以将自选股 ID 用于特定于该列表的 symbol、Holdings 和 Dividends 端点。

关于请求字段、响应结构、可选参数以及所有可用的端点，请参考以下资源：

• Stock Events API 文档
• API Keys 设置
• OpenAPI 文档

保护好你的 API key

要把 API key 当作密码一样对待。不要把它提交到源代码管理系统中，不要在公开的客户端代码中暴露它，也不要将其放在查询参数（query parameter）或请求体（request body）中发送。

API keys 用于验证账户自动化 API 的身份，每个 key 并不具备独立的权限。请务必只在受信任的工具中使用它们。

如果某个 key 泄露了，请回到 API Keys 页面，选择 Revoke API key（撤销 API key），然后确认 Revoke。该 key 会立即失效且无法重新激活。如果需要，请重新创建一个新的 key。

常见错误

• 401 Unauthorized: API key 缺失、无效或已被撤销。
• 403 Forbidden: 该账户目前没有有效的 Pro 权限。