# @circle-fin/circle-sdk 中文文档

规范地址：https://npmcn.com/package/%40circle-fin/circle-sdk/

版本：2\.9\.0
npm 元数据更新时间：2026-05-14T17:25:40.020Z
中文译文更新时间：2026-11-09T16:45:41.303Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：3.8 MB，872 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=10\.0\.0
- 运行依赖：1 个
- 首次发布：2022-08-11T16:21:16.390Z
- 最新版本发布：2024-03-28T19:07:24.599Z
- 近 30 天下载量：20169（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：29（近 12 个月 0 个）

## 中文简介

Circle API 的节点.js SDK

## 安装

```sh
npm install @circle-fin/circle-sdk
```

也可以使用：`pnpm add @circle-fin/circle-sdk`、`yarn add @circle-fin/circle-sdk`、`bun add @circle-fin/circle-sdk`

## README

# Circle APIS 节点.js 库

[![npm version](https://img.shields.io/npm/v/@circle-fin/circle-sdk)](https://www.npmjs.com/package/@circle-fin/circle-sdk) [![npm downloads](https://img.shields.io/npm/dm/@circle-fin/circle-sdk)](https://www.npmjs.com/package/@circle-fin/circle-sdk)

圆形节点库为圆形API提供方便访问 用服务器侧 JavaScript 编写的应用程序。 API 参考文献 [圆形 API 文件](https://developers.circle.com/reference)。 。 。 .

## 所需资源

节点10以上.

## 安装

以 :

```sh
npm install @circle-fin/circle-sdk --save
# or
yarn add @circle-fin/circle-sdk
```

## 使用量

要拨打API, 您需要 API 密钥 。 一旦获得一个,您可以使用这个SDK使API调用如下:

```Typescript
import { Circle, CircleEnvironments, SubscriptionRequest } from "@circle-fin/circle-sdk";

// Initialize API driver
const circle = new Circle(
    '<your-api-key>',
    CircleEnvironments.sandbox      // API base url
);

async function createSubscription() {
    const subscribeReq: SubscriptionRequest = {
        endpoint: "https://example.org/handler/for/notifications"
    };

    const subscribeResp = await circle.subscriptions.createSubscription(subscribeReq);
    console.log(subscribeResp.data);
}
createSubscription();
```

## 发展

使用 Clone 此重播并安装依赖性

```sh
yarn install
```

1.  运行编码源命令,从中生成此 SDK 的源代码 `sdk.json` OpenAPI 规格文件 :
    
    ```sh
    yarn gen-sdk
    ```
    
2.  运行所有测试 :
    
    ```bash
    yarn test
    ```
    

## 捐款

请跟随 [常规武器委员会](https://www.conventionalcommits.org/en/v1.0.0/) 在创建此还本付息请求时, 向所有人输入格式.

## 常见问题

### @circle-fin/circle-sdk 是什么？

Circle API 的节点\.js SDK

### 如何安装 @circle-fin/circle-sdk？

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

### @circle-fin/circle-sdk 支持 TypeScript 吗？

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

### @circle-fin/circle-sdk 支持 ESM 还是 CommonJS？

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

### @circle-fin/circle-sdk 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=10\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @circle-fin/circle-sdk 可以商用吗？

@circle-fin/circle-sdk 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @circle-fin/circle-sdk 的下载量有多少？

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

### @circle-fin/circle-sdk 还在维护吗？

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