# @binance/connector-typescript 中文文档

规范地址：https://npmcn.com/package/%40binance/connector-typescript/

版本：0\.3\.16
npm 元数据更新时间：2025-03-24T05:11:22.965Z
中文译文更新时间：2026-11-08T03:02:20.947Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40binance/connector-typescript
原文对照：https://npmcn.com/package/%40binance/connector-typescript/?lang=original

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

- 包体积（解压后）：2.2 MB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2023-10-04T01:32:00.861Z
- 最新版本发布：2025-03-24T05:11:22.766Z
- 近 30 天下载量：2106（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 0 个）

## 中文简介

这是一个轻量级的图书馆,作为比能斯公共API的连接器.

## 安装

```sh
npm install @binance/connector-typescript
```

也可以使用：`pnpm add @binance/connector-typescript`、`yarn add @binance/connector-typescript`、`bun add @binance/connector-typescript`

## README

# 在 Typescript - DEPRECATED 中的二进制连接器

[![npm version](https://badge.fury.io/js/@binance%2Fconnector-typescript.svg)](https://badge.fury.io/js/@binance%2Fconnector-typescript) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

**这个寄存器被贬值. 请使用新仓库 : [二进制连接器-js](https://github.com/binance/binance-connector-js)**

这个图书馆是一个简单干净的连接器 [二进制公共 API](https://github.com/binance/binance-spot-api-docs)它分为三个不同的终点:

-   [倒数 API](https://npmcn.com/package/%40binance/connector-typescript/src/spot.ts)
    
-   [Websocket API 软件](https://npmcn.com/package/%40binance/connector-typescript/src/websocketAPI.ts)
    
-   [网页串流](https://npmcn.com/package/%40binance/connector-typescript/src/websocketStream.ts)
    
-   支持的 API :
    
    -   `/api/*`
    -   `/sapi/*`
-   包括测试案例和实例
    
-   请求和答复类型
    

## 安装

```bash
npm install @binance/connector-typescript
```

## 文档

### 剩余 APIs

所有 REST API 端点都链接到一个独特的模块,叫做 [`Spot`](https://npmcn.com/package/%40binance/connector-typescript/src/spot.ts#L4)。 。 。 . 要开始与 REST API 合作, 您需要导入并创建客户端 。 铭记一些端点需要用您的 API 证书密钥进行认证 :

```typescript
import { Spot } from '@binance/connector-typescript';

const API_KEY = '';
const API_SECRET = '';
const BASE_URL = 'https://api.binance.com';

const client = new Spot(API_KEY, API_SECRET, { baseURL: BASE_URL });
client.exchangeInformation().then((res) => {
    console.log(res);
}).catch(err => { console.log(err) });
```

请看 [`examples/restful`](https://npmcn.com/package/%40binance/connector-typescript/examples/restful/) 要检查更多终点的文件夹.

#### 测试网

虽然 `/sapi/*` 端点还没有测试网环境, `/api/*` 结束点可以在 [点点测试网](https://testnet.binance.vision/)。您可以通过更改基址来使用它 :

```typescript
// provide the testnet base url
const client = new Spot(apiKey, apiSecret, { baseURL: 'https://testnet.binance.vision'})
```

如果不提供base url,则默认为api.binance.com.

### 网页

#### Websocket API 客户端

所有网页都有 [`WebsocketAPI`](https://npmcn.com/package/%40binance/connector-typescript/src/websocketAPI.ts#L6) 模块. 要与 Websocket API 合作, 您需要导入客户端并生成一个调用Back 函数来处理信件 :

```typescript
import { WebsocketAPI } from '@binance/connector-typescript';

const API_KEY = '';
const API_SECRET = '';

const callbacks = {
    open: (client: WebsocketAPI) => client.exchangeInfo(),
    close: () => console.debug('Disconnected from WebSocket server'),
    message: (data: string) => console.info(JSON.parse(data))
}
const websocketAPIClient = new WebsocketAPI(API_KEY, API_SECRET, { callbacks });
setTimeout(() => websocketAPIClient.disconnect(), 20000);
```

请看 [`examples/websocketAPI`](https://npmcn.com/package/%40binance/connector-typescript/examples/websocketAPI/) 要检查更多终点的文件夹.

#### Websocket 流客户端

所有 Websocket 流随 [`WebsocketStream`](https://npmcn.com/package/%40binance/connector-typescript/src/websocketStream.ts#L4) 模块. 要与 Websocket API 合作, 您需要导入客户端并生成一个调用Back 函数来处理信件 :

```typescript
import { WebsocketStream } from '@binance/connector-typescript';

const callbacks = {
  open: () => console.debug('Connected to WebSocket server'),
  close: () => console.debug('Disconnected from WebSocket server'),
  message: (data: string) => console.info(data)
}

const websocketStreamClient = new WebsocketStream({ callbacks });
websocketStreamClient.aggTrade('bnbusdt');
setTimeout(() => websocketStreamClient.disconnect(), 6000);
```

请看 [`examples/websocketStream`](https://npmcn.com/package/%40binance/connector-typescript/examples/websocketStream/) 要检查更多终点的文件夹.

## 测试

```bash
npm install

npm run test
```

## 限制

未来和欧洲选项 API 不支持:

-   `/fapi/*`
-   `/dapi/*`
-   `/eapi/*`
-   相关 Websocket 市场和用户数据流

## 许可证

麻省理工学院

## 常见问题

### @binance/connector-typescript 是什么？

这是一个轻量级的图书馆,作为比能斯公共API的连接器\.

### 如何安装 @binance/connector-typescript？

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

### @binance/connector-typescript 支持 TypeScript 吗？

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

### @binance/connector-typescript 支持 ESM 还是 CommonJS？

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

### @binance/connector-typescript 可以商用吗？

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

### @binance/connector-typescript 的下载量有多少？

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

### @binance/connector-typescript 还在维护吗？

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