> ## Documentation Index
> Fetch the complete documentation index at: https://dexbuilder.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# API 概览

> DexBuilder PerpDEX API 的版本、REST 与 WebSocket 访问地址、能力范围及问题排查说明

# API 概览

DexBuilder PerpDEX API 同时提供 **REST API** 与 **WebSocket API**：

* **REST API**：用于行情查询、账户与持仓管理、订单交易、历史记录查询及风险参数获取。
* **WebSocket API**：用于实时行情、深度、成交、订单、持仓、余额以及交易状态推送，并支持通过 WebSocket 执行部分账户交易操作。

当前版本：`V1.0.0`

## 服务地址

### REST API

Base URL：

```text theme={null}
https://api.dexbuilder.com/api/v1
```

接口页面中的 Path 需要拼接在 Base URL 后，例如：

```text theme={null}
GET /dex_futures/usdt/contracts
```

完整请求地址：

```text theme={null}
https://api.dexbuilder.com/api/v1/dex_futures/usdt/contracts
```

### WebSocket API

Base URL：

```text theme={null}
wss://api.dexbuilder.com/v1/ws/dex
```

WebSocket 连接建立后，可通过 `channel` 与 `event` 订阅公开或私有频道。

## 能力范围

### REST API

* **公开数据**：合约信息、订单簿、成交、K 线、资金费率、市场统计等。
* **私有数据**：账户、持仓、订单、个人成交及历史记录等。
* **交易操作**：下单、撤单、改单、批量订单及持仓管理。
* **风险管理**：风险限额、强平记录、ADL 等相关数据与操作。

### WebSocket API

* **公开行情**：Ticker、公共成交、深度、K 线、公共强平和合约统计。
* **私有数据**：订单、用户成交、持仓、余额、强平、ADL 等实时更新。
* **账户交易**：通过 WebSocket 完成下单、撤单、改单及订单查询等操作。

## 认证

公开 REST 接口和公开 WebSocket 频道无需 API Key。

私有 REST 接口、私有 WebSocket 频道以及 WebSocket 账户交易 API 需要 API Key，并按照「认证与签名」中的规则完成认证。

## 技术支持与问题排查

遇到接口问题时，建议整理以下信息：

1. 问题现象与复现步骤
2. REST Request Method / URI，或 WebSocket Channel / Event
3. Query 参数、Request Body 或 WebSocket Payload
4. HTTP 状态码或 WebSocket Error
5. 服务端返回内容
6. Trace ID（如响应中存在）

> [!WARNING]
>
> 提交问题时不要提供 API Secret、私钥或完整签名凭证。如 API Key 已泄露，应立即停用并重新创建。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.