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

# 合约：接口

> 合约跟单 API：接口。

## 获取当前带单

`GET` `/future/copytrade/order/v1/copy-trade/leader-order-list`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| type | number | true | | 查询类型,1:明细,2:汇总 | |
| symbol | string | false | | 交易对 | |
| direction | string | false | | 方向(NEXT, PREV) | |
| limit | number | false | | 翻页大小 | 10 |
| id | number | false | | id | |

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
        {
        "symbolName": "string", // 市场名称
        "positionType": "string", // 仓位类型:CROSSED(全仓);ISOLATED(逐仓)
        "positionSide": "string", // 持仓方向:LONG;SHORT
        "openLeverage": 5, // 杠杆
        "id": 0, // id
        "orderId": 0, // 订单id
        "trackNo": 0, // 跟单trackNo
        "openTime": 0, // 开仓时间
        "closeTime": 0, // 平仓时间
        "entryPrice": 0, // 持仓均价
        "openPrice": 0, // 开仓均价
        "closePrice": 0, // 平仓均价
        "profitRate": 0, // 收益率
        "openMargin": 0, // 开仓初始保证金
        "realizedPnl": 0, // 已实现盈亏
        "fee": 0, // 手续费
        "openSize": 0, // 开仓仓位数量
        "closeSize": 0, // 平仓仓位数量
        "positionSize": 0, // 持仓数量
        "closeOrderSize": 0, // 平仓订单占用
        "availableCloseSize": 0, // 可平数量
        "triggerProfitPrice": 0, // 止盈价
        "triggerStopPrice": 0, // 止损价
        "triggerPriceType": "string", // 触发价格类型:LATEST_PRICE,MARK_PRICE
        "followOrderCount": 0 // 跟随订单数
        }
]
}
```

## 获取带单员当前带单

`GET` `/future/copytrade/order/v1/copy-trade/leader-order-page`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| type | number | true | | 查询类型,1:明细,2:汇总 | |
| symbol | string | false | | 交易对 | |
| direction | string | false | | 方向(NEXT, PREV) | |
| limit | number | false | | 翻页大小 | 10 |
| id | number | false | | id | |

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
        {
        "symbolName": "string", // 市场名称
        "positionType": "string", // 仓位类型:CROSSED(全仓);ISOLATED(逐仓)
        "positionSide": "string", // 持仓方向:LONG;SHORT
        "openLeverage": 5, // 杠杆
        "id": 0, // id
        "orderId": 0, // 订单id
        "trackNo": 0, // 跟单trackNo
        "openTime": 0, // 开仓时间
        "closeTime": 0, // 平仓时间
        "entryPrice": 0, // 持仓均价
        "openPrice": 0, // 开仓均价
        "closePrice": 0, // 平仓均价
        "profitRate": 0, // 收益率
        "openMargin": 0, // 开仓初始保证金
        "realizedPnl": 0, // 已实现盈亏
        "fee": 0, // 手续费
        "openSize": 0, // 开仓仓位数量
        "closeSize": 0, // 平仓仓位数量
        "positionSize": 0, // 持仓数量
        "closeOrderSize": 0, // 平仓订单占用
        "availableCloseSize": 0, // 可平数量
        "triggerProfitPrice": 0, // 止盈价
        "triggerStopPrice": 0, // 止损价
        "triggerPriceType": "string", // 触发价格类型:LATEST_PRICE,MARK_PRICE
        "followOrderCount": 0 // 跟随订单数
        }
]
}
```

## 获取带单员历史带单

`GET` `/future/copytrade/order/v1/copy-trade/leader-order-history`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| type | number | true | | 查询类型,1:明细,2:汇总 | |
| symbol | string | false | | 交易对 | |
| direction | string | false | | 方向(NEXT, PREV) | |
| limit | number | false | | 翻页大小 | 10 |
| id | number | false | | id | |

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
    "hasPrev": false,
    "hasNext": false,
    "items": [
            {
            "symbolName": "string", // 市场名称
            "positionType": "string", // 仓位类型:CROSSED(全仓);ISOLATED(逐仓)
            "positionSide": "string", // 持仓方向:LONG;SHORT
            "openLeverage": 5, // 杠杆
            "id": 0, // id
            "orderId": 0, // 订单id
            "trackNo": 0, // 跟单trackNo
            "openTime": 0, // 开仓时间
            "closeTime": 0, // 平仓时间
            "entryPrice": 0, // 持仓均价
            "openPrice": 0, // 开仓均价
            "closePrice": 0, // 平仓均价
            "profitRate": 0, // 收益率
            "openMargin": 0, // 开仓初始保证金
            "realizedPnl": 0, // 已实现盈亏
            "fee": 0, // 手续费
            "openSize": 0, // 开仓仓位数量
            "closeSize": 0, // 平仓仓位数量
            "positionSize": 0, // 持仓数量
            "closeOrderSize": 0, // 平仓订单占用
            "availableCloseSize": 0, // 可平数量
            "triggerProfitPrice": 0, // 止盈价
            "triggerStopPrice": 0, // 止损价
            "triggerPriceType": "string", // 触发价格类型:LATEST_PRICE,MARK_PRICE
            "followOrderCount": 0 // 跟随订单数
            }
    ]
}
}
```

## 获取带单员历史分润明细

`GET` `/future/copytrade/user/v1/copy-trade/my-profit-history-detail`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| divideTime | number | true | | 分润日期(时间戳) | |
| direction | string | false | | 方向(NEXT, PREV) | |
| limit | number | false | | 翻页大小 | 10 |
| id | number | false | | id | |

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
    "hasPrev": false,
    "hasNext": false,
    "items": [{
            "avatar": "string", // 头像
            "name": "string", // 用户名称
            "profit": 5, // 分润数量
            "profitTime": "time", // 日期
            "coin": 0, // 币种
            "id":  // id
            }]
    }
}
```

## 获取带单员历史分润汇总

`GET` `/future/copytrade/user/v1/copy-trade/my-profit-history`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| direction | string | false | | 方向(NEXT, PREV) | |
| limit | number | false | | 翻页大小 | 10 |
| id | number | false | | id | |

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
    "hasPrev": false,
    "hasNext": false,
     "items": [{
                "avatar": "string", // 头像
                "name": "string", // 用户名称
                "profit": 5, // 分润数量
                "profitTime": "time", // 日期
                "coin": 0, // 币种
                "id":  // id
     }]
}
}
```

## 获取带单员预计待分润明细

`GET` `/future/copytrade/user/v1/copy-trade/my-profit-future`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| direction | string | false | | 方向(NEXT, PREV) | NEXT,PREV |
| limit | number | false | | 翻页大小 | 10 |
| id | number | false | | id | |

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
    "hasPrev": false,
    "hasNext": false,
    "items": [{
            "avatar": "string", // 头像
            "name": "string", // 用户名称
            "profit": 5, // 分润数量
            "profitTime": "time", // 日期
            "coin": 0, // 币种
            "id":  // id
    }]
}
}
```

## 获取带单员预计待分润汇总

`GET` `/future/copytrade/user/v1/copy-trade/my-profit-future-total`

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": 0 // 待分润总量
}
```

## 带单员信息

`GET` `/future/copytrade/user/v1/copy-trade/leader-detail`

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
        "nickName": "string", // 名称
        "avatar": "string", // 头像
        "intro": "string", // 简介
        "leadDays": 0, // 入驻时间
        "levelId": 0, // 当前等级id
        "level": 0, // 当前等级
        "levelName": "string", // 当前等级名称
        "label": ["string"], // 标签
        "followNumber": 0, // 累计跟随人数
        "currentFollowNumber": 0, // 当前跟随人数
        "maxFollowerSize": 0, // 最多跟随人数
        "profitRate": 0, // 交易员分润比例
        "platformProfitRate": 0, // 平台分润比例
        "totalRights": 0, // 总权益
        "displayEquity": Boolean, // 是否展示权益
        "displayPosition": Boolean // 是否展示持仓量
  }
}
```

## 取消带单员身份

`GET` `/future/copytrade/user/v1/copy-trade/cancel-leader`

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": Boolean //true成功 false失败
}
```

## 获取交易员/跟单员设置信息

`GET` `/future/copytrade/user/v1/copy-trade/user-settings`

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
        "id": 0, // id
        "intro": "string", // 简介
        "followCapitalMin": 0, // 最小跟单本金
        "labelIds": 0, // 标签id,逗号分割;例:1,2,3,4
        "label": [ // 标签
         {
            "id": 0, // 标签id
            "label": "string", // 标签说明
          }
        ], 
        "autoUnfollow": Boolean, // 是否自动取消跟随
        "displayEquity": Boolean, // 显示总权益：true:展示,false:不展示
        "displayPosition": Boolean, // 显示持仓量：true:展示,false:不展示
        "openLeader": Boolean // 开启带单
  }
}
```

## 新增/修改/撤销带单或跟单止盈止损

`POST` `/future/copytrade/order/v1/copy-trade/update-profit-stop`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| trackNo | number | true | | 交易员带单特有单号 | |
| triggerPriceType | string | true | | 触发价格类型:LATEST\_PRICE,MARK\_PRICE | |
| leaderOrder | boolean | true | | 是否带单:true 带单,false 跟单 | |
| triggerProfitPrice | number | false | | 止盈价 | |
| triggerStopPrice | number | false | | 止损价 | |

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": Boolean //true成功 false失败
}
```

## 带单/跟单一键平仓

`POST` `/future/copytrade/order/v1/copy-trade/close-all`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | false | | 市场名称 | |
| closeLongShortType | string | false | | 平仓方向:LONG;SHORT;BOTH | LONG,SHORT,BOTH |

### 限流规则

5/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": Boolean //true成功 false失败
}
```

## 带单/跟单平仓

`POST` `/future/copytrade/order/v1/copy-trade/close`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| trackNo | number | true | | 交易员带单特有单号 | |
| leaderOrder | boolean | false | | 是否带单:true 带单,false 跟单 | true,false |

### 限流规则

5/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": boolean //true成功 false失败
}
```

## 获取当前跟单

`GET` `/future/copytrade/order/v1/copy-trade/follower-order-list`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| type | number | false | | 查询类型,1:明细,2:汇总 | 12 |
| symbol | string | false | | 交易对 | |
| direction | string | false | | 方向(NEXT, PREV) | NEXT,PREV |
| limit | number | false | | 翻页大小 | 10 |
| id | number | false | | id | |

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
        {
        "symbolName": "string", // 市场名称
        "positionType": "string", // 仓位类型:CROSSED(全仓);ISOLATED(逐仓)
        "positionSide": "string", // 持仓方向:LONG;SHORT
        "openLeverage": 5, // 杠杆
        "id": 0, // id
        "orderId": 0, // 订单id
        "trackNo": 0, // 跟单trackNo
        "openTime": 0, // 开仓时间
        "closeTime": 0, // 平仓时间
        "openPrice": 0, // 开仓均价
        "closePrice": 0, // 平仓均价
        "profitRate": 0, // 收益率
        "openMargin": 0, // 开仓初始保证金
        "realizedPnl": 0, // 已实现盈亏
        "leaderNickname": "string", // 交易员
        "openSize": 0, // 开仓仓位数量
        "closeSize": 0, // 平仓仓位数量
        "positionSize": 0, // 持仓数量
        "closeOrderSize": 0, // 平仓订单占用
        "availableCloseSize": 0, // 可平数量
        "triggerProfitPrice": 0, // 止盈价
        "triggerStopPrice": 0, // 止损价
        "triggerPriceType": "string", // 触发价格类型:LATEST_PRICE,MARK_PRICE
        "avatar": "string" // 头像
        }
]
}
```

## 获取跟单员当前跟单

`GET` `/future/copytrade/order/v1/copy-trade/follower-order-page`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| type | number | false | | 查询类型,1:明细,2:汇总 | 12 |
| symbol | string | false | | 交易对 | |
| direction | string | false | | 方向(NEXT, PREV) | NEXT,PREV |
| limit | number | false | | 翻页大小 | 10 |
| id | number | false | | id | |

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
        {
        "symbolName": "string", // 市场名称
        "positionType": "string", // 仓位类型:CROSSED(全仓);ISOLATED(逐仓)
        "positionSide": "string", // 持仓方向:LONG;SHORT
        "openLeverage": 5, // 杠杆
        "id": 0, // id
        "orderId": 0, // 订单id
        "trackNo": 0, // 跟单trackNo
        "openTime": 0, // 开仓时间
        "closeTime": 0, // 平仓时间
        "openPrice": 0, // 开仓均价
        "closePrice": 0, // 平仓均价
        "profitRate": 0, // 收益率
        "openMargin": 0, // 开仓初始保证金
        "realizedPnl": 0, // 已实现盈亏
        "leaderNickname": "string", // 交易员
        "openSize": 0, // 开仓仓位数量
        "closeSize": 0, // 平仓仓位数量
        "positionSize": 0, // 持仓数量
        "closeOrderSize": 0, // 平仓订单占用
        "availableCloseSize": 0, // 可平数量
        "triggerProfitPrice": 0, // 止盈价
        "triggerStopPrice": 0, // 止损价
        "triggerPriceType": "string", // 触发价格类型:LATEST_PRICE,MARK_PRICE
        "avatar": "string" // 头像
        }
]
}
```

## 获取跟单员历史跟单

`GET` `/future/copytrade/order/v1/copy-trade/follower-order-history`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| type | number | false | | 查询类型,1:明细,2:汇总 | 12 |
| symbol | string | false | | 交易对 | |
| direction | string | false | | 方向(NEXT, PREV) | NEXT,PREV |
| limit | number | false | | 翻页大小 | 10 |
| id | number | false | | id | |

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
        {
        "symbolName": "string", // 市场名称
        "positionType": "string", // 仓位类型:CROSSED(全仓);ISOLATED(逐仓)
        "positionSide": "string", // 持仓方向:LONG;SHORT
        "openLeverage": 5, // 杠杆
        "id": 0, // id
        "orderId": 0, // 订单id
        "trackNo": 0, // 跟单trackNo
        "openTime": 0, // 开仓时间
        "closeTime": 0, // 平仓时间
        "openPrice": 0, // 开仓均价
        "closePrice": 0, // 平仓均价
        "profitRate": 0, // 收益率
        "openMargin": 0, // 开仓初始保证金
        "realizedPnl": 0, // 已实现盈亏
        "leaderNickname": "string", // 交易员
        "openSize": 0, // 开仓仓位数量
        "closeSize": 0, // 平仓仓位数量
        "positionSize": 0, // 持仓数量
        "closeOrderSize": 0, // 平仓订单占用
        "availableCloseSize": 0, // 可平数量
        "triggerProfitPrice": 0, // 止盈价
        "triggerStopPrice": 0, // 止损价
        "triggerPriceType": "string", // 触发价格类型:LATEST_PRICE,MARK_PRICE
        "avatar": "string" // 头像
        }
]
}
```

## 立即跟单

`POST` `/future/copytrade/user/v1/copy-trade/choose-leader`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| leaderAccountId | number | true | | 交易员accountId | |
| symbols | string | true | | 跟单合约交易对,逗号分隔 | |
| followType | string | true | | 跟单类型:FUND(固定保证金);RATE(按倍率跟单);MARGIN\_RATE(同比例跟单) | FUND,RATE,MARGIN\_RATE |
| followVal | number | false | | 跟单本金/跟单比例 | |
| triggerProfitRate | number | false | | 止盈比率 | |
| triggerStopRate | number | false | | 止损比率 | |
| followDirection | string | false | | 跟单方向:正向:FORWARD;反向:REVERSE | FORWARD,REVERSE |
| followLoss | number | false | | 跟单止损 | |
| autoFollowSymbol | boolean | false | | 自动跟单新增合约市场 true是 false否 | true,false |
| followLossOperate | enum | false | | 跟单止损仓位处理 | MARKET\_SELL,LEADER\_CLOSE,MANUAL\_PROCESS |

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": Boolean //true成功  false失败
}
```

## 取消跟随

`POST` `/future/copytrade/user/v1/copy-trade/cancel-choose-leader`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| leaderAccountId | number | true | | 交易员accountId | |

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": Boolean //true成功 false失败
}
```

## 我跟随的交易员列表(当前跟随)

`GET` `/future/copytrade/user/v1/copy-trade/my-follow-list`

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [number,number] //交易员accountId
}
```

## 我的带单员(历史跟随)

`GET` `/future/copytrade/user/v1/copy-trade/follower-leaders-page`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| type | number | false | | 查询类型,1:当前跟随,2:历史跟随 | 12 |
| direction | string | false | | 方向(NEXT, PREV) | NEXT,PREV |
| limit | number | false | | 翻页大小 | 10 |
| id | number | false | | id | |

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
       "hasPrev": false,
       "hasNext": false,
        "items": [
                {
                "leaderName": "string", // 交易员名称
                "avatar": "string", // 头像
                "accountId": 0, // 交易员id
                "id": 0, // id
                "level": 0, // 当前等级
                "levelName": "string", // 当前等级名称
                "followMarginU": 0, // 累计跟随本金,USDT
                "followProfitU": 0, // 累计跟随收益,USDT
                "cancel": Boolean // 状态：0跟随中，1已取消
                 }
          ]
}
```

## 获取跟单合约所有交易对列表

`GET` `/future/copytrade/public/user/v1/public/copy-trade/symbol-list`

### 限流规则

2/s/ip

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [string,string] // 交易对名称
}
```

## 获取交易员当前带单

`GET` `/future/copytrade/public/order/v1/public/copy-trade/leader-order-page`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| type | number | false | | 查询类型,1:明细,2:汇总 | |
| symbol | string | false | | 交易对 | |
| leaderAccountId | number | true | | 交易员帐号 | |
| direction | string | false | | 方向(NEXT, PREV) | |
| limit | number | false | | 翻页大小 | 10 |
| id | number | false | | id | |

### 限流规则

2/s/ip

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
        {
        "symbolName": "string", // 市场名称
        "positionType": "string", // 仓位类型:CROSSED(全仓);ISOLATED(逐仓)
        "positionSide": "string", // 持仓方向:LONG;SHORT
        "openLeverage": 5, // 杠杆
        "id": 0, // id
        "orderId": 0, // 订单id
        "trackNo": 0, // 跟单trackNo
        "openTime": 0, // 开仓时间
        "closeTime": 0, // 平仓时间
        "entryPrice": 0, // 持仓均价
        "openPrice": 0, // 开仓均价
        "closePrice": 0, // 平仓均价
        "profitRate": 0, // 收益率
        "openMargin": 0, // 开仓初始保证金
        "realizedPnl": 0, // 已实现盈亏
        "fee": 0, // 手续费
        "openSize": 0, // 开仓仓位数量
        "closeSize": 0, // 平仓仓位数量
        "positionSize": 0, // 持仓数量
        "closeOrderSize": 0, // 平仓订单占用
        "availableCloseSize": 0, // 可平数量
        "triggerProfitPrice": 0, // 止盈价
        "triggerStopPrice": 0, // 止损价
        "triggerPriceType": "string", // 触发价格类型:LATEST_PRICE,MARK_PRICE
        "followOrderCount": 0 // 跟随订单数
        }
]
}
```

## 获取交易员历史带单

`GET` `/future/copytrade/public/order/v1/public/copy-trade/leader-order-history`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| type | number | false | | 查询类型,1:明细,2:汇总 | 12 |
| symbol | string | false | | 交易对 | |
| leaderAccountId | number | true | | 交易员帐号 | |
| direction | string | false | | 方向(NEXT, PREV) | NEXT, PREV |
| limit | number | false | | 翻页大小 | 10 |
| id | number | false | | id | |

### 限流规则

2/s/ip

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
        {
        "symbolName": "string", // 市场名称
        "positionType": "string", // 仓位类型:CROSSED(全仓);ISOLATED(逐仓)
        "positionSide": "string", // 持仓方向:LONG;SHORT
        "openLeverage": 5, // 杠杆
        "id": 0, // id
        "orderId": 0, // 订单id
        "trackNo": 0, // 跟单trackNo
        "openTime": 0, // 开仓时间
        "closeTime": 0, // 平仓时间
        "entryPrice": 0, // 持仓均价
        "openPrice": 0, // 开仓均价
        "closePrice": 0, // 平仓均价
        "profitRate": 0, // 收益率
        "openMargin": 0, // 开仓初始保证金
        "realizedPnl": 0, // 已实现盈亏
        "fee": 0, // 手续费
        "openSize": 0, // 开仓仓位数量
        "closeSize": 0, // 平仓仓位数量
        "positionSize": 0, // 持仓数量
        "closeOrderSize": 0, // 平仓订单占用
        "availableCloseSize": 0, // 可平数量
        "triggerProfitPrice": 0, // 止盈价
        "triggerStopPrice": 0, // 止损价
        "triggerPriceType": "string", // 触发价格类型:LATEST_PRICE,MARK_PRICE
        "followOrderCount": 0 // 跟随订单数
        }
]
}
```

## 获取交易员收益额图表

`GET` `/future/copytrade/public/user/v1/public/copy-trade/leader-day-income`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| accountId | number | true | | 交易员帐号 | |
| days | number | false | | 天数 | |

### 限流规则

2/s/ip

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
        {
        "amount": 0, // 收益额
        "time": 0 // 时间
        }
]
}
```

## 获取交易员收益率图表

`GET` `/future/copytrade/public/user/v1/public/copy-trade/leader-day-income-rate`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| accountId | number | true | | 交易员帐号 | |
| days | number | false | | 天数 | |

### 限流规则

2/s/ip

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
       "totalIncome":[{
        "amount": 0, // 额度
         "time": 0 // 时间
        }],
       "totalIncomeRate":[{
        "amount": 0, // 额度
        "time": 0 // 时间
        }],
        "incomeRate":[
         {"amount": 0, // 额度
         "time": 0 // 时间
         }]
}
}
```

## 获取交易员带单情况

`GET` `/future/copytrade/public/user/v1/public/copy-trade/leader-stats`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| accountId | number | true | | 交易员帐号 | |
| days | number | false | | 天数 | |

### 限流规则

2/s/ip

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result":{
        "recentRate": 0, // 收益率
        "totalEarnings": 0, // 总收益
        "maxRetraction": 0, // 最大回撤
        "followersEarnings": 0, // 跟单者收益
        "winRate": 0, // 胜率
        "totalTransactions": 0, // 交易次数
        "profitCount": 0, // 盈利次数
        "lossCount": 0, // 亏损次数
        "avgProfitAmount": 0, // 平均盈利
        "avgLossAmount": 0, // 平均亏损
        "pnlRate": 0, // 盈亏比
        "avgHoldTime": 0, // 平均持仓时间(秒)
        "weeklyTradeFrequency": 0, // 交易频次(每周)
        "followerTradeAmount": 0, // 带单规模(废弃)
        "followerMargin": 0, // 带单规模
        "tradeDays": 0, // 交易天数
        "lastTradeTime": 0, // 最近交易时间
}
}
```

## 获取交易员交易偏好

`GET` `/future/copytrade/public/user/v1/public/copy-trade/leader-symbol-prefer`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| accountId | number | true | | 交易员帐号 | |
| recentDays | number | false | | 天数 | |

### 限流规则

2/s/ip

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result":{
        "index": 0, // 
        "symbol": "string", // 交易对
        "count": 0, // 最大回撤
        "percentage": 0, // 占比
        "pnl": 0 // 交易盈亏
}
}
```

## 获取交易员详情

`GET` `/future/copytrade/public/user/v1/public/copy-trade/leader-detail-v2`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| accountId | number | true | | 交易员帐号 | |

### 限流规则

2/s/ip

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
        "nickName": "string", // 名称
        "avatar": "string", // 头像
        "intro": "string", // 简介
        "leadDays": 0, // 入驻时间
        "levelId": 0, // 当前等级id
        "level": 0, // 当前等级
        "levelName": "string", // 当前等级名称
        "label": ["string"], // 标签
        "followNumber": 0, // 累计跟随人数
        "currentFollowNumber": 0, // 当前跟随人数
        "maxFollowerSize": 0, // 最多跟随人数
        "profitRate": 0, // 交易员分润比例
        "platformProfitRate": 0, // 平台分润比例
        "totalRights": 0, // 总权益
        "displayEquity": Boolean, // 是否展示权益
        "displayPosition": Boolean // 是否展示持仓量
 }
}
```

## 获取跟单员信息

`GET` `/future/copytrade/user/v1/copy-trade/leader-relation`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| leaderAccountId | number | true | | 交易员账号 | |

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
        "leaderAccountId": 0, // 交易员accountId
        "symbols": "string", // 市场
        "followLoss": 0, // 跟单止损
        "followLossOperate": enum, // 跟单止损仓位处理 MARKET_SELL,LEADER_CLOSE,MANUAL_PROCESS
        "triggerProfitRate": 0, // 止盈比率
        "triggerStopRate": 0, // 止损比率
        "cancel": Boolean, // 是否已取消跟随
        "followDirection": 0, // 跟单方向:正向:FORWARD;反向:REVERSE
        "followType": 0, // 跟单类型:FUND(固定保证金);RATE(按倍率跟单);MARGIN_RATE(同比例跟单)
        "followVal": 0, // 跟单本金/跟单比例
        "autoFollowSymbol": Boolean // 自动跟单新增合约市场 true是 false否
}
}
```

## 获取交易员的跟单人信息

`GET` `/future/copytrade/public/user/v1/public/copy-trade/leader-follower-page`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| type | number | false | | 查询类型,1:明细,2:汇总 | |
| symbol | string | false | | 交易对 | |
| leaderAccountId | number | true | | 交易员帐号 | |
| direction | string | false | | 方向(NEXT, PREV) | NEXT,PREV |
| limit | number | false | | 翻页大小 | 10 |
| id | number | false | | id | |

### 限流规则

2/s/ip

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
        {
        "accountId": 0, // 跟单员帐号id
        "followerName": "string", // 跟随用户昵称
        "avatar": "string", // 头像
        "id": 0, // id
        "pageId": 0, // pageId
        "followMarginU": 0, // 累计跟随本金USDT
        "followProfitU": 0, // 累计跟随收益USDT
        "followProfitRate": 0, // 跟单收益率
        "days": 0 // 跟单天数
        }
]
}
```

## 查看杠杆倍数

`GET` `/future/copytrade/order/v1/position/list`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | false | | 市场 | |
| welfareAccountVersion | string | false | | 版本号 | |

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
          {
            "symbol": "string", //市场
            "positionType": "string",//仓位类型:CROSSED(全仓);ISOLATED(逐仓)
            "positionSide": "string",//持仓方向
            "contractType": "string",//合约类型：PERPETUAL(永续合约)、PREDICT(预测合约)
            "positionSize": 0,// 持仓数量
            "closeOrderSize": 0,//平仓挂单数量
            "availableCloseSize": 0,//可平仓数量
            "entryPrice": 0,//开仓均价
            "openOrderSize": 0,//开仓订单占用
            "isolatedMargin": 0,// 逐仓保证金
            "openOrderMarginFrozen": 0,//开仓订单保证金占用
            "realizedProfit": 0,//已实现盈亏
            "autoMargin": false,//是否自动追加保证金
            "leverage": 0, // 杠杆倍数
            "profitId": 0,//止盈止损id
            "triggerPriceType": 0,//触发价格类型 1、指数价格 2：标记价格（合理价格）；3：最新价
            "triggerProfitPrice": 0,//止盈触发价
            "triggerStopPrice": 0,//止损触发价
            "welfareAccount": boolean //是否是体验金账户
           }
  ]
}
```

## 调整杠杆倍数

`POST` `/future/copytrade/order/v1/position/adjust-leverage`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| symbol | string | true | | 市场 | |
| leverage | number | true | | 杠杆倍数 | |
| positionSide | PositionSide | false | | 仓位方向 | LONG,SHORT,BOTH |

### 限流规则

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": Boolean //true成功 false失败
}
```


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