# 简介

WEEX 跟单 API 为交易专家和跟单者提供了一套完整的程序化交易与管理工具。通过本 API，您可以：
- 成为带单交易专家：使用独立权限的带单 API Key 进行交易，让其他交易者跟随您的投资组合。 系统自动将成交信号实时推送给所有跟单者。
- 作为跟单者：跟随带单员的投资组合，设置跟单策略、查询跟单持仓与盈亏，无需手动下单即可复制专家交易。

## 账户模型

WEEX 跟单系统采用账户隔离设计，带单账户的资金、仓位和风险率完全隔离，确保带单与自主合约交易完全独立：

| 账户类型   | 用途              | 适用 API Key   |
|:-------|:----------------|:-------------|
| 带单账户   | 交易专家专用，用于发起带单交易 | 带单 API Key   |
| 合约账户   | 普通用户自主合约交易      | 普通 API Key   |

## API Key 权限与管理

WEEX 提供了两种类型的 API Key，以满足不同角色的安全需求.

### API创建

- 进入“**用户中心**” → “**API 管理**” 页面，系统会根据您的账户身份展示对应的 API Key 类型，选择“**带单交易API**”进行创建
- 创建时需输入资金密码并完成二次验证，请妥善保管API key、Secret key以及Passphrase。

### 普通 API Key

- 适用于合约账户，支持常规交易操作（下单、撤单、查持仓等）。
- 适用于跟单员，允许通过 API 设置跟单策略、开始/停止跟单、平仓跟单仓位等。
- 普通API key无法直接操作带单交易。

###  带单 API Key
- 仅限已通过平台审核的交易专家创建。
- 带单交易权限：允许使用 API 进行带单交易（下单、撤单、平仓）。


## API 限制
  
请在集成前仔细了解当前范围。

###  带单API数量上限

每个交易员账户最多可创建1 个 API 密钥。

### 支持的功能
  带单 API 目前支持以下操作：
- 为合约带单交易币对下单
- 撤销订单
- 修改订单
- 查询带单交易持仓
- 查询当前委托订单
- 查询历史持仓
- 查询订单历史记录

### 不支持的功能
  
带单 API 目前不支持以下操作：

- 现货交易
- 非带单币对的合约交易

## 交易执行（复用现有合约接口）

带单交易专家使用带单 API Key 调用以下标准合约接口，系统会自动识别带单身份并触发跟单信号。

| 接口功能      | 方法     | 路径                       | 说明               |
|:----------|:-------|:-------------------------|:-----------------|
| 下单        | POST   | /capi/v3/Order           | 支持市价/限价单，可附加止盈止损 |
| 撤单        | DELETE | /capi/v3/Order           | 撤销指定订单           |
| 批量撤单      | DELETE | /capi/v3/batchOrders     | 批量撤销指定订单         |
| 撤销全部挂单    | POST   | /capi/v3/allOpenOrders   | 撤销账户下全部未成交订单     |
| 下条件单      | POST   | /capi/v3/algoOrder       | 新建条件单            |
| 撤销条件单     | DELETE | /capi/v3/algoOrder       | 撤销指定条件单          |
| 撤销全部条件单   | DELETE | /capi/v3/algoOpenOrders  | 撤销全部条件单          |
| 一键市价平仓    | POST   | /capi/v3/closePosition   | 指定仓位全部平仓         |
| 下止盈止损条件单  | POST   | /capi/v3/placeTpSlOrder  | 新建止盈止损委托         |
| 修改止盈止损条件单 | POST   | /capi/v3/modifyTpSlOrder | 修改已有止盈止损         |


## 限速与安全

- **限速规则**：请前往[访问限制](/zh-CN/products/futures/QuickStart/AccessRestrictions)查看最新限速规则。
- **认证方式**：所有 API 请求必须携带 `ACCESS-KEY`、`ACCESS-SIGN`、`Passphrase`、`ACCESS-TIMESTAMP`。
- **IP 白名单**：建议为所有 API Key 绑定 IP 白名单，提高账户安全性。
- **权限隔离**：请勿混用 API Key 类型(例如用普通API Key调用带单管理接口)。