Copy Trading · Futures Copy · Trader
Classic Account — Copy Trading · Futures Copy · Trader
Create Copy ApiKey
Rate Limit: 1 req/sec/UID
This interface is used for the new version of Copy Traders to create a Copy API Key, which is of HMAC type. Old version Copy Traders will receive an error message "This interface is only applicable to the new Copy model" when calling the interface. The new version of Copy Traders have user identifiers on the following side. These traders support selecting both [Futures Trading] and [Copy Trading] when engaging in contract transactions. The Copy Trading API Key can only be created once. If a user attempts to create another one while already having a Copy API Key, an error will be returned stating "You have already created a Copy API Key." For elite traders, please strictly adhere to the list of trading pairs specified in the Available trading pairs and parameters for elite traders when placing orders using the Copy Trading API Key. Trading pairs outside the announced list are not available for copy trading.
Create Copy ApiKey › Request Parameters
passphrasePassword length must be 8 to 32 characters, consisting of English letters and numbers.
Create Copy ApiKey › Response Parameters
Successful response
codemsgrequestTimeapikeyAPI Key.
secretAPI Secret.
permissionsAPI Key permissions:
contract_tradeContract trade.
copytrading_tradeCopy trade
Get Current Tracking Orders
Rate Limit: 5 req/sec/UID
Request Parameters
productTypeProduct type
USDT-FUTURES USDT-M Futures
COIN-FUTURES Coin-M Futures
USDC-FUTURES USDC-M Futures
symbolTrading pair Supports capital and lower-case letters
startTimeStart time (greater than or equal to) Unix timestamp in milliseconds format, e.g. 1597026383085, rounded down according to granularity, i.e. for granularity=1m: 1672410799436 (December 30, 2022, 22:33:19) rounded down to 1672410780000 (December 30, 2022, 22:33:00) Request data generated after this start time (If end time is not input, then estimates out the start time based on the current time)
endTimeStart time (greater than or equal to) Unix timestamp in milliseconds format, e.g. 1597026383085, rounded down according to granularity, i.e. for granularity=1m: 1672410799436 (December 30, 2022, 22:33:19) rounded down to 1672410780000 (December 30, 2022, 22:33:00) Request data generated before this start time
limitdefault 20, max 50
idGreaterThanRequests the content on the page after this ID (newer data), the value input should be the endId of the corresponding interface.
idLessThanSeparate page content before this ID is requested (older data), the value input should be the endId of the corresponding interface.
Get Current Tracking Orders › Response Parameters
Successful response
codemsgrequestTimeTrack order list
endIdThis is used when idLessThan/idGreaterThan is set as a range.
Get History Tracking Orders
Rate Limit: 5 req/sec/UID
Request Parameters
productTypeProduct type
USDT-FUTURES USDT-M Futures
COIN-FUTURES Coin-M Futures
USDC-FUTURES USDC-M Futures
idLessThanSeparate page content before this ID is requested (older data), and the value input should be the endid of the corresponding interface.
idGreaterThanSeparate page content after this ID is requested (newer data), and the value input should be the endid of the corresponding interface.
startTimeStart timestamp (order creation time) Milliseconds format of timestamp Unix, e.g. 1597026383085 (The maximum time span supported is three months. The default end time is three months if no value is set for the end time. )
endTimeEnd timestamp (order creation time) Milliseconds format of timestamp Unix, e.g. 1597026383085 (The maximum time span supported is three months. The default start time is three months ago if no value is set for the start time. )
limitNumber of queries: Default: 20, maximum: 100.
orderSorting rules (creation time): Default: desc
symbolTrading pair Supports capital and lower-case letters
Get History Tracking Orders › Response Parameters
Successful response
codemsgrequestTimeOverview of elite trade records
endIdFinal tracking order ID. This is used when idLessThan/idGreaterThan is set as a range.
Close Tracking Order
Rate Limit: 5 req/sec/UID
Tracking orders could only be closed by this API
Close Tracking Order › Request Parameters
productTypeProduct type
USDT-FUTURES USDT-M Futures
COIN-FUTURES Coin-M Futures
USDC-FUTURES USDC-M Futures
If only productType is passed, all positions under that line of business will be closed.
trackingNoTrack order number Tracking ID from the current elite trade interface If a symbol is also passed, make sure the order ID pair corresponds to it.
symbolTrading pair Supports capital and lower-case letters
Close Tracking Order › Response Parameters
Successful response
codemsgrequestTimetrackingNoTrack order number
symbolTrading pair
productTypeProduct type
Modify Tracking Order TPSL
Rate Limit: 5 req/sec/UID
Modify Tracking Order TPSL › Request Parameters
trackingNoElite trade order ID
productTypeProduct type
USDT-FUTURES USDT-M Futures
COIN-FUTURES Coin-M Futures
USDC-FUTURES USDC-M Futures
symbolSymbol name
e.g.,BTCUSDT
stopSurplusPriceTP price One of stopSurplusPrice and stopLossPrice must be passed. When it is empty, it is ignored or not updated, no matter take-profit exists or not, When it is 0, it means the original take-profit is canceled if there is a take-profit already. When it is greater than or equal to 0, it means take-profit is updated or set.
stopLossPriceSL price One of stopSurplusPrice and stopLossPrice must be passed. When it is empty, it is ignored or not updated, no matter stop-loss exists or not, When it is 0, it means the original stop-loss is canceled if there is a stop-loss already. When it is greater than or equal to 0, it means stop-loss is updated or set.
Modify Tracking Order TPSL › Response Parameters
Successful response
codemsgrequestTimedataImplementation results
success fail
Get Tracking Order Summary
Rate Limit: 5 req/sec/UID
Get Tracking Order Summary › Response Parameters
Successful response
codemsgrequestTimeroiROI
tradingOrderNumTotal opening orders
totalFollowerNumTotal followers
currentFollowerNumCurrent number of followers
totalplTotal profit (calculated in USD)
gainNumRatio of profitable trades
lossNumRatio of losing trades
totalEquityTotal assets
winRateWin rate
tradingPairsAvailableListAvailable trading pairs
ROI in the last week
Profit in the past week
ROI in the last month
Profit in the last month
Get History Profit Share Detail
Rate Limit: 5 req/sec/UID
Request Parameters
coinSettlement currency
idLessThanSeparate page content before this ID is requested (older data), and the value input should be the endid of the corresponding interface.
idGreaterThanSeparate page content after this ID is requested (newer data), and the value input should be the endid of the corresponding interface.
startTimeStart timestamp Milliseconds format of timestamp Unix, e.g. 1597026383085 (The maximum time span supported is three months. The default end time is three months if no value is set for the end time. )
endTimeEnd timestamp Milliseconds format of timestamp Unix, e.g. 1597026383085 (The maximum time span supported is three months. The default start time is three months ago if no value is set for the start time. )
limitNumber of queries: Default: 100, maximum: 100
Get History Profit Share Detail › Response Parameters
Successful response
codemsgrequestTimeprofit share overview
endIdThe last profit share ID. This is used when idLessThan/idGreaterThan is set as a range.
Get Profit Share Detail
Rate Limit: 5 req/sec/UID
Request Parameters
coinSettlement currency of profit share
pageSizeNumber of inquiries Default: 20, maximum: 100
pageNoCurrent page number Default to 1.
Get Profit Share Detail › Response Parameters
Successful response
codemsgrequestTimecoinSettlement currency
profitProfit share
nickNameAlias
Get Profit Share Group by Coin & Date
Rate Limit: 5 req/sec/UID
Request Parameters
pageSizeNumber of inquiries Defaults to 20 entries and supports a maximum of 50 entries.
pageNoCurrent page number Default to 1.
Get Profit Share Group by Coin & Date › Response Parameters
Successful response
codemsgrequestTimecoinCryptocurrency
profitPnL (in the dimension of the cryptocurrency and the date)
profitTimeTime to distribute profit share (milliseconds) (in the dimension of the cryptocurrency and the date)
Get Copy Trade Symbol Settings
Rate limit: 5 req/sec/UID
Request Parameters
productTypeProduct type
USDT-FUTURES USDT-M Futures
COIN-FUTURES Coin-M Futures
USDC-FUTURES USDC-M Futures
Get Copy Trade Symbol Settings › Response Parameters
Successful response
codemsgrequestTimesymbolTrading pair
openTraderActivates copy trading or not, YES, NO
minOpenCountMinimum opening amount of elite traders
maxLeverageMaximum leverage
stopSurplusRatioValue set for take profit (value is a positive integer, 120 means 120%)
stopLossRatioValue set for stop-loss ratio (the value is a positive integer, 40 means 40%)
Change Global Copy Trade Setting
Rate Limit: 5 req/sec/UID
Change Global Copy Trade Setting › Request Parameters
enableOne of the three must be passed.
Activates elite trading or not?
YES
NO
showTotalEquityOne of the three must be passed.
Displays total assets (USDT) or not?
YES
NO
showTpslOne of the three must be passed.
TP/SL price of orders will be displayed publicly.
YES
NO
Change Global Copy Trade Setting › Response Parameters
Successful response
codemsgrequestTimedataSuccess or not
Get My Followers
Rate Limit: 5 req/sec/UID
Request Parameters
pageNoPage number (default: 1)
pageSizeEntries per page (default: 20, maximum: 100)
startTimeStart timestamp Milliseconds format of timestamp Unix, e.g. 1597026383085 (The maximum time span supported is three months. The default end time is three months if no value is set for the end time. )
endTimeEnd timestamp Milliseconds format of timestamp Unix, e.g. 1597026383085 (The maximum time span supported is three months. The default start time is three months ago if no value is set for the start time. )
Get My Followers › Response Parameters
Successful response
codemsgrequestTimeaccountEquityTotal account assets
isRemoveIs it able to remove followers?
yes
no
followerHeadPicFollower avatar
followerNameFollower alias
followerUidFollower user ID
followerTimeDate of following (based on date of initial following) Milliseconds format of timestamp Unix, e.g. 1597026383085
