# @alpacahq/alpaca-trade-api 中文文档

规范地址：https://npmcn.com/package/%40alpacahq/alpaca-trade-api/

版本：5\.0\.0
npm 元数据更新时间：2026-10-01T14:33:39.445Z
中文译文更新时间：2026-11-05T21:53:22.676Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40alpacahq/alpaca-trade-api
原文对照：https://npmcn.com/package/%40alpacahq/alpaca-trade-api/?lang=original
项目主页：https://alpacahq.github.io/alpaca-trade-api-js/
源码仓库：https://github.com/alpacahq/alpaca-trade-api-js

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：26.4 MB，376 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：3 个
- 首次发布：2018-12-04T17:50:01.923Z
- 最新版本发布：2026-10-01T14:33:39.108Z
- 近 30 天下载量：53008（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：59（近 12 个月 10 个）

## 中文简介

用于阿尔帕卡交易和市场数据API的TypeScript SDK.

## 安装

```sh
npm install @alpacahq/alpaca-trade-api
```

也可以使用：`pnpm add @alpacahq/alpaca-trade-api`、`yarn add @alpacahq/alpaca-trade-api`、`bun add @alpacahq/alpaca-trade-api`

## README

[![npm version](https://img.shields.io/npm/v/@alpacahq/alpaca-trade-api.svg)](https://www.npmjs.com/package/@alpacahq/alpaca-trade-api) [![Forum](https://img.shields.io/badge/Forum-Alpaca%20Community-blue?logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAGuElEQVRogcWaXYhdVxXHf2udr3vHVCmtlcYHsXaKD%2B2DVixJDdpWIT4oFakQLMUvRH1QfEkp9sEXH0qFqohFaAolgWraYEvQRiwRUjC2hSKmtEUSG6pNI5hOTZM795x99lo%2B3HNn7tzM3LlnvvKHO9y79%2Fr4r73P2nvtfUbYGFydZdntieoO3D4qcL2LXCmqVwC42XnB54CToK9G979WVXUUOLdex7JGHQfeWxTZV0C%2BnqjuaGnPAY9mxzF%2FtAzhSeD8iO1WZNriqiLLfiiJfkdFrmocrsUOQ11zP%2BfRflWG8BAwR4tA2jhOsiy7O1F9UFXez%2FqIj8MBcfd3LNq9ZQiPAvU0ilMR6NL9oOfxEVHZLSIRSNZBdhKiuyfu%2FEFK%2FfY882%2BuprBqAGma7kwTfUJVt7Oxo74SBo%2BV2Zt1tLvquj4%2BSXgimaJIPquSPiUi3UZ2s8kP4YC7exmt%2FnJVxWdWElyRUFEkn1NJj4iIAzpJdpPggLk75vXusozPLie0LKks4%2BNpUhy7DCM%2FjuFM9OpY7gqBv40LLJeM1xR5fkREP9D8bkveAHHnn7g9C1wNYO5PAkFErmX6XBIAESkSSe4o6vibCnqjAjqmUHSL%2FKci%2BpEhkZbkAUxEAHtjvqy%2Ba86t5v60Jzze75c3x2j7G7s2pb2BrMhsLPIHgXy0c8kM5EmyW5PkARGxZYJrE4C6%2B6m0js%2BUMZ4WkTMYb5vZWVU9qSI7VPRaIE7pZxjwx9Q5Ht1PDjtGlbdpkvxiMHob88xLM8p1Xb8UQngZkBDCCYd%2FNR7alA0iImia%2FhyYGTamwy9Flu3RRK9j4LTt6A92UrM3DD8I%2BqqInuzD201%2FYKSGEnxIoM1ACWCqMltk2Z4yhH2jAXQkkb3N9zbkm2T0GGt7qAzh%2FobssG9UTgFy8u0gV7bwMQoFENV7gQNAOTCaJLep6PW0m9IheY9mD5Qh7G3ahp9xRCCpqF6ro33DzF6RQQ5Om8wLflVltkiS22BgQNM8%2B7GK3NQITDutBqhF%2F2NZhW82tuJqzoHMzM6koucR%2BYyIzNC%2BRBEX8Rjj0woUInJnS%2FIOJO7%2Brog91bQp081gDWT9EA6481zT1mYWmlVGvgTkmqbpJ3QwCm3gTahnapMXW5JYCFI8HnX3HoPZa3WQUZVtaZrerKnqrjaKS2i4nw0hnBonNqU2Fv0f4gsrVasAAFLVXerCjW0dA2YxPjxfVl9g8ShoeZ7vnZnperdTnEg76c5GdrlyxQGiyH9dlpYGbeDCjanADS3Ii7udxvh%2BvwqHR8g5kEM8Vdf8MkY5FGP9FwZ5sWJiNzu%2Btz8JN%2FpwQwpsn5Y8YOby27IqDwMZi2s%2BQFVV8RDEQyNtbZfIttiuiGybQnBYi6jitzZtW3E6mwyRK1RG6orVxBulm4qs%2BBaD5XCzzsbTEppRoJpeHhOR92ni93XT9JNc5iDc%2FV119wstdBRwEb3OEz3cybK7mb4k3nCIMKfAmbZ6AKp6jabJ%2Fk6Rvdbt5PvyPP9i059O0N1QuHNOwV9fjxHVZFZEv6YidzRNW%2FZICZxWXC45KLfAQpmMy7mRti1BdJ5Xi%2FGF9RpyvHLxuY0g1QZm9qJWMT7n7uUabXjz96KIbekMuHu%2FruuXFOi525%2FW49yhZ2Zziz83FYNC0P13QE8Bi8b%2BtVob3HrJRbOtzQGv4wHAFCCE8HszO0v70sARcLxX17pVOSBm9lYV41FY3IB65vazBVLt7CHORai2YgYMwKP9BChhMQCvqvrXZvafNZkV7zG4Qpn2WLlWqJn9u6zrx4Z%2BRkuAdxy%2Fj3bXfg4gyPBQ0vpo2AIDTuI%2FAhbKnyU1TFmGx93jkaZ9miDE3XHn%2FHL2NhCDGxCPh%2Fr9cHC0Y9xh3%2Frhe%2B4LCT1pNBd2YV%2B8gdsMDE%2BCb0k%2F%2FADoj3ZeMmIlvB7q6k53D6z%2BOAi4I76ZCWzububVV%2Bfhkndmy055XfN8NL%2BLVc60AO70xDdtF45AEs33lCV%2FXk5gxWe2qqrDVsd73H1oaBxDsj3fnE0sAonV8Z6qqp5YSWhS0nk%2FhP2hjreb%2B%2F9Y6c7T6bnZuv9lYInFwWulC9HC5%2FshTKwSVl016ro%2BFqN92sz%2FztgS29zxzZvqmi%2BnxmCAmPmJJM12lmU8sprCVG9HQggv98vyljraXnfvM5yNwcuQXkhC20fIAUIIZ4GLTf1i7l7W0e7vl%2BUtFy5ceIXNuPUoCj5cFPnBbqdTvmem692iOAYMr2ba7AMJQCdNP9XN832dPH84z%2FPZDSc8AR8qivyxTp4%2F0vy%2BHO%2BS%2BT8lMTeMbm%2FRxQAAAABJRU5ErkJggg%3D%3D)](https://forum.alpaca.markets/) [![Slack](https://img.shields.io/badge/Slack-Alpaca%20Community-4A154B?logo=slack&logoColor=white)](https://alpaca.markets/slack)

# @alpacahq/alpaca-trade-api 页面存档备份,存于互联网档案馆

Alpaca 的节点.js 类型SDK **贸易 API** 财务报告和审定财务报表 **市场数据 API**。 。 。 . 两个API都以自己的名字空间生活(`trading` 编号 : `marketData`在一个包, 由统一的 `Alpaca` 有打出错误、恢复力(重试 /) 的客户端 超时/速率限制),发卡辅助器,工学造型器,以及 实时流出.

> **从3.x升级?** 见 [移徙指南](https://npmcn.com/package/%40alpacahq/alpaca-trade-api/MIGRATION.md) (亦见上) [文件站点](https://alpacahq.github.io/alpaca-trade-api-js/migration))——其地图 通用3.x调用及其4.x等同器和船舶的工作流程a [代码](https://npmcn.com/package/%40alpacahq/alpaca-trade-api/codemods/alpaca-v3-to-v4.js) 大部分工作都自动化了.

## 所需资源

-   **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`](https://github.com/alpacahq/alpaca-trade-api-js/blob/master/examples/marketdata-backend.ts)(中文(简体) ) 而不是在前端代码中嵌入证书.

无害环境管理和CJS模块格式、边缘导出条件以及只使用REST的切入点 在文件网址上记录: [运行时间和模块兼容性](https://alpacahq.github.io/alpaca-trade-api-js/runtime-compatibility)。 。 。 .

## 安装

```bash
npm install @alpacahq/alpaca-trade-api
```

## 快开始

```ts
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` 恢复:

```ts
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`; 见 [流线指南](https://alpacahq.github.io/alpaca-trade-api-js/streaming)。 。 。 .

## 文档

这个 **[文档网站](https://alpacahq.github.io/alpaca-trade-api-js/)** 实值 用于工作流程、惯例和整理的API发现的犬类来源. 安装的类型脚本声明对准确的签名仍然具有权威性 模特们 主要指南:

-   [开始](https://alpacahq.github.io/alpaca-trade-api-js/getting-started)
-   [贸易](https://alpacahq.github.io/alpaca-trade-api-js/trading)
-   [市场数据](https://alpacahq.github.io/alpaca-trade-api-js/market-data)
-   [流线](https://alpacahq.github.io/alpaca-trade-api-js/streaming)
-   [认证](https://alpacahq.github.io/alpaca-trade-api-js/authentication)
-   [复原力和配置](https://alpacahq.github.io/alpaca-trade-api-js/resilience)
-   [倾斜](https://alpacahq.github.io/alpaca-trade-api-js/pagination)
-   [值类型( T)](https://alpacahq.github.io/alpaca-trade-api-js/types-and-values)
-   [测试您的整合](https://alpacahq.github.io/alpaca-trade-api-js/testing)
-   [运行时间和模块兼容性](https://alpacahq.github.io/alpaca-trade-api-js/runtime-compatibility)
-   [实例](https://alpacahq.github.io/alpaca-trade-api-js/examples)
-   [3.x的迁移](https://alpacahq.github.io/alpaca-trade-api-js/migration)
-   [移徙概况](https://alpacahq.github.io/alpaca-trade-api-js/migrations)
-   [从4.x迁移到5.0](https://alpacahq.github.io/alpaca-trade-api-js/migration-v5)
-   [API 参考](https://alpacahq.github.io/alpaca-trade-api-js/api)
-   **AI 编码指导** ——选择等同格式:
    -   读取包装 [法学硕士/硕士](https://npmcn.com/package/%40alpacahq/alpaca-trade-api/LLMS.md)。 。 。 .
    -   安装代理技能 : `npx skills add alpacahq/alpaca-trade-api-js` (单位:千美元)[代理技能.io](https://agentskills.io/)) (中文(简体) ).

## 从源头构建

```bash
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/`](https://github.com/alpacahq/alpaca-trade-api-js/tree/master/examples)。 。 。 . 要预览本地文件站点 :

```bash
npm --prefix docs install   # first time only
npm --prefix docs start     # http://localhost:3000/alpaca-trade-api-js/
```

## 释放

稳定版本发布于 npm **`latest`** dis. 见 [变动情况](https://github.com/alpacahq/alpaca-trade-api-js/blob/master/CHANGELOG.md) 用于发行笔记.

## 支助

-   **图书馆/ SDK 问题:** 错误、 特性请求或特定问题 类型脚本库 → [GitHub 问题](https://github.com/alpacahq/alpaca-trade-api-js/issues/new/choose)。 。 。 .
-   **一般阿尔帕卡支持 & API 讨论 :** 账户问题、平台问题、, 或更广泛的 API 专题 [阿尔帕卡社区论坛](https://forum.alpaca.markets/)。 。 。 .
-   **黑社区 :** 与其他开发者和阿尔帕卡社区聊天 [偷懒](https://alpaca.markets/slack)。 。 。 .

## 捐款

欢迎捐款。 见 [捐款额](https://npmcn.com/package/%40alpacahq/alpaca-trade-api/CONTRIBUTING.md) 用来设置, 生成代码边界、文件工作流程和发布注释常规.

## 常见问题

### @alpacahq/alpaca-trade-api 是什么？

用于阿尔帕卡交易和市场数据API的TypeScript SDK\.

### 如何安装 @alpacahq/alpaca-trade-api？

在项目目录运行 npm install @alpacahq/alpaca-trade-api，或使用 pnpm add / yarn add / bun add。

### @alpacahq/alpaca-trade-api 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @alpacahq/alpaca-trade-api 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @alpacahq/alpaca-trade-api 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @alpacahq/alpaca-trade-api 可以商用吗？

@alpacahq/alpaca-trade-api 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @alpacahq/alpaca-trade-api 的下载量有多少？

根据 npm 官方下载统计，@alpacahq/alpaca-trade-api 在 2026/10/06 – 2026/11/04 这 30 天内被下载 53,008 次，日均约 1,767 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @alpacahq/alpaca-trade-api 还在维护吗？

最新版本 5\.0\.0 发布于 2026/10/01（1 个月前）；至今共发布 59 个版本，其中过去 12 个月发布了 10 个；首次发布于 2018/12/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。