# @dxfeed/dxlink-api 中文文档

规范地址：https://npmcn.com/package/%40dxfeed/dxlink-api/

版本：0\.10\.0
npm 元数据更新时间：2026-11-13T00:41:21.214Z
中文译文更新时间：2026-11-13T01:42:10.496Z
软件包许可：MPL-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40dxfeed/dxlink-api
原文对照：https://npmcn.com/package/%40dxfeed/dxlink-api/?lang=original
项目主页：https://dxfeed.com/
源码仓库：https://github.com/dxFeed/dxLink

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

- 包体积（解压后）：7.3 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：7 个
- 首次发布：2023-11-09T00:00:48.714Z
- 最新版本发布：2026-11-13T00:41:21.002Z
- 近 30 天下载量：29208（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 7 个）

## 中文简介

dxLink API提供从dxFeed服务获取市场数据的渠道

## 安装

```sh
npm install @dxfeed/dxlink-api
```

也可以使用：`pnpm add @dxfeed/dxlink-api`、`yarn add @dxfeed/dxlink-api`、`bun add @dxfeed/dxlink-api`

## README

# @dxfeed/dxlink-api (英语)

这个软件包提供了从下列来源获取市场数据的渠道: [dxFeed (英语)](https://www.dxfeed.com/) 通过 dxLink API 提供的服务.

## 安装

```bash
npm install @dxfeed/dxlink-api
```

## 使用量

导入客户端并输入您的项目 .

```typescript
import { DXLinkWebSocketClient, DXLinkFeed } from '@dxfeed/dxlink-api'
```

### 客户端

创建客户端实例 .

```typescript
const client = new DXLinkWebSocketClient()
```

连接到服务器 .

```typescript
client.connect('wss://demo.dxfeed.com/dxlink-ws')
```

如果服务器需要, 请提供认证符 .

```typescript
client.setAuthToken(token)
```

### 饲料 API

创建有交货合同的市场数据输入API `AUTO`。 。 。 .

```typescript
const feed = new DXLinkFeed(client, 'AUTO')
```

配置创建的种子 .

```typescript
feed.configure({
  acceptAggregationPeriod: 10,
  acceptDataFormat: FeedDataFormat.COMPACT,
  acceptEventFields: {
    Quote: ['eventSymbol', 'askPrice', 'bidPrice'],
    Candle: ['eventSymbol', 'open', 'close', 'high', 'low', 'volume'],
  },
})
```

添加订阅到 feed .

```typescript
const sub1 = {
  type: 'Quote',
  symbol: 'AAPL',
}

feed.addSubscriptions(sub1)
```

从种子中删除订阅 .

```typescript
feed.removeSubscriptions(sub1)
```

从频道接收数据 .

```typescript
feed.addEventListener((events) => {
  // do something with events
})
```

### 市场深度 API

创建具有理想符号和源码的市场API深度.

```typescript
const dom = new DXLinkDepthOfMarket(client, { symbol: 'AAPL', sources: ['ntv'] })
```

创建配置 `dom`。 。 。 .

```typescript
dom.configure({
  acceptAggregationPeriod: 10,
  acceptDepthLimit: 5,
})
```

从频道接收数据 .

```typescript
dom.addSnapshotListener((time, bids, asks) => {
  // do something with snapshot
})
```

## 常见问题

### @dxfeed/dxlink-api 是什么？

dxLink API提供从dxFeed服务获取市场数据的渠道

### 如何安装 @dxfeed/dxlink-api？

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

### @dxfeed/dxlink-api 支持 TypeScript 吗？

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

### @dxfeed/dxlink-api 支持 ESM 还是 CommonJS？

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

### @dxfeed/dxlink-api 可以商用吗？

@dxfeed/dxlink-api 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @dxfeed/dxlink-api 的下载量有多少？

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

### @dxfeed/dxlink-api 还在维护吗？

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