Update Copy Follower Settings (TRADE)

POST /capi/v3/copy/follower/settings

Weight(IP): 10

Request Parameters

Parameter	Type	Required	Description
traderId	Long	Yes	Copy trader UID.
settingType	String	Yes	Setting mode: `unified` or `per_symbol`.
unifiedTraceConfig	Object	Conditional	Required when `settingType` is `unified`. `symbols` controls which copy-trading symbols to follow.
symbolTraceConfigs	Array	Conditional	Required when `settingType` is `per_symbol`. You must pass one config for every copy-trading symbol.

TraceConfig Object

Parameter	Type	Required	Description
symbol	String	Conditional	Symbol, for example `BTCUSDT`. Required only for `symbolTraceConfigs`.
symbols	Array	Conditional	Symbol list. Required only for `unifiedTraceConfig`; every symbol must be supported by copy trading.
traceType	String	Yes	Copy type: `percent` or `amount`.
traceValue	String	Yes	Copy value.
maxHoldQty	String	No	Maximum holding quantity, range `10`-`100000`. Required for `symbolTraceConfigs`.
stopProfitRatio	String	No	Take-profit ratio, range `0`-`4`. Required for `symbolTraceConfigs`.
stopLossRatio	String	No	Stop-loss ratio, range `0`-`4`. Required for `symbolTraceConfigs`.
slippageRatio	String	No	Slippage ratio. `0` means no limit; otherwise the range is `0.001`-`0.01`. Required for `symbolTraceConfigs`.
marginType	String	No	Margin type: `cross`, `isolated`, or `trader`. For `symbolTraceConfigs`, only `trader` is allowed.
leverageType	String	No	Leverage type: `fixed`, `trader`, or `specify`. For `symbolTraceConfigs`, only `fixed` and `trader` are allowed.
fixedLongLeverage	Integer	No	Fixed long leverage. Required when `symbolTraceConfigs[].leverageType` is `fixed`; defaults to `10` for unified settings when omitted.
fixedShortLeverage	Integer	No	Fixed short leverage. Required when `symbolTraceConfigs[].leverageType` is `fixed`; defaults to `10` for unified settings when omitted.
customLeverages	Array	Conditional	Custom leverage list. Required when unified `leverageType` is `specify`; its symbols must exactly match `unifiedTraceConfig.symbols`.
customLeverages[].symbol	String	Yes	Symbol.
customLeverages[].longLeverage	Integer	No	Long leverage. Default: `10`.
customLeverages[].shortLeverage	Integer	No	Short leverage. Default: `10`.

Unified Request Example

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
         }
       ]
     }
   }'

Per-Symbol Request Example

{
  "traderId": 123456,
  "settingType": "per_symbol",
  "symbolTraceConfigs": [
    {
      "symbol": "BTCUSDT",
      "traceType": "amount",
      "traceValue": "100",
      "maxHoldQty": "1000",
      "stopProfitRatio": "0.2",
      "stopLossRatio": "0.1",
      "slippageRatio": "0.001",
      "marginType": "trader",
      "leverageType": "fixed",
      "fixedLongLeverage": 10,
      "fixedShortLeverage": 10
    }
  ]
}

Response Parameters

Returns the standard success response.

Response Example

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