# @deriv/deriv-api 中文文档

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

版本：1\.0\.15
npm 元数据更新时间：2024-02-13T09:01:19.411Z
中文译文更新时间：2026-11-12T00:37:49.995Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：295 kB，5 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：3 个
- 首次发布：2019-09-03T02:17:54.562Z
- 最新版本发布：2024-02-13T09:01:19.181Z
- 近 30 天下载量：12778（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 0 个）

## 中文简介

用于 Deriv 应用程序的 Websocket API

## 安装

```sh
npm install @deriv/deriv-api
```

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

## README

# 衍生API

用于衍生应用的 Async Websocket API

代码覆盖范围 : [![codecov](https://codecov.io/gh/binary-com/deriv-api/branch/master/graph/badge.svg)](https://codecov.io/gh/binary-com/deriv-api)

### 要求:

节点.js(建议采用v12.18.0或更高)

# 安装

## 安装 Deriv API 库

我们需要安装 Deriv API 库, 如果我们想要连接 Deriv 的网络锁.

#### 国家预防机制

```
npm install @deriv/deriv-api
```

#### 线条

```
yarn add @deriv/deriv-api
```

## 安装 Websocket (ws) 库

为了建立网锁连接,我们需要网锁库(ws).

#### 国家预防机制

```
npm install ws
```

#### 线条

```
yarn add ws
```

# 使用量

## 基本图书馆

基础库是Deriv API的较轻版本,适合应用 想要直接处理API电话.

也可以作为单独的模块导入(以减少最后捆绑大小) 或如果 `DerivAPI` 库已经导入,可使用 `api.basic`。 。 。 .

```js
const WebSocket = require('ws');
const DerivAPI = require('@deriv/deriv-api/dist/DerivAPI');

// app_id 1089 is for testing, create your own app_id and use it here.
// go to api.deriv.com to register your own app.
const connection = new WebSocket('wss://ws.derivws.com/websockets/v3?app_id=1089');
const api        = new DerivAPI({ connection });
const basic = api.basic;

basic.ping().then(console.log);
```

## ES6模块

#### 基本 API

```js
// Smaller bundle size, dealing only with the low-level library
import DerivAPIBasic from '@deriv/deriv-api/dist/DerivAPIBasic.js';
import WebSocket from 'ws';

// app_id 1089 is for testing, create your own app_id and use it here.
// go to api.deriv.com to register your own app.
const connection = new WebSocket('wss://ws.derivws.com/websockets/v3?app_id=1089');
const api        = new DerivAPIBasic({ connection });

api.ping().then(console.log);
```

## 通用JS模块

#### 基本 API

```js
// Smaller bundle size, dealing only with the low-level library
const WebSocket = require('ws');
const DerivAPIBasic = require('@deriv/deriv-api/dist/DerivAPIBasic');

// app_id 1089 is for testing, create your own app_id and use it here.
// go to api.deriv.com to register your own app.
const connection = new WebSocket('wss://ws.derivws.com/websockets/v3?app_id=1089');
const api        = new DerivAPIBasic({ connection });

api.ping().then(console.log);
```

## 使用 HTML 脚本标签

#### 基本 API

```html
<script src="https://unpkg.com/@deriv/deriv-api/dist/DerivAPIBasic.js"></script>
<script>
    const api = new DerivAPIBasic({ 
        endpoint: 'ws.derivws.com',
        app_id: 1089 /* 1089 is a default test app_id, replace with your own app_id */,
        lang: 'EN' 
    });
    
    api.ping().then(console.log);
</script>
```

## 创建 WebSocket 连接

建立联系有两种方式:

1.  使用先前打开的连接 :
    
    ```js
    const connection = new WebSocket('wss://ws.derivws.com/websockets/v3?app_id=YOUR_APP_ID');
    const api        = new DerivAPI({ connection });
    ```
    
2.  传递创建连接所需的参数 :
    
    ```js
    const api = new DerivAPI({ endpoint: 'ws.derivws.com', app_id: /* your app_id */, lang: 'EN' });
    ```
    

# 文档

#### 维基

关于如何在 DELIV API 中使用 [维基页面](https://github.com/binary-com/deriv-api/wiki)。 。 。 .

#### API 参考

完整 API 参考主机 [这里](https://binary-com.github.io/deriv-api/)

在一页中提到: [衍生API 参考](https://npmcn.com/package/%40deriv/deriv-api/docs/DerivAPI.md)

# 发展

```
git clone https://github.com/binary-com/deriv-api
cd deriv-api
npm install
```

#### 做测试

```
npm test
```

#### 在源代码编辑中自动运行测试

```
npm run devel
```

#### 运行插件

```
npm run syntax
```

#### 运行所有测试( lint + js 测试)

```
npm run test_all
```

#### 设定代码( 自动执行)

```
npm run prettify
```

#### 生成文档

```
npm run docs
```

#### 编辑源代码时自动重生成文件

需求 `inotify` 工作的时候.

```
npm run devel_docs
```

#### 在本地主机上服务文件并更新源代码更改

```
npm run serve_docs
```

#### 生成文档的 html 版本并发布到 gh- pages

```
npm run gh-pages
```

#### 构建软件包

```
npm run build
```

#### 运行示例

```
DERIV_TOKEN=YourTokenHere npm run examples
```

## 常见问题

### @deriv/deriv-api 是什么？

用于 Deriv 应用程序的 Websocket API

### 如何安装 @deriv/deriv-api？

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

### @deriv/deriv-api 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/deriv\_\_deriv-api 是否存在。

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

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @deriv/deriv-api 可以商用吗？

@deriv/deriv-api 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

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

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

### @deriv/deriv-api 还在维护吗？

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