# @liqpro/liq-api-client 中文文档

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

版本：0\.83\.0
npm 元数据更新时间：2026-11-01T17:05:50.025Z
中文译文更新时间：2026-11-01T18:01:42.663Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：183 kB，4 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2026-06-14T05:19:12.474Z
- 最新版本发布：2026-11-01T17:05:49.817Z
- 已发布版本数：53（近 12 个月 53 个）

## 中文简介

Liq订单网关API的类型REST + SSE客户端。

## 安装

```sh
npm install @liqpro/liq-api-client
```

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

## README

# @liq / api-client

Liq订单网关API的类型REST + SSE客户端。

## 概述

`@liq/api-client` 提供了一个类型化的HTTP客户端，用于与订单网关服务交互。它包装 `up-fetch` 具有自动JWT承载令牌管理，响应信封展开(`{ data: T }` → `T`)，以及结构化错误处理 `LiqApiError`． 响应是类型化的，但没有在运行时进行验证（一个客户机构建读取多个网关版本），因此从声明类型漂移的有效负载原样到达调用者。顶级 `LiqClient` 公开认证、订单、市场、头寸、账户和SSE流的命名空间服务对象。

## 主要出口

### `LiqClient`

主入口。由 `{ baseUrl, chainId? }`.

```ts
const client = new LiqClient({ baseUrl: 'http://localhost:4000/v1' });
client.setToken(jwt); // set or clear auth token
```

| 财产 | 类型 | 描述 |
| --- | --- | --- |
| `client.auth` | `AuthService` | SIWE nonce + verify, dev-login |
| `client.orders` | `OrdersService` | 提交，取消，列出，获取订单 |
| `client.markets` | `MarketsService` | 列出市场 |
| `client.positions` | `PositionsService` | 列出空缺职位 |
| `client.accounts` | `AccountsRestService` | 注册+获取账号 |
| `client.sse` | `SSEService` | 订阅实时事件通道 |
| `client.relay` | `RelayService` | 无气中继：提交签名批，轮询其工作 |

### 其他出口

-   `AuthService`， `AuthTokens` -独立认证服务+令牌类型
-   `OrdersService` -订单CRUD
-   `MarketsService` -市场清单
-   `PositionsService`， `GatewayPosition` ( `list` / `getOne` 返回:签署 `size`， `side` 由此衍生， `realizedPnl`, `episodeRealizedPnl` / `episodeFeesUsd` -当前头寸的价格PnL和费用； `null` 当未知), `PositionResponse` （原线排）-位置
-   `AccountsRestService`， `RegisterAccountParams`， `RegisterAccountResponse` -客户管理
-   `SSEService`， `SSEEventHandler` - SSE订阅助手
-   `LiqApiError` -类型API错误（状态码+错误码+正文）

## 安装

```bash
pnpm add @liq/api-client
```

## 依赖关系

-   `@liq/core` —共享类型和枚举
-   `up-fetch` -使用基URL +拦截器的轻量级获取包装器

## 构建

```bash
moon run liq-api-client:build    # tsup → dist/
```

## 常见问题

### @liqpro/liq-api-client 是什么？

Liq订单网关API的类型REST \+ SSE客户端。

### 如何安装 @liqpro/liq-api-client？

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

### @liqpro/liq-api-client 支持 TypeScript 吗？

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

### @liqpro/liq-api-client 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @liqpro/liq-api-client 可以商用吗？

@liqpro/liq-api-client 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @liqpro/liq-api-client 还在维护吗？

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