Follower API

Endpoint

Download Schema

Get Copy Follower Open Orders (USER_DATA)

Get Copy Follower Open Orders (USER_DATA).

GET

/capi/v3/copy/follower/openOrders

https://api-contract.weex.com

Request weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.

Learn more in the Access Restrictions section.

IP weight10

Get Copy Follower Open Orders (USER_DATA) › query Parameters

symbol

string

Filter by symbol, for example BTCUSDT.

limit

integer

Page size, 1-100. Default: 100.

page

integer

Page number, starts from 1. Default: 1.

Get Copy Follower Open Orders (USER_DATA) › Responses

200

Successful response

object[]

trackingNo

integer

Tracking order ID.

traderName

string

Copy trader name.

openOrderId

integer

Open order ID generated by the trading system.

closeOrderId

integer

Close order ID.

traderID

integer

Copy trader UID.

symbol

string

Symbol.

openLeverage

integer

Open leverage.

openPriceAvg

string

Average open price.

openTime

integer

Open time in milliseconds.

openSize

string

Open order size.

openFee

string

Open fee.

openMarginAmount

string

Open margin amount.

openFillSize

string

Filled open size.

positionSide

string

Position side: LONG, SHORT, or BOTH.

status

string

Tracking order status.

tpTriggerPrice

string

Take-profit trigger price.

slTriggerPrice

string

Stop-loss trigger price.

closeAvgPrice

string

Average close price.

closeSize

string

Close size.

closeTime

string

Close time.

realizedPnl

string

Realized PnL.

profitRate

string

Profit rate.

netProfit

string

Follower net profit.

createdTime

integer

Create time in milliseconds.

updateTime

integer

Update time in milliseconds.

GET/capi/v3/copy/follower/openOrders

curl "https://api-contract.weex.com/capi/v3/copy/follower/openOrders?symbol=BTCUSDT&traderId=123456&limit=50&page=1" \
   -H "ACCESS-KEY:*******" \
   -H "ACCESS-SIGN:*******" \
   -H "ACCESS-PASSPHRASE:*****" \
   -H "ACCESS-TIMESTAMP:1659076670000"

[
  {
    "trackingNo": 9000000001,
    "traderName": "Lead Trader",
    "openOrderId": 702345678901234600,
    "closeOrderId": 0,
    "traderID": 123456,
    "symbol": "BTCUSDT",
    "openLeverage": 10,
    "openPriceAvg": "69000",
    "openTime": 1764505800000,
    "openSize": "0.01",
    "openFee": "0.414",
    "openMarginAmount": "69",
    "openFillSize": "0.01",
    "positionSide": "LONG",
    "status": "HAVE_OPEN",
    "tpTriggerPrice": "72000",
    "slTriggerPrice": "67000",
    "closeAvgPrice": "",
    "closeSize": "0",
    "closeTime": "",
    "realizedPnl": "0",
    "profitRate": "0.12",
    "netProfit": "0",
    "createdTime": 1764505800000,
    "updateTime": 1764505900000
  }
]

json

application/json

Get Copy Follower History Orders (USER_DATA)

Get Copy Follower History Orders (USER_DATA).

GET

/capi/v3/copy/follower/historyOrders

https://api-contract.weex.com

Request weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.

Learn more in the Access Restrictions section.

IP weight10

Get Copy Follower History Orders (USER_DATA) › query Parameters

symbol

string

Filter by symbol, for example BTCUSDT.

limit

integer

Page size, 1-100. Default: 100.

startTime

integer

Start time in milliseconds. The maximum query range is 90 days.

endTime

integer

End time in milliseconds. The maximum query range is 90 days.

nextKeyId

integer

Cursor ID returned from the previous page.

nextKeyTime

integer

Cursor time returned from the previous page.

Get Copy Follower History Orders (USER_DATA) › Responses

200

Successful response

object[]

History tracking order list. The item structure is the same as Get Copy Follower Open Orders.

nextFlag

boolean

Whether there is a next page.

nextKey

object | null

Cursor for the next page.

GET/capi/v3/copy/follower/historyOrders

curl "https://api-contract.weex.com/capi/v3/copy/follower/historyOrders?symbol=BTCUSDT&limit=50" \
   -H "ACCESS-KEY:*******" \
   -H "ACCESS-SIGN:*******" \
   -H "ACCESS-PASSPHRASE:*****" \
   -H "ACCESS-TIMESTAMP:1659076670000"

{
  "list": [
    {
      "trackingNo": 9000000001,
      "traderName": "Lead Trader",
      "openOrderId": 702345678901234600,
      "closeOrderId": 702345678901234700,
      "traderID": 123456,
      "symbol": "BTCUSDT",
      "openLeverage": 10,
      "openPriceAvg": "69000",
      "openTime": 1764505800000,
      "openSize": "0.01",
      "openFee": "0.414",
      "openMarginAmount": "69",
      "openFillSize": "0.01",
      "positionSide": "LONG",
      "status": "CLOSED",
      "tpTriggerPrice": "72000",
      "slTriggerPrice": "67000",
      "closeAvgPrice": "70000",
      "closeSize": "0.01",
      "closeTime": "1764505900000",
      "realizedPnl": "10",
      "profitRate": "0.12",
      "netProfit": "9.5",
      "createdTime": 1764505800000,
      "updateTime": 1764505900000
    }
  ],
  "nextFlag": false,
  "nextKey": null
}

json

application/json

Get My Copy Traders (USER_DATA)

Get My Copy Traders (USER_DATA).

GET

/capi/v3/copy/follower/myTraders

https://api-contract.weex.com

Request weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.

Learn more in the Access Restrictions section.

IP weight10

Get My Copy Traders (USER_DATA) › query Parameters

pageNo

integer

Page number, starts from 1. Default: 1.

pageSize

integer

Page size, 1-100. Default: 100.

Get My Copy Traders (USER_DATA) › Responses

200

Successful response

object[]

Trader list.

nextFlag

boolean

Whether there is a next page.

total

integer

Total count.

Get Copy Follower Settings (USER_DATA)

Get Copy Follower Settings (USER_DATA).

GET

/capi/v3/copy/follower/settings

https://api-contract.weex.com

Request weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.

Learn more in the Access Restrictions section.

IP weight10

Get Copy Follower Settings (USER_DATA) › query Parameters

traderId

integer · required

Copy trader UID.

Get Copy Follower Settings (USER_DATA) › Responses

200

Successful response

object[]

copyEnable

boolean

Whether the user is currently copying this trader.

symbol

string | null

Symbol. Unified settings return null.

symbols

string[]

Symbol list. Used for unified settings.

productType

string

Product type, currently USDT-FUTURES.

settingMode

string

Setting mode: unified or per_symbol.

traceType

string

Copy type: percent or amount.

traceValue

string

Copy value.

maxHoldSize

string

Maximum copy holding size.

marginType

string

Margin type: cross, isolated, or trader.

marginCoin

string

Margin coin, currently USDT.

leverageType

string

Leverage type: fixed, trader, or specify.

longLeverage

integer

Long leverage.

shortLeverage

integer

Short leverage.

object[]

Custom leverage list.

takeProfitRatio

string

Take-profit ratio.

stopLossRatio

string

Stop-loss ratio.

slippageRatio

string

Slippage ratio.

GET/capi/v3/copy/follower/settings

curl "https://api-contract.weex.com/capi/v3/copy/follower/settings?traderId=123456" \
   -H "ACCESS-KEY:*******" \
   -H "ACCESS-SIGN:*******" \
   -H "ACCESS-PASSPHRASE:*****" \
   -H "ACCESS-TIMESTAMP:1659076670000"

[
  {
    "copyEnable": true,
    "symbol": null,
    "symbols": [
      "BTCUSDT",
      "ETHUSDT"
    ],
    "productType": "USDT-FUTURES",
    "settingMode": "unified",
    "traceType": "amount",
    "traceValue": "100",
    "maxHoldSize": "1000",
    "marginType": "trader",
    "marginCoin": "USDT",
    "leverageType": "specify",
    "longLeverage": 10,
    "shortLeverage": 10,
    "customLeverages": [
      {
        "symbol": "BTCUSDT",
        "longLeverage": 10,
        "shortLeverage": 10
      }
    ],
    "takeProfitRatio": "0.2",
    "stopLossRatio": "0.1",
    "slippageRatio": "0.01"
  }
]

json

application/json

Update Copy Follower Settings (TRADE)

Update Copy Follower Settings (TRADE).

POST

/capi/v3/copy/follower/settings

https://api-contract.weex.com

Request weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.

Learn more in the Access Restrictions section.

IP weight10

Update Copy Follower Settings (TRADE) › Request Body

traderId

integer · int64 · required

Copy trader UID.

Example: 123456

settingType

string · enum · required

Setting mode: unified or per_symbol.

Enum values:

unified

per_symbol

Example: unified

object

Required when settingType is unified. symbols controls which copy-trading symbols to follow.

Example: {"symbols":["BTCUSDT","ETHUSDT"],"traceType":"amount","traceValue":"100","maxHoldQty":"1000","stopProfitRatio":"0.2","stopLossRatio":"0.1","slippageRatio":"0.001","marginType":"trader","leverageType":"specify","customLeverages":[{"symbol":"BTCUSDT","longLeverage":10,"shortLeverage":10},{"symbol":"ETHUSDT","longLeverage":10,"shortLeverage":10}]}

object[]

Required when settingType is per_symbol. You must pass one config for every copy-trading symbol.

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	requires: unifiedTraceConfig
	requires: symbolTraceConfigs

Properties for Variant 1:

settingType

enum

Enum values:

unified

Update Copy Follower Settings (TRADE) › Responses

200

Successful response

code

string

msg

string

requestTime

integer

POST/capi/v3/copy/follower/settings

curl -X POST "https://api-contract.weex.com/capi/v3/copy/follower/settings" \
   -H "ACCESS-KEY:*******" \
   -H "ACCESS-SIGN:*******" \
   -H "ACCESS-PASSPHRASE:*****" \
   -H "ACCESS-TIMESTAMP:1659076670000" \
   -H "Content-Type: application/json" \
   -d '{
     "traderId": 123456,
     "settingType": "unified",
     "unifiedTraceConfig": {
       "symbols": ["BTCUSDT", "ETHUSDT"],
       "traceType": "amount",
       "traceValue": "100",
       "maxHoldQty": "1000",
       "stopProfitRatio": "0.2",
       "stopLossRatio": "0.1",
       "slippageRatio": "0.001",
       "marginType": "trader",
       "leverageType": "specify",
       "customLeverages": [
         {
           "symbol": "BTCUSDT",
           "longLeverage": 10,
           "shortLeverage": 10
         },
         {
           "symbol": "ETHUSDT",
           "longLeverage": 10,
           "shortLeverage": 10
         }
       ]
     }
   }'

Example Request Body

{
  "traderId": 123456,
  "settingType": "unified",
  "unifiedTraceConfig": {
    "symbols": [
      "BTCUSDT",
      "ETHUSDT"
    ],
    "traceType": "amount",
    "traceValue": "100",
    "maxHoldQty": "1000",
    "stopProfitRatio": "0.2",
    "stopLossRatio": "0.1",
    "slippageRatio": "0.001",
    "marginType": "trader",
    "leverageType": "specify",
    "customLeverages": [
      {
        "symbol": "BTCUSDT",
        "longLeverage": 10,
        "shortLeverage": 10
      },
      {
        "symbol": "ETHUSDT",
        "longLeverage": 10,
        "shortLeverage": 10
      }
    ]
  }
}

json

application/json

{
  "code": "200",
  "msg": "success",
  "requestTime": 1627354109502
}

json

application/json

Close Copy Follower Position (TRADE)

Close Copy Follower Position (TRADE).

POST

/capi/v3/copy/follower/closePos

https://api-contract.weex.com

Request weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.

Learn more in the Access Restrictions section.

IP weight50

Close Copy Follower Position (TRADE) › Request Body

symbol

string · required

Symbol.

Example: BTCUSDT

copyNo

integer · int64 · required

Tracking order ID to close.

Example: 9000000001

Close Copy Follower Position (TRADE) › Responses

200

Successful response

code

string

msg

string

requestTime

integer

Stop Copying Trader (TRADE)

Stop Copying Trader (TRADE).

POST

/capi/v3/copy/follower/stopCopy

https://api-contract.weex.com

Request weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.

Learn more in the Access Restrictions section.

IP weight10

Stop Copying Trader (TRADE) › Request Body

traderId

integer · int64 · required

Copy trader UID to stop copying.

Example: 123456

Stop Copying Trader (TRADE) › Responses

200

Successful response

code

string

msg

string

requestTime

integer

Trader API