@alpacahq/alpaca-trade-api 页面存档备份,存于互联网档案馆
Alpaca 的节点.js 类型SDK 贸易 API 财务报告和审定财务报表 市场数据 API。 。 。 .
两个API都以自己的名字空间生活(trading 编号 : marketData在一个包,
由统一的 Alpaca 有打出错误、恢复力(重试 /) 的客户端
超时/速率限制),发卡辅助器,工学造型器,以及
实时流出.
从3.x升级? 见 移徙指南 (亦见上) 文件站点)——其地图 通用3.x调用及其4.x等同器和船舶的工作流程a 代码 大部分工作都自动化了.
所需资源
- SDK消费者: 节点.js QQ 20 — REST运输使用平台-全球
fetch, (中文(简体) ),Headers, (中文(简体) ),URL,以及AbortController.(第18项达到报废 2025年4月; 软件包宣布engines.node >=20. ) (中文(简体) ) - 仓库贡献者 : 节点.js 24(见
.nvmrc) (中文(简体) ). 建筑,文件, 生成,然后在节点 24 上发布工具运行; CI 单独执行 将SDK打包到20号节点上,以保留消费者相容地层. - 严格节点类型Script项目可能会省略 DOM libs; REST 声明是
便携式,不要求
"dom"在消费者中tsconfig。 。 。 .
运行时间兼容性
| 运行时间 | REST / 基于获取的SSE | 网络软件 | 页:1 |
|---|---|---|---|
| 节点.js >= 20 | ✅ | ✅ | 首要目标. |
| 阿宝 | ✅ | ✅ | 与节点相兼容( N)ws 运行). |
| 德诺 | ✅ | ❌ | 根自动解析器通过 deno 出口条件. |
云花岗工人 编号 : workerd | ✅ | ❌ | 根自动解析到 REST 建筑(workerd 编号 : worker) (中文(简体) ). |
| Vercel 边缘 | ✅ | ❌ | 根自动解析到 REST 建筑(edge-light) (中文(简体) ). |
| 浏览器 | ✅ | ❌ | 决 定browser) (中文(简体) ). 不建议——见说明. |
图例 : QQ 支持 .
- WebSocket 流媒体仅为节点/ Bun. 这些客户使用节点兼容
流出模块,不会在边缘或浏览器中运行. 关于这些目标
软件包的出口条件透明地解决了根导入到
WebSocket-free REST 构建,所以 REST 和取取基于 SSE 的工作同时
溪流工厂
stockStream, (中文(简体) ),stream, ) 加上:submitAndWait丢出如果 电话 为WebSocket流线,运行于节点或Bun上. - 浏览器:技术上可行,但劝阻. 从a直接呼叫阿尔帕卡
浏览器传送您的
APCA_API_SECRET_KEY给客户的 偏好服务器或 代理( 见examples/marketdata-backend.ts(中文(简体) ) 而不是在前端代码中嵌入证书.
无害环境管理和CJS模块格式、边缘导出条件以及只使用REST的切入点 在文件网址上记录: 运行时间和模块兼容性。 。 。 .
安装
npm install @alpacahq/alpaca-trade-api
快开始
import { Alpaca } from "@alpacahq/alpaca-trade-api";
const alpaca = new Alpaca({
keyId: process.env.APCA_API_KEY_ID,
secret: process.env.APCA_API_SECRET_KEY,
paper: true, // default; set false for live trading
});
const account = await alpaca.trading.account.getAccount();
const price = await alpaca.marketData.getLatestPrice("AAPL");
const bars = alpaca.marketData.stockStream({ feed: "iex" });
bars.onBar((b) => console.log(b.symbol, b.close));
bars.onConnect(() => bars.subscribeForBars(["AAPL", "MSFT"]));
bars.connect();
服务器事件
外观提供已键入的 ASE 订阅和取消,
重新连接,和 Last-Event-ID 恢复:
const controller = new AbortController();
const activities = await alpaca.trading.subscribeActivities(
{},
{ signal: controller.signal },
);
try {
for await (const activity of activities) {
console.log(activity.activityType, activity.details);
}
} finally {
activities.close();
}
公司-行动变异可从
alpaca.marketData.subscribeCorporateActions()。生成的操作时间更长
名称在 trading.events 财务报告和审定财务报表
marketData.corporateActions; 见 流线指南。 。 。 .
文档
这个 文档网站 实值 用于工作流程、惯例和整理的API发现的犬类来源. 安装的类型脚本声明对准确的签名仍然具有权威性 模特们 主要指南:
- 开始
- 贸易
- 市场数据
- 流线
- 认证
- 复原力和配置
- 倾斜
- 值类型( T)
- 测试您的整合
- 运行时间和模块兼容性
- 实例
- 3.x的迁移
- 移徙概况
- 从4.x迁移到5.0
- API 参考
- AI 编码指导 ——选择等同格式:
从源头构建
npm install # also builds via the `prepare` script
npm run build # tsup -> dual ESM + CJS in dist/
npm run typecheck
npm run lint
npm test
可运行的示例
examples/。 。 。 .
要预览本地文件站点 :
npm --prefix docs install # first time only
npm --prefix docs start # http://localhost:3000/alpaca-trade-api-js/
释放
稳定版本发布于 npm latest dis. 见
变动情况
用于发行笔记.
支助
- 图书馆/ SDK 问题: 错误、 特性请求或特定问题 类型脚本库 → GitHub 问题。 。 。 .
- 一般阿尔帕卡支持 & API 讨论 : 账户问题、平台问题、, 或更广泛的 API 专题 阿尔帕卡社区论坛。 。 。 .
- 黑社区 : 与其他开发者和阿尔帕卡社区聊天 偷懒。 。 。 .
捐款
欢迎捐款。 见 捐款额 用来设置, 生成代码边界、文件工作流程和发布注释常规.