@binance/connector-typescript

中文文档
0.3.16发布于 2025/03/24MITTypeScriptESM + CJS近 30 天下载 2106

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

中文使用文档
文档目录7 节
  1. 安装
  2. 文档
  3. 剩余 APIs
  4. 网页
  5. 测试
  6. 限制
  7. 许可证

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

npm version License: MIT

这个寄存器被贬值. 请使用新仓库 : 二进制连接器-js

这个图书馆是一个简单干净的连接器 二进制公共 API它分为三个不同的终点:

安装

npm install @binance/connector-typescript

文档

剩余 APIs

所有 REST API 端点都链接到一个独特的模块,叫做 Spot。 。 。 . 要开始与 REST API 合作, 您需要导入并创建客户端 。 铭记一些端点需要用您的 API 证书密钥进行认证 :

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 要检查更多终点的文件夹.

测试网

虽然 /sapi/* 端点还没有测试网环境, /api/* 结束点可以在 点点测试网。您可以通过更改基址来使用它 :

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

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

网页

Websocket API 客户端

所有网页都有 WebsocketAPI 模块. 要与 Websocket API 合作, 您需要导入客户端并生成一个调用Back 函数来处理信件 :

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 要检查更多终点的文件夹.

Websocket 流客户端

所有 Websocket 流随 WebsocketStream 模块. 要与 Websocket API 合作, 您需要导入客户端并生成一个调用Back 函数来处理信件 :

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 要检查更多终点的文件夹.

测试

npm install

npm run test

限制

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

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

许可证

麻省理工学院

版本与发布记录

@binance/connector-typescript 共发布 17 个版本,首次发布于 2023/10/04;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.3.16latest2025/03/241.6 年前
0.3.152025/01/081.8 年前
0.3.142024/11/271.9 年前
0.3.132024/10/112 年前
0.3.122024/10/022 年前
0.3.112024/09/182 年前

关于 @binance/connector-typescript 的常见问题

@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 和提交记录判断。