> ## 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.

# Futures: endpoints

> Copy trading API: futures: endpoints.

## Get leader current order

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| type | number | true | | type,1(detail),2(total) | 12 |
| symbol | string | false | | symbol | |
| direction | string | false | | direction | NEXT,PREV |
| limit | number | false | | page size | 10 |
| id | number | false | | id | |

### Limit Flow Rules

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
        {
        "symbolName": "string", // symbol
        "positionType": "string", // position type:CROSSED;ISOLATED
        "positionSide": "string", // direction:LONG;SHORT
        "openLeverage": 5, // leverage
        "id": 0, // id
        "orderId": 0, // order id
        "trackNo": 0, // trackNo
        "openTime": 0, // open time
        "closeTime": 0, // close time
        "entryPrice": 0, // position price
        "openPrice": 0, // open price
        "closePrice": 0, // close price
        "profitRate": 0, // profit rate
        "openMargin": 0, // open margin
        "realizedPnl": 0, // realized pnl
        "fee": 0, // fee
        "openSize": 0, // open quantity
        "closeSize": 0, // close quantity
        "positionSize": 0, // position quantity
        "closeOrderSize": 0, // close order quantity
        "availableCloseSize": 0, // available close quantity
        "triggerProfitPrice": 0, // trigger profit price
        "triggerStopPrice": 0, // trigger stop price
        "triggerPriceType": "string", // trigger price type:LATEST_PRICE,MARK_PRICE
        "followOrderCount": 0 // follow order count
        }
]
}
```

## Get leader current order page

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| type | number | true | | type,1(detail),2(total) | 12 |
| symbol | string | false | | symbol | |
| direction | string | false | | direction | NEXT,PREV |
| limit | number | false | | page size | 10 |
| id | number | false | | id | |

### Limit Flow Rules

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
        {
        "symbolName": "string", // symbol
        "positionType": "string", // position type:CROSSED;ISOLATED
        "positionSide": "string", // direction:LONG;SHORT
        "openLeverage": 5, // leverage
        "id": 0, // id
        "orderId": 0, // order id
        "trackNo": 0, // trackNo
        "openTime": 0, // open time
        "closeTime": 0, // close time
        "entryPrice": 0, // position price
        "openPrice": 0, // open price
        "closePrice": 0, // close price
        "profitRate": 0, // profit rate
        "openMargin": 0, // open margin
        "realizedPnl": 0, // realized pnl
        "fee": 0, // fee
        "openSize": 0, // open quantity
        "closeSize": 0, // close quantity
        "positionSize": 0, // position quantity
        "closeOrderSize": 0, // close order quantity
        "availableCloseSize": 0, // available close quantity
        "triggerProfitPrice": 0, // trigger profit price
        "triggerStopPrice": 0, // trigger stop price
        "triggerPriceType": "string", // trigger price type:LATEST_PRICE,MARK_PRICE
        "followOrderCount": 0 // follow order count
        }
]
}
```

## Get leader history order page

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| type | number | true | | type,1(detail),2(total) | 12 |
| symbol | string | false | | symbol | |
| direction | string | false | | direction | NEXT,PREV |
| limit | number | false | | page size | 10 |
| id | number | false | | id | |

### Limit Flow Rules

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
    "hasPrev": false,
    "hasNext": false,
    "items": [
            {
            "symbolName": "string", // symbol
            "positionType": "string", // position type:CROSSED;ISOLATED
            "positionSide": "string", // direction:LONG;SHORT
            "openLeverage": 5, // leverage
            "id": 0, // id
            "orderId": 0, // order id
            "trackNo": 0, // trackNo
            "openTime": 0, // open time
            "closeTime": 0, // close time
            "entryPrice": 0, // position price
            "openPrice": 0, // open price
            "closePrice": 0, // close price
            "profitRate": 0, // profit rate
            "openMargin": 0, // open margin
            "realizedPnl": 0, // realized pnl
            "fee": 0, // fee
            "openSize": 0, // open quantity
            "closeSize": 0, // close quantity
            "positionSize": 0, // position quantity
            "closeOrderSize": 0, // close order quantity
            "availableCloseSize": 0, // available close quantity
            "triggerProfitPrice": 0, // trigger profit price
            "triggerStopPrice": 0, // trigger stop price
            "triggerPriceType": "string", // trigger price type:LATEST_PRICE,MARK_PRICE
            "followOrderCount": 0 // follow order count
            }
        ]
}
}
```

## Get leader history profit detail

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| divideTime | number | true | | time | |
| direction | string | false | | direction | NEXT,PREV |
| limit | number | false | | page size | 10 |
| id | number | false | | id | |

### Limit Flow Rules

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
        "hasPrev": false,
        "hasNext": false,
        "items": [
                {
                "avatar": "string", // avatar
                "name": "string", // leader name
                "profit": 5, // amount
                "profitTime": "time", // time
                "coin": 0, // currency
                "id":  // id
                }
        ]
}
}
```

## Get leader future profit total

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| direction | string | false | | direction | NEXT,PREV |
| limit | number | false | | page size | 10 |
| id | number | false | | id | |

### Limit Flow Rules

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
    "hasPrev": false,
    "hasNext": false,
     "items": [
               {
                "avatar": "string", // avatar
                "name": "string", // leader name
                "profit": 5, // amount
                "profitTime": "time", // time
                "coin": 0, // currency
                "id":  // id
                }
       ]
}
}
```

## Get leader future profit detail

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| direction | string | false | | direction | NEXT,PREV |
| limit | number | false | | page size | 10 |
| id | number | false | | id | |

### Limit Flow Rules

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
    "hasPrev": false,
    "hasNext": false,
    "items": [
            {
            "avatar": "string", // avatar
            "name": "string", // leader name
            "profit": 5, // amount
            "profitTime": "time", // time
            "coin": 0, // currency
            "id":  // id
            }
    ]
}
}
```

## Get leader future profit total

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

### Limit Flow Rules

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": 0 // amount
}
```

## Get leader info

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

### Limit Flow Rules

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
        "nickName": "string", // nickName
        "avatar": "string", // avatar
        "intro": "string", // intro
        "leadDays": 0, // begin time
        "levelId": 0, // leader level id
        "level": 0, // leader level
        "levelName": "string", // leader level name
        "label": ["string"], // labels
        "followNumber": 0, // leader's follower count
        "currentFollowNumber": 0, // leader's current follower count
        "maxFollowerSize": 0, // leader's max follower count
        "profitRate": 0, // leader profit rate
        "platformProfitRate": 0, // platform profit rate
        "totalRights": 0, // total amount
        "displayEquity": Boolean, // is display amount
        "displayPosition": Boolean // is display position
 }
}
```

## Cancel leader

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

### Limit Flow Rules

2/s/apikey

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

## Get user setting

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

### Limit Flow Rules

10/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
        "id": 0, // id
        "intro": "string", // intro
        "followCapitalMin": 0, // margin
        "labelIds": 0, // label id
        "label": [ // labels
         {
            "id": 0, // id
            "label": "string", // remark
          }
        ], 
        "autoUnfollow": Boolean, // is auto cancel follow
        "displayEquity": Boolean, // is display total amount
        "displayPosition": Boolean, // is display position
        "openLeader": Boolean // is open lead trading
 }
}
```

## Add/update/cancel profit-stop order

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| trackNo | number | true | | trackNo | |
| triggerPriceType | string | true | | trigger Price Type | LATEST\_PRICE,MARK\_PRICE |
| leaderOrder | boolean | true | | is leader order | true,false |
| triggerProfitPrice | number | false | | trigger profit price | |
| triggerStopPrice | number | false | | trigger stop price | |

### Limit Flow Rules

10/s/apikey

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

## Close all orders

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | false | | symbol | |
| closeLongShortType | string | false | | direction | LONG,SHORT,BOTH |

### Limit Flow Rules

5/s/apikey

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

## Close order

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| trackNo | number | true | | track no | |
| leaderOrder | boolean | false | | is leader's order | true,false |

### Limit Flow Rules

5/s/apikey

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

## Get follower current order

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| type | number | false | | type,1(detail),2(total) | 12 |
| symbol | string | false | | symbol | |
| direction | string | false | | direction | NEXT,PREV |
| limit | number | false | | page size | 10 |
| id | number | false | | id | |

### Limit Flow Rules

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
            {
            "symbolName": "string", // symbol
            "positionType": "string", // position type:CROSSED;ISOLATED
            "positionSide": "string", // direction:LONG;SHORT
            "openLeverage": 5, // leverage
            "id": 0, // id
            "orderId": 0, // order id
            "trackNo": 0, // trackNo
            "openTime": 0, // open time
            "closeTime": 0, // close time
            "openPrice": 0, // open price
            "closePrice": 0, // close price
            "profitRate": 0, // profit rate
            "openMargin": 0, // open margin
            "realizedPnl": 0, // realized pnl
            "leaderNickname": "string", // leader name
            "openSize": 0, // open quantity
            "closeSize": 0, // close quantity
            "positionSize": 0, // position quantity
            "closeOrderSize": 0, // close order quantity
            "availableCloseSize": 0, // available close quantity
            "triggerProfitPrice": 0, // trigger profit price
            "triggerStopPrice": 0, // trigger stop price
            "triggerPriceType": "string", // trigger price type:LATEST_PRICE,MARK_PRICE
            "avatar": "string" // avatar
            }
]
}
```

## Get follower current order page

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| type | number | false | | type,1(detail),2(total) | 12 |
| symbol | string | false | | symbol | |
| direction | string | false | | direction | NEXT,PREV |
| limit | number | false | | page size | 10 |
| id | number | false | | id | |

### Limit Flow Rules

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
            {
            "symbolName": "string", // symbol
            "positionType": "string", // position type:CROSSED;ISOLATED
            "positionSide": "string", // direction:LONG;SHORT
            "openLeverage": 5, // leverage
            "id": 0, // id
            "orderId": 0, // order id
            "trackNo": 0, // trackNo
            "openTime": 0, // open time
            "closeTime": 0, // close time
            "openPrice": 0, // open price
            "closePrice": 0, // close price
            "profitRate": 0, // profit rate
            "openMargin": 0, // open margin
            "realizedPnl": 0, // realized pnl
            "leaderNickname": "string", // leader name
            "openSize": 0, // open quantity
            "closeSize": 0, // close quantity
            "positionSize": 0, // position quantity
            "closeOrderSize": 0, // close order quantity
            "availableCloseSize": 0, // available close quantity
            "triggerProfitPrice": 0, // trigger profit price
            "triggerStopPrice": 0, // trigger stop price
            "triggerPriceType": "string", // trigger price type:LATEST_PRICE,MARK_PRICE
            "avatar": "string" // avatar
            }
]
}
```

## Get follower history order page

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| type | number | false | | type,1(detail),2(total) | 12 |
| symbol | string | false | | symbol | |
| direction | string | false | | direction | NEXT,PREV |
| limit | number | false | | page size | 10 |
| id | number | false | | id | |

### Limit Flow Rules

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
        {
        "symbolName": "string", // symbol
        "positionType": "string", // position type:CROSSED;ISOLATED
        "positionSide": "string", // direction:LONG;SHORT
        "openLeverage": 5, // leverage
        "id": 0, // id
        "orderId": 0, // order id
        "trackNo": 0, // trackNo
        "openTime": 0, // open time
        "closeTime": 0, // close time
        "openPrice": 0, // open price
        "closePrice": 0, // close price
        "profitRate": 0, // profit rate
        "openMargin": 0, // open margin
        "realizedPnl": 0, // realized pnl
        "leaderNickname": "string", // leader name
        "openSize": 0, // open quantity
        "closeSize": 0, // close quantity
        "positionSize": 0, // position quantity
        "closeOrderSize": 0, // close order quantity
        "availableCloseSize": 0, // available close quantity
        "triggerProfitPrice": 0, // trigger profit price
        "triggerStopPrice": 0, // trigger stop price
        "triggerPriceType": "string", // trigger price type:LATEST_PRICE,MARK_PRICE
        "avatar": "string" // avatar
        }
]
}
```

## Choose leader

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| leaderAccountId | number | true | | leader accountId | |
| symbols | string | true | | symbol | |
| followType | string | true | | follow type | FUND,RATE,MARGIN\_RATE |
| followVal | number | false | | | |
| triggerProfitRate | number | false | | profit rate | |
| triggerStopRate | number | false | | stop rate | |
| followDirection | string | false | | direction | FORWARD,REVERSE |
| followLoss | number | false | | follow loss | |
| autoFollowSymbol | boolean | false | | is auto follow symbol | true,false |
| followLossOperate | enum | false | | follow loss operation | MARKET\_SELL,LEADER\_CLOSE,MANUAL\_PROCESS |

### Limit Flow Rules

2/s/apikey

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

## Cancel follow leader

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| leaderAccountId | number | true | | leader accountId | |

### Limit Flow Rules

2/s/apikey

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

## Get my current leaders

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

### Limit Flow Rules

2/s/apikey

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

## Get my history leaders

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| type | number | false | | type(1:current follow,2:history follow) | 12 |
| direction | string | false | | direction | NEXT, PREV |
| limit | number | false | | page size | 10 |
| id | number | false | | id | |

### Limit Flow Rules

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
       "hasPrev": false,
       "hasNext": false,
        "items": [
{
        "leaderName": "string", // leader nickname
        "avatar": "string", // avatar
        "accountId": 0, // leader accountId
        "id": 0, // id
        "level": 0, // level
        "levelName": "string", // level name
        "followMarginU": 0, // total follow margin
        "followProfitU": 0, // total follow profit
        "cancel": Boolean // status：0 following，1canceled
}
]
}
```

## Get available symbol list

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

### Limit Flow Rules

2/s/ip

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [string,string] // symbols
}
```

## Public get leader current orders

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| type | number | false | | type(1:detail, 2:total) | 12 |
| symbol | string | false | | symbol | |
| leaderAccountId | number | true | | leader accountId | |
| direction | string | false | | direction | NEXT, PREV |
| limit | number | false | | page size | 10 |
| id | number | false | | id | |

### Limit Flow Rules

2/s/ip

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
        {
        "symbolName": "string", // symbol
        "positionType": "string", // position type:CROSSED;ISOLATED
        "positionSide": "string", // direction:LONG;SHORT
        "openLeverage": 5, // leverage
        "id": 0, // id
        "orderId": 0, // order id
        "trackNo": 0, // trackNo
        "openTime": 0, // open time
        "closeTime": 0, // close time
        "entryPrice": 0, // position price
        "openPrice": 0, // open price
        "closePrice": 0, // close price
        "profitRate": 0, // profit rate
        "openMargin": 0, // open margin
        "realizedPnl": 0, // realized pnl
        "fee": 0, // fee
        "openSize": 0, // open quantity
        "closeSize": 0, // close quantity
        "positionSize": 0, // position quantity
        "closeOrderSize": 0, // close order quantity
        "availableCloseSize": 0, // available close quantity
        "triggerProfitPrice": 0, // trigger profit price
        "triggerStopPrice": 0, // trigger stop price
        "triggerPriceType": "string", // trigger price type:LATEST_PRICE,MARK_PRICE
        "followOrderCount": 0 // follow order count
        }
]
}
```

## Public get leader history orders

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| type | number | false | | type(1:detail, 2:total) | 12 |
| symbol | string | false | | symbol | |
| leaderAccountId | number | true | | leader accountId | |
| direction | string | false | | direction | NEXT, PREV |
| limit | number | false | | page size | 10 |
| id | number | false | | id | |

### Limit Flow Rules

2/s/ip

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
        {
        "symbolName": "string", // symbol
        "positionType": "string", // position type:CROSSED;ISOLATED
        "positionSide": "string", // direction:LONG;SHORT
        "openLeverage": 5, // leverage
        "id": 0, // id
        "orderId": 0, // order id
        "trackNo": 0, // trackNo
        "openTime": 0, // open time
        "closeTime": 0, // close time
        "entryPrice": 0, // position price
        "openPrice": 0, // open price
        "closePrice": 0, // close price
        "profitRate": 0, // profit rate
        "openMargin": 0, // open margin
        "realizedPnl": 0, // realized pnl
        "fee": 0, // fee
        "openSize": 0, // open quantity
        "closeSize": 0, // close quantity
        "positionSize": 0, // position quantity
        "closeOrderSize": 0, // close order quantity
        "availableCloseSize": 0, // available close quantity
        "triggerProfitPrice": 0, // trigger profit price
        "triggerStopPrice": 0, // trigger stop price
        "triggerPriceType": "string", // trigger price type:LATEST_PRICE,MARK_PRICE
        "followOrderCount": 0 // follow order count
        }
]
}
```

## Public get leader day income

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| accountId | number | true | | leader accountId | |
| days | number | false | | days | |

### Limit Flow Rules

2/s/ip

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

## Public get leader day income rate

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| accountId | number | true | | leader accountId | |
| days | number | false | | days | |

### Limit Flow Rules

2/s/ip

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

## Public get leader statistics

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| accountId | number | true | | leader accountId | |
| days | number | false | | days | |

### Limit Flow Rules

2/s/ip

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result":{
"recentRate": 0, // current rate
"totalEarnings": 0, // total current
"maxRetraction": 0, // max retraction
"followersEarnings": 0, // follower's earning
"winRate": 0, // win rate
"totalTransactions": 0, // total transactions
"profitCount": 0, // profit count
"lossCount": 0, // loss count
"avgProfitAmount": 0, // avg profit amount
"avgLossAmount": 0, // avg loss amount
"pnlRate": 0, // profit loss rate
"avgHoldTime": 0, // avg hold time
"weeklyTradeFrequency": 0, // trade frequency
"followerMargin": 0, // follower total margin
"tradeDays": 0, // total trade days
"lastTradeTime": 0, // last tradetime
}
}
```

## Public get leader's prefer

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| accountId | number | true | | leader accountId | |
| recentDays | number | false | | days | |

### Limit Flow Rules

2/s/ip

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result":{
        "index": 0, // 
        "symbol": "string", // symbol
        "count": 0, // count
        "percentage": 0, // percent
        "pnl": 0 // pnl
 }
}
```

## Public get leader info

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| accountId | number | true | | leader accountId | |

### Limit Flow Rules

2/s/ip

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
        "nickName": "string", // nickName
        "avatar": "string", // avatar
        "intro": "string", // intro
        "leadDays": 0, // begin time
        "levelId": 0, // leader level id
        "level": 0, // leader level
        "levelName": "string", // leader level name
        "label": ["string"], // labels
        "followNumber": 0, // leader's follower count
        "currentFollowNumber": 0, // leader's current follower count
        "maxFollowerSize": 0, // leader's max follower count
        "profitRate": 0, // leader profit rate
        "platformProfitRate": 0, // platform profit rate
        "totalRights": 0, // total amount
        "displayEquity": Boolean, // is display amount
        "displayPosition": Boolean // is display position
 }
}
```

## Get follower info

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| leaderAccountId | number | true | | leader account | |

### Limit Flow Rules

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": {
        "leaderAccountId": 0, // leader accountId
        "symbols": "string", // symbol
        "followLoss": 0, // follow loss
        "followLossOperate": enum, // operatio(MARKET_SELL,LEADER_CLOSE,MANUAL_PROCESS)
        "triggerProfitRate": 0, // trigger profit rate
        "triggerStopRate": 0, // trigger stop rate
        "cancel": Boolean, // is cancel (true=canceled, false=uncanceled)
        "followDirection": 0, // direction:FORWARDREVERSE
        "followType": 0, // flow type:FUND;RATE;MARGIN_RATE
        "followVal": 0, // follow val
        "autoFollowSymbol": Boolean // is auto follow new add symbol
}
}
```

## Public get leader's followers

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| type | number | false | | type(1:detail,2:total) | 12 |
| symbol | string | false | | symbol | |
| leaderAccountId | number | true | | leader accountId | |
| direction | string | false | | direction | NEXT, PREV |
| limit | number | false | | page size | 10 |
| id | number | false | | id | |

### Limit Flow Rules

2/s/ip

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
        {
        "accountId": 0, // leader accountId
        "followerName": "string", // follower nickname
        "avatar": "string", // avatar
        "id": 0, // id
        "pageId": 0, // pageId
        "followMarginU": 0, // follower total margin
        "followProfitU": 0, // follower total profit
        "followProfitRate": 0, // follower profit rate
        "days": 0 // days
        }
]
}
```

## Get leverage list

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | false | | symbol | |
| welfareAccountVersion | string | false | | version | |

### Limit Flow Rules

2/s/apikey

```json Response theme={null}
{
"returnCode": 0,
"msgInfo": "success",
"error": null,
"result": [
          {
            "symbol": "string", //symbol
            "positionType": "string",//position type:CROSSED;ISOLATED
            "positionSide": "string",//direction
            "contractType": "string",//contract type：PERPETUAL、PREDICT
            "positionSize": 0,// position size
            "closeOrderSize": 0,//close order size
            "availableCloseSize": 0,//available close size
            "entryPrice": 0,//open price
            "openOrderSize": 0,//open order size
            "isolatedMargin": 0,// isolated margin
            "openOrderMarginFrozen": 0,//open order margin frozen
            "realizedProfit": 0,//realized pnl
            "autoMargin": false,//is auto add margin
            "leverage": 0, // leverage
            "profitId": 0,//profit order id
            "triggerPriceType": 0,//trigger price type 1index price 2mark price 3deal price
            "triggerProfitPrice": 0,//trigger profit price
            "triggerStopPrice": 0,//trigger stop price
            "welfareAccount": boolean //is welfare account
           }
  ]
}
```

## adjust leverage

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| symbol | string | true | | symbol | |
| leverage | number | true | | leverage | |
| positionSide | enum | false | | direction | LONG,SHORT,BOTH |

### Limit Flow Rules

2/s/apikey

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


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