@dxfeed/api

中文文档
1.6.0发布于 2023/07/31MPL-2.0TypeScriptESM + CJS近 30 天下载 6793

此软件包提供 dxFeed 流数据的访问权限

此软件包已被标记为弃用

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

中文使用文档
文档目录11 节
  1. 安装
  2. 节点JS的使用
  3. 基本用途
  4. 导入软件包
  5. 配置和创建连接( C)
  6. 配置并创建订阅( C)
  7. 关闭订阅
  8. 合计 API
  9. 获取时间序列
  10. 订阅时间序列快照
  11. 关闭连接

@dxfeed/ api (英语) Version

此软件包提供访问 dxFeed (英语) 流出数据.

我们的一揽子计划很容易融入任何现代框架.

安装

npm install @dxfeed/api

节点JS的使用

安装 cometd-nodejs-client 软件包

npm install cometd-nodejs-client

在代码中使用

require('cometd-nodejs-client').adapt()
// or
import * as CometdNodejsClient from 'cometd-nodejs-client'
CometdNodejsClient.adapt()

基本用途

执行中有几个类别:

  • 种子 (公开)
  • 终点 (非公开)
  • 订阅 (非公开)

这个 种子 是配置和创建订阅的切入点. 种子 管理连接和签名的私人课程. 这个 终点 负责管理网络套接字连接. 订阅 用于管理开放订阅.

导入软件包

import Feed from '@dxfeed/api'

配置和创建连接( C)

创建 Feed 实例 .

const feed = new Feed()

如果需要, 请提供认证 .

feed.setAuthToken('authToken')

设置网络套接字地址并打开连接 .

feed.connect('wss://demo.dxfeed.com/webservice/cometd')

配置并创建订阅( C)

您应该指定事件类型和符号名称.

feed.subscribe<{ value: number }>(
  [EventType.Summary, EventType.Trade] /* event types */,
  ['AEX.IND:TEI'] /* symbols */,
  handleEvent
)

对于定时订阅,您还应提供时间开始订阅.

对于烛光事件类型和基准符号,您应当指定一个聚合期。 您也可以设置价格类型 。 详情: https://kb.dxfeed.com/en/data-access/rest-api.html#candle-symbols (中文(简体) )

feed.subscribeTimeSeries<{ value: number }>(
  [EventType.Summary, EventType.Trade] /* event types */,
  ['AEX.IND:TEI'] /* symbols */,
  0 /* fromTime */,
  handleEvent
)

其事件处理器处理新事件的最后一个参数 .

const handleEvent = (event) => {
  /* process event */
}

关闭订阅

所有订阅方法返回未订阅处理器,您需要调用此方法进行未订阅 .

const unsubscribe = feed.subscribe(eventTypes, symbols, handleEvent)

onExit(() => unsubscribe())

合计 API

获取时间序列

如果您想要获得特定时间段的时间序列事件,请参考下面的例子.

// inside async function
const events = await feed.getTimeSeries(
  'AAPL{=15m}',
  EventType.Candle,
  fromDate.getTime(),
  toDate.getTime()
)

订阅时间序列快照

如果要订阅"时空事件",请参见以下示例.

const unsubscribe = feed.subscribeTimeSeriesSnapshot('AAPL{=15m}', EventType.Candle, (candles) => {
  // process candles
  chart.setCandles(candles)
})

关闭连接

如果您需要关闭网络套接字连接

feed.disconnect()

版本与发布记录

@dxfeed/api 共发布 10 个版本,首次发布于 2021/01/12;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.6.0latest2023/07/313 年前
1.5.02023/01/283 年前
1.4.02022/08/254 年前
1.3.02022/08/024 年前
1.2.02022/07/254 年前
1.1.02021/05/245 年前

关于 @dxfeed/api 的常见问题

@dxfeed/api 是什么?

此软件包提供 dxFeed 流数据的访问权限注意:该包已被作者标记为弃用——Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

如何安装 @dxfeed/api?

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

@dxfeed/api 支持 TypeScript 吗?

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

@dxfeed/api 支持 ESM 还是 CommonJS?

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

@dxfeed/api 可以商用吗?

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

@dxfeed/api 的下载量有多少?

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

@dxfeed/api 还在维护吗?

最新版本 1.6.0 发布于 2023/07/31(3 年前);至今共发布 10 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/01/12。作者已将其标记为弃用,新项目建议寻找替代方案。